diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_ActivateTenantEmailRegistration.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_ActivateTenantEmailRegistration.json new file mode 100644 index 000000000000..dca23b809976 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_ActivateTenantEmailRegistration.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "api-version": "2023-02-15-preview", + "tenantEmailRegistration": { + "properties": { + "activationCode": "15ee7153fe0df5a3a449a897d6cec836" + } + } + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "repeatability-request-id": "b470712a-ffbc-4d9f-ab99-6640db8bbcb8" + }, + "body": { + "properties": { + "activationCode": "15ee7153fe0df5a3a449a897d6cec836", + "activationExpiration": "2022-08-16T22:35:17.2093506Z", + "email": "john.smith@contoso.com", + "registrationStatus": "Activated", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "state": "Succeeded" + }, + "id": "cb817140-a0cf-464f-8a82-0a9627a026ab", + "type": "tenantEmailRegistration" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_CreateOrReplace.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_CreateOrReplace.json new file mode 100644 index 000000000000..fd300bad5f69 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_CreateOrReplace.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "receivedShareId": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "receivedShare": { + "properties": { + "displayName": "updatedReceivedShareName", + "sink": { + "properties": { + "containerName": "receivingContainer", + "folder": "receivingFolder", + "mountPath": "path" + }, + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/blobAccount", + "type": "ArmResourceReference" + }, + "storeKind": "BlobAccount" + } + }, + "shareKind": "InPlace" + } + }, + "responses": { + "201": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "id": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "BlobAccount", + "createdAt": "2022-07-12T18:18:50.7095202Z", + "sharedAt": "2022-07-12T18:17:56.1065304Z", + "displayName": "updatedReceivedShareName", + "state": "Succeeded", + "shareStatus": "Attached", + "sentShareDescription": "description", + "receiverName": "Jane Doe", + "receiverEmail": "janedoe@fabrikam.com", + "receiverTenantName": "Fabrikam", + "senderName": "Ali Smith", + "senderEmail": "ali.smith@contoso.com", + "senderTenantName": "Contoso", + "sink": { + "properties": { + "containerName": "receivingContainer", + "folder": "receivingFolder", + "location": "eastus", + "mountPath": "path" + }, + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/blobAccount", + "type": "ArmResourceReference" + }, + "storeKind": "BlobAccount" + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + }, + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "id": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "BlobAccount", + "createdAt": "2022-07-12T18:18:50.7095202Z", + "sharedAt": "2022-07-12T18:17:56.1065304Z", + "displayName": "updatedReceivedShareName", + "state": "Succeeded", + "shareStatus": "Attached", + "sentShareDescription": "description", + "receiverName": "Jane Doe", + "receiverEmail": "janedoe@fabrikam.com", + "receiverTenantName": "Fabrikam", + "senderName": "Ali Smith", + "senderEmail": "ali.smith@contoso.com", + "senderTenantName": "Contoso", + "sink": { + "properties": { + "containerName": "receivingContainer", + "folder": "receivingFolder", + "location": "eastus", + "mountPath": "path" + }, + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/blobAccount", + "type": "ArmResourceReference" + }, + "storeKind": "BlobAccount" + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_CreateOrReplaceAdlsGen2Account.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_CreateOrReplaceAdlsGen2Account.json new file mode 100644 index 000000000000..cf29d38eee9e --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_CreateOrReplaceAdlsGen2Account.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "receivedShareId": "35E28F0E-DEA4-472F-84E4-5F1E45FB9937", + "receivedShare": { + "properties": { + "displayName": "updatedReceivedShareNameAdls", + "sink": { + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/adlsAccount", + "type": "ArmResourceReference" + }, + "properties": { + "containerName": "receivingContainerAbc", + "folder": "receivingFolderAbc", + "mountPath": "pathAbc" + }, + "storeKind": "AdlsGen2Account" + } + }, + "shareKind": "InPlace" + } + }, + "responses": { + "201": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "id": "35E28F0E-DEA4-472F-84E4-5F1E45FB9937", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "AdlsGen2Account", + "createdAt": "2022-07-19T18:18:50.7095202Z", + "displayName": "updatedReceivedShareNameAdls", + "state": "Succeeded", + "receiverEmail": "johndoe@fabrikam.com", + "receiverName": "John Doe", + "shareStatus": "Attached", + "receiverTenantName": "Fabrikam", + "senderEmail": "ali.smith@contoso.com", + "senderName": "Ali Smith", + "senderTenantName": "Contoso", + "sentShareDescription": "description", + "sharedAt": "2022-07-18T18:17:56.1065304Z", + "sink": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/adlsAccount", + "type": "ArmResourceReference" + }, + "properties": { + "containerName": "receivingContainerAbc", + "folder": "receivingFolderAbc", + "location": "eastus", + "mountPath": "pathAbc" + } + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + }, + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "id": "35E28F0E-DEA4-472F-84E4-5F1E45FB9937", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "AdlsGen2Account", + "createdAt": "2022-07-19T18:18:50.7095202Z", + "displayName": "updatedReceivedShareNameAdls", + "state": "Succeeded", + "receiverEmail": "johndoe@fabrikam.com", + "receiverName": "John Doe", + "shareStatus": "Attached", + "receiverTenantName": "Fabrikam", + "senderEmail": "ali.smith@contoso.com", + "senderName": "Ali Smith", + "senderTenantName": "Contoso", + "sentShareDescription": "description", + "sharedAt": "2022-07-18T18:17:56.1065304Z", + "sink": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/adlsAccount", + "type": "ArmResourceReference" + }, + "properties": { + "containerName": "receivingContainerAbc", + "folder": "receivingFolderAbc", + "location": "eastus", + "mountPath": "pathAbc" + } + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_CreateOrReplaceBlobAccount.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_CreateOrReplaceBlobAccount.json new file mode 100644 index 000000000000..97bd91a7ce1e --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_CreateOrReplaceBlobAccount.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "receivedShareId": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "receivedShare": { + "properties": { + "displayName": "updatedReceivedShareName", + "sink": { + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/blobAccount", + "type": "ArmResourceReference" + }, + "properties": { + "containerName": "receivingContainer", + "folder": "receivingFolder", + "mountPath": "path" + }, + "storeKind": "BlobAccount" + } + }, + "shareKind": "InPlace" + } + }, + "responses": { + "201": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Azure-AsyncOperation": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "id": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "BlobAccount", + "createdAt": "2022-07-12T18:18:50.7095202Z", + "sharedAt": "2022-07-12T18:17:56.1065304Z", + "displayName": "updatedReceivedShareName", + "state": "Succeeded", + "shareStatus": "Attached", + "sentShareDescription": "description", + "receiverName": "Jane Doe", + "receiverEmail": "janedoe@fabrikam.com", + "receiverTenantName": "Fabrikam", + "senderName": "Ali Smith", + "senderEmail": "ali.smith@contoso.com", + "senderTenantName": "Contoso", + "sink": { + "properties": { + "containerName": "receivingContainer", + "folder": "receivingFolder", + "location": "eastus", + "mountPath": "path" + }, + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/blobAccount", + "type": "ArmResourceReference" + }, + "storeKind": "BlobAccount" + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + }, + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Azure-AsyncOperation": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "id": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "BlobAccount", + "createdAt": "2022-07-12T18:18:50.7095202Z", + "sharedAt": "2022-07-12T18:17:56.1065304Z", + "displayName": "updatedReceivedShareName", + "state": "Succeeded", + "shareStatus": "Attached", + "sentShareDescription": "description", + "receiverName": "Jane Doe", + "receiverEmail": "janedoe@fabrikam.com", + "receiverTenantName": "Fabrikam", + "senderName": "Ali Smith", + "senderEmail": "ali.smith@contoso.com", + "senderTenantName": "Contoso", + "sink": { + "properties": { + "containerName": "receivingContainer", + "folder": "receivingFolder", + "location": "eastus", + "mountPath": "path" + }, + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/blobAccount", + "type": "ArmResourceReference" + }, + "storeKind": "BlobAccount" + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_Delete.json new file mode 100644 index 000000000000..e1dcf6fe80cc --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_Delete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "receivedShareId": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002" + }, + "responses": { + "202": { + "headers": { + "Date": "Fri, 17 Feb 2023 23:42:23 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "id": "dad6baec-3a39-41df-a469-843a9ee94213", + "startTime": "2023-02-17T23:42:25.6688Z", + "endTime": null, + "status": "NotStarted", + "error": null + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_Get.json new file mode 100644 index 000000000000..835470495fec --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "receivedShareId": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 12 July 2022 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "id": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "AdlsGen2Account", + "createdAt": "2022-07-19T18:18:50.7095202Z", + "displayName": "receivedShareName1", + "state": "Succeeded", + "receiverEmail": "johndoe@fabrikam.com", + "receiverName": "John Doe", + "shareStatus": "Attached", + "receiverTenantName": "Fabrikam", + "senderEmail": "ali.smith@contoso.com", + "senderName": "Ali Smith", + "senderTenantName": "Contoso", + "sentShareDescription": "description", + "sharedAt": "2022-07-18T18:17:56.1065304Z", + "sink": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/adlsAccount", + "type": "ArmResourceReference" + }, + "properties": { + "containerName": "receivingContainerAbc", + "folder": "receivingFolderAbc", + "location": "eastus", + "mountPath": "pathAbc" + } + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_GetAdlsGen2Account.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_GetAdlsGen2Account.json new file mode 100644 index 000000000000..835470495fec --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_GetAdlsGen2Account.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "receivedShareId": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 12 July 2022 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "id": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "AdlsGen2Account", + "createdAt": "2022-07-19T18:18:50.7095202Z", + "displayName": "receivedShareName1", + "state": "Succeeded", + "receiverEmail": "johndoe@fabrikam.com", + "receiverName": "John Doe", + "shareStatus": "Attached", + "receiverTenantName": "Fabrikam", + "senderEmail": "ali.smith@contoso.com", + "senderName": "Ali Smith", + "senderTenantName": "Contoso", + "sentShareDescription": "description", + "sharedAt": "2022-07-18T18:17:56.1065304Z", + "sink": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/adlsAccount", + "type": "ArmResourceReference" + }, + "properties": { + "containerName": "receivingContainerAbc", + "folder": "receivingFolderAbc", + "location": "eastus", + "mountPath": "pathAbc" + } + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_GetBlobAccount.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_GetBlobAccount.json new file mode 100644 index 000000000000..a98408fe5127 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_GetBlobAccount.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "receivedShareId": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 12 July 2022 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "id": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "BlobAccount", + "createdAt": "2022-07-12T18:18:50.7095202Z", + "displayName": "receivedShareName1", + "state": "Succeeded", + "receiverEmail": "janedoe@fabrikam.com", + "receiverName": "Jane Doe", + "shareStatus": "Attached", + "receiverTenantName": "Fabrikam", + "senderEmail": "ali.smith@contoso.com", + "senderName": "Ali Smith", + "senderTenantName": "Contoso", + "sentShareDescription": "description", + "sharedAt": "2022-07-12T18:17:56.1065304Z", + "sink": { + "storeKind": "BlobAccount", + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/blobAccount", + "type": "ArmResourceReference" + }, + "properties": { + "containerName": "receivingContainer", + "folder": "receivingFolder", + "location": "eastus", + "mountPath": "path" + } + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_ListAttached.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_ListAttached.json new file mode 100644 index 000000000000..98f94b83bad8 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_ListAttached.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/blobAccount", + "filter": "Name eq 'testName'" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 12 July 2022 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "id": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "BlobAccount", + "createdAt": "2022-07-12T18:18:50.7095202Z", + "displayName": "receivedShareName1", + "state": "Succeeded", + "shareStatus": "Attached", + "receiverEmail": "janedoe@fabrikam.com", + "receiverName": "Jane Doe", + "receiverTenantName": "Fabrikam", + "senderEmail": "ali.smith@contoso.com", + "senderName": "Ali Smith", + "senderTenantName": "Contoso", + "sentShareDescription": "description", + "sharedAt": "2022-07-12T18:17:56.1065304Z", + "sink": { + "storeKind": "BlobAccount", + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/blobAccount", + "type": "ArmResourceReference" + }, + "properties": { + "containerName": "receivingContainer", + "folder": "receivingFolder", + "location": "eastus", + "mountPath": "path" + } + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + }, + { + "id": "35E28F0E-DEA4-472F-84E4-5F1E45FB9937", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "AdlsGen2Account", + "createdAt": "2022-07-19T18:18:50.7095202Z", + "displayName": "receivedShareName1", + "state": "Succeeded", + "shareStatus": "Attached", + "receiverEmail": "johndoe@fabrikam.com", + "receiverName": "John Doe", + "receiverTenantName": "Fabrikam", + "senderEmail": "ali.smith@contoso.com", + "senderName": "Ali Smith", + "senderTenantName": "Contoso", + "sentShareDescription": "description", + "sharedAt": "2022-07-18T18:17:56.1065304Z", + "sink": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/4D8FD81D-431D-4B1D-B46C-C770CFC034FC/resourceGroups/contoso-rg/providers/Microsoft.Storage/storageAccounts/adlsAccount", + "type": "ArmResourceReference" + }, + "properties": { + "containerName": "receivingContainerAbc", + "folder": "receivingFolderAbc", + "location": "eastus", + "mountPath": "pathAbc" + } + } + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + ], + "nextLink": "https://accountName.purview.azure.com/share/receivedShares/attached?api-version=2023-02-15-preview&skipToken=skip_token_to_fetch_more_attached_received_shares" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_ListDetached.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_ListDetached.json new file mode 100644 index 000000000000..5ac503ed80ba --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_ListDetached.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "filter": "Name eq 'testName'" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 12 July 2022 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "id": "0D67B9C8-A6C6-4990-9EDE-12EA059D3002", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "BlobAccount", + "createdAt": "2022-07-12T18:18:50.7095202Z", + "displayName": "receivedShareName1", + "state": "Succeeded", + "shareStatus": "Detached", + "receiverEmail": "janedoe@fabrikam.com", + "receiverName": null, + "receiverTenantName": null, + "senderEmail": "ali.smith@contoso.com", + "senderName": "Ali Smith", + "senderTenantName": "Contoso", + "sentShareDescription": "description", + "sharedAt": "2022-07-12T18:17:56.1065304Z" + }, + "shareKind": "InPlace", + "type": "receivedShares" + }, + { + "id": "35E28F0E-DEA4-472F-84E4-5F1E45FB9937", + "properties": { + "assetLocation": "eastus", + "assetStoreKind": "AdlsGen2Account", + "createdAt": "2022-07-19T18:18:50.7095202Z", + "displayName": "receivedShareName1", + "state": "Succeeded", + "shareStatus": "Detached", + "receiverEmail": "johndoe@fabrikam.com", + "receiverName": null, + "receiverTenantName": null, + "senderEmail": "ali.smith@contoso.com", + "senderName": "Ali Smith", + "senderTenantName": "Contoso", + "sentShareDescription": "description", + "sharedAt": "2022-07-18T18:17:56.1065304Z" + }, + "shareKind": "InPlace", + "type": "receivedShares" + } + ], + "nextLink": "https://accountName.purview.azure.com/share/receivedShares/detached?api-version=2023-02-15-preview&skipToken=skip_token_to_fetch_more_detached_received_shares" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_RegisterTenantEmailRegistration.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_RegisterTenantEmailRegistration.json new file mode 100644 index 000000000000..025a160e61f4 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/ReceivedShares_RegisterTenantEmailRegistration.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "api-version": "2023-02-15-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "repeatability-request-id": "b470712a-ffbc-4d9f-ab99-6640db8bbcb8" + }, + "body": { + "properties": { + "activationCode": "15ee7153fe0df5a3a449a897d6cec836", + "activationExpiration": "2022-08-16T22:35:17.2093506Z", + "email": "john.smith@contoso.com", + "registrationStatus": "ActivationPending", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "state": "Succeeded" + }, + "id": "cb817140-a0cf-464f-8a82-0a9627a026ab", + "type": "tenantEmailRegistration" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateInvitation.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateInvitation.json new file mode 100644 index 000000000000..9dccf3224d24 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateInvitation.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShareInvitationId": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "sentShareInvitation": { + "properties": { + "targetEmail": "testReceiver@microsoft.com", + "notify": true, + "expirationDate": null + }, + "invitationKind": "User" + } + }, + "responses": { + "201": { + "headers": { + "Date": "Thu, 4 Aug 2022 13:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "properties": { + "targetEmail": "testReceiver@microsoft.com", + "notify": true, + "expirationDate": null, + "sentAt": "2022-08-04T13:04:32.8172128Z", + "shareStatus": "Detached", + "senderName": "Test Sender", + "senderTenantName": "Test Tenant", + "senderEmail": "testSender@microsoft.com", + "state": "Succeeded" + }, + "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "type": "sentShares/sentShareInvitations", + "invitationKind": "User" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateOrReplace.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateOrReplace.json new file mode 100644 index 000000000000..7b5a7e9122b1 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateOrReplace.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShare": { + "properties": { + "artifact": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "SharedFile.txt" + } + ] + } + }, + "displayName": "sentShare1", + "description": "description" + }, + "shareKind": "InPlace" + } + }, + "responses": { + "201": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "properties": { + "artifact": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "ShareFile.txt" + } + ] + } + }, + "createdAt": "2021-07-21T23:45:35.3708674Z", + "displayName": "sentShare1", + "description": "description", + "dependsOn": [], + "state": "Succeeded", + "senderName": "John Smith", + "senderEmail": "johnsmith@contoso.com", + "senderTenantName": "Contoso" + }, + "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "SentShare", + "shareKind": "InPlace" + } + }, + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "properties": { + "artifact": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "ShareFile.txt" + } + ] + } + }, + "createdAt": "2021-07-21T23:45:35.3708674Z", + "displayName": "sentShare1", + "description": "description", + "dependsOn": [], + "state": "Succeeded", + "senderName": "John Smith", + "senderEmail": "johnsmith@contoso.com", + "senderTenantName": "Contoso" + }, + "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "SentShare", + "shareKind": "InPlace" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateOrReplaceAdlsGen2Account.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateOrReplaceAdlsGen2Account.json new file mode 100644 index 000000000000..7b5a7e9122b1 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateOrReplaceAdlsGen2Account.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShare": { + "properties": { + "artifact": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "SharedFile.txt" + } + ] + } + }, + "displayName": "sentShare1", + "description": "description" + }, + "shareKind": "InPlace" + } + }, + "responses": { + "201": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "properties": { + "artifact": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "ShareFile.txt" + } + ] + } + }, + "createdAt": "2021-07-21T23:45:35.3708674Z", + "displayName": "sentShare1", + "description": "description", + "dependsOn": [], + "state": "Succeeded", + "senderName": "John Smith", + "senderEmail": "johnsmith@contoso.com", + "senderTenantName": "Contoso" + }, + "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "SentShare", + "shareKind": "InPlace" + } + }, + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "properties": { + "artifact": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "ShareFile.txt" + } + ] + } + }, + "createdAt": "2021-07-21T23:45:35.3708674Z", + "displayName": "sentShare1", + "description": "description", + "dependsOn": [], + "state": "Succeeded", + "senderName": "John Smith", + "senderEmail": "johnsmith@contoso.com", + "senderTenantName": "Contoso" + }, + "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "SentShare", + "shareKind": "InPlace" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateOrReplaceBlobAccount.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateOrReplaceBlobAccount.json new file mode 100644 index 000000000000..20b6b59cfde0 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateOrReplaceBlobAccount.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShare": { + "properties": { + "artifact": { + "storeKind": "BlobAccount", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "SharedFile.txt" + } + ] + } + }, + "displayName": "sentShare1", + "description": "description" + }, + "shareKind": "InPlace" + } + }, + "responses": { + "201": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "properties": { + "artifact": { + "storeKind": "BlobAccount", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "ShareFile.txt" + } + ] + } + }, + "createdAt": "2021-07-21T23:45:35.3708674Z", + "displayName": "sentShare1", + "description": "description", + "dependsOn": [], + "state": "Succeeded", + "senderName": "John Smith", + "senderEmail": "johnsmith@contoso.com", + "senderTenantName": "Contoso" + }, + "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "SentShare", + "shareKind": "InPlace" + } + }, + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "properties": { + "artifact": { + "storeKind": "BlobAccount", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "ShareFile.txt" + } + ] + } + }, + "createdAt": "2021-07-21T23:45:35.3708674Z", + "displayName": "sentShare1", + "description": "description", + "dependsOn": [], + "state": "Succeeded", + "senderName": "John Smith", + "senderEmail": "johnsmith@contoso.com", + "senderTenantName": "Contoso" + }, + "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "SentShare", + "shareKind": "InPlace" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateServiceInvitation.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateServiceInvitation.json new file mode 100644 index 000000000000..54f174d25c7f --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateServiceInvitation.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShareInvitationId": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "sentShareInvitation": { + "properties": { + "targetActiveDirectoryId": "5DAE1226-9FAA-4D71-B8D4-87B81DFF672E", + "targetObjectId": "EFA02830-BB7A-4586-B615-A6DFF19FEBBF", + "expirationDate": null + }, + "invitationKind": "Service" + } + }, + "responses": { + "201": { + "headers": { + "Date": "Thu, 4 Aug 2022 13:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "properties": { + "targetActiveDirectoryId": "5DAE1226-9FAA-4D71-B8D4-87B81DFF672E", + "targetObjectId": "EFA02830-BB7A-4586-B615-A6DFF19FEBBF", + "expirationDate": null, + "shareStatus": "Detached", + "senderName": "Test Sender", + "sentAt": "2022-08-04T13:04:32.8172128Z", + "senderTenantName": "Test Tenant", + "senderEmail": "testSender@microsoft.com", + "state": "Succeeded" + }, + "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "type": "sentShares/sentShareInvitations", + "invitationKind": "Service" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateUserInvitation.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateUserInvitation.json new file mode 100644 index 000000000000..aa969920b0bb --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_CreateUserInvitation.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-02-15-preview", + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShareInvitationId": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "sentShareInvitation": { + "properties": { + "targetEmail": "testReceiver@microsoft.com", + "notify": true, + "expirationDate": "2025-07-21T23:52:00.7691109Z" + }, + "invitationKind": "User" + } + }, + "responses": { + "201": { + "headers": { + "Date": "Thu, 4 Aug 2022 13:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "properties": { + "targetEmail": "testReceiver@microsoft.com", + "notify": true, + "expirationDate": "2025-07-21T23:52:00.7691109Z", + "sentAt": "2022-08-04T13:04:32.8172128Z", + "shareStatus": "Detached", + "senderName": "Test Sender", + "senderTenantName": "Test Tenant", + "senderEmail": "testSender@microsoft.com", + "state": "Succeeded" + }, + "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "type": "sentShares/sentShareInvitations", + "invitationKind": "User" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_Delete.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_Delete.json new file mode 100644 index 000000000000..4b1dd1aca20a --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_Delete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "api-version": "2023-02-15-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Fri, 17 Feb 2023 23:42:23 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "x-ms-long-running-operation": true, + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "id": "dad6baec-3a39-41df-a469-843a9ee94213", + "startTime": "2023-02-17T23:42:25.6688Z", + "endTime": null, + "status": "NotStarted", + "error": null + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_DeleteInvitation.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_DeleteInvitation.json new file mode 100644 index 000000000000..0bc29c00e284 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_DeleteInvitation.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShareInvitationId": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "api-version": "2023-02-15-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Fri, 17 Feb 2023 23:42:23 GMT", + "x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", + "Operation-Location": "https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview", + "Operation-Id": "dad6baec-3a39-41df-a469-843a9ee94213" + }, + "body": { + "id": "dad6baec-3a39-41df-a469-843a9ee94213", + "startTime": "2023-02-17T23:42:25.6688Z", + "endTime": null, + "status": "NotStarted", + "error": null + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_Get.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_Get.json new file mode 100644 index 000000000000..e6f18402e15f --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "api-version": "2023-02-15-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "properties": { + "artifact": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "ShareFile.txt" + } + ] + } + }, + "createdAt": "2021-07-21T23:45:35.3708674Z", + "displayName": "sentShare1", + "description": "description", + "dependsOn": [], + "state": "Succeeded", + "senderName": "John Smith", + "senderEmail": "johnsmith@contoso.com", + "senderTenantName": "Contoso" + }, + "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "SentShare", + "shareKind": "InPlace" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetAdlsGen2Account.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetAdlsGen2Account.json new file mode 100644 index 000000000000..e6f18402e15f --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetAdlsGen2Account.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "api-version": "2023-02-15-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "properties": { + "artifact": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "ShareFile.txt" + } + ] + } + }, + "createdAt": "2021-07-21T23:45:35.3708674Z", + "displayName": "sentShare1", + "description": "description", + "dependsOn": [], + "state": "Succeeded", + "senderName": "John Smith", + "senderEmail": "johnsmith@contoso.com", + "senderTenantName": "Contoso" + }, + "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "SentShare", + "shareKind": "InPlace" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetBlobAccount.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetBlobAccount.json new file mode 100644 index 000000000000..da09ac458f1c --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetBlobAccount.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "api-version": "2023-02-15-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "properties": { + "artifact": { + "storeKind": "BlobAccount", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "ShareFile.txt" + } + ] + } + }, + "createdAt": "2021-07-21T23:45:35.3708674Z", + "displayName": "sentShare1", + "description": "description", + "dependsOn": [], + "state": "Succeeded", + "senderName": "John Smith", + "senderEmail": "johnsmith@contoso.com", + "senderTenantName": "Contoso" + }, + "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "SentShare", + "shareKind": "InPlace" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetInvitation.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetInvitation.json new file mode 100644 index 000000000000..db69105dbaec --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetInvitation.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShareInvitationId": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "api-version": "2023-02-15-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Fri, 12 Aug 2022 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "properties": { + "targetEmail": "testReceiver@microsoft.com", + "notify": true, + "expirationDate": null, + "sentAt": "2022-08-04T13:04:32.8172128Z", + "shareStatus": "Detached", + "senderName": "Test Sender", + "senderTenantName": "Test Tenant", + "senderEmail": "testSender@microsoft.com", + "state": "Succeeded" + }, + "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "type": "sentShares/sentShareInvitations", + "invitationKind": "User" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetServiceInvitation.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetServiceInvitation.json new file mode 100644 index 000000000000..59f3330708a4 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetServiceInvitation.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShareInvitationId": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "api-version": "2023-02-15-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Fri, 12 Aug 2022 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "properties": { + "targetActiveDirectoryId": "5DAE1226-9FAA-4D71-B8D4-87B81DFF672E", + "targetObjectId": "EFA02830-BB7A-4586-B615-A6DFF19FEBBF", + "expirationDate": "2022-08-11T13:04:32.8172128Z", + "shareStatus": "Detached", + "senderName": "Test Sender", + "sentAt": "2022-08-04T13:04:32.8172128Z", + "senderTenantName": "Test Tenant", + "senderEmail": "testSender@microsoft.com", + "state": "Succeeded" + }, + "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "type": "sentShares/sentShareInvitations", + "invitationKind": "Service" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetUserInvitation.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetUserInvitation.json new file mode 100644 index 000000000000..db69105dbaec --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_GetUserInvitation.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShareInvitationId": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "api-version": "2023-02-15-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Fri, 12 Aug 2022 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "properties": { + "targetEmail": "testReceiver@microsoft.com", + "notify": true, + "expirationDate": null, + "sentAt": "2022-08-04T13:04:32.8172128Z", + "shareStatus": "Detached", + "senderName": "Test Sender", + "senderTenantName": "Test Tenant", + "senderEmail": "testSender@microsoft.com", + "state": "Succeeded" + }, + "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "type": "sentShares/sentShareInvitations", + "invitationKind": "User" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_List.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_List.json new file mode 100644 index 000000000000..e2fce83b2295 --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_List.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "api-version": "2023-02-15-preview", + "filter": "Name eq 'testName'" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "properties": { + "artifact": { + "storeKind": "AdlsGen2Account", + "storeReference": { + "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage", + "type": "ArmResourceReference" + }, + "properties": { + "paths": [ + { + "containerName": "container1", + "senderPath": "directory/file.txt", + "receiverPath": "ShareFile.txt" + } + ] + } + }, + "createdAt": "2021-07-21T23:45:35.3708674Z", + "displayName": "sentShare1", + "description": "description", + "dependsOn": [], + "state": "Succeeded", + "senderName": "John Smith", + "senderEmail": "johnsmith@contoso.com", + "senderTenantName": "Contoso" + }, + "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "SentShare", + "shareKind": "InPlace" + } + ], + "nextLink": "https://accountName.purview.azure.com/share/sentShares?api-version=2023-02-15-preview&skipToken=skip_token_to_fetch_more_sent_shares" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_ListInvitations.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_ListInvitations.json new file mode 100644 index 000000000000..feef06826d8a --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_ListInvitations.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "api-version": "2023-02-15-preview", + "filter": "Name eq 'testName'" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:55 GMT", + "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed" + }, + "body": { + "value": [ + { + "properties": { + "targetEmail": "testReceiver@microsoft.com", + "notify": true, + "expirationDate": null, + "sentAt": "2022-08-04T13:04:32.8172128Z", + "shareStatus": "Detached", + "senderName": "Test Sender", + "senderTenantName": "Test Tenant", + "senderEmail": "testSender@microsoft.com", + "state": "Succeeded" + }, + "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "type": "sentShares/sentShareInvitations", + "invitationKind": "User" + }, + { + "properties": { + "targetActiveDirectoryId": "5DAE1226-9FAA-4D71-B8D4-87B81DFF672E", + "targetObjectId": "EFA02830-BB7A-4586-B615-A6DFF19FEBBF", + "expirationDate": "2022-08-11T13:04:32.8172128Z", + "shareStatus": "Detached", + "senderName": "Test Sender", + "sentAt": "2022-08-04T13:04:32.8172128Z", + "senderTenantName": "Test Tenant", + "senderEmail": "testSender@microsoft.com", + "state": "Succeeded" + }, + "id": "DF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "type": "sentShares/sentShareInvitations", + "invitationKind": "Service" + } + ], + "nextLink": "https://accountName.purview.azure.com/share/sentShares/FF4A2AAE-8755-47BB-9C00-A774B5A7006E/sentShareInvitations?api-version=2023-02-15-preview&skipToken=skip_token_to_fetch_more_sent_share_invitations" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_NotifyUserInvitation.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_NotifyUserInvitation.json new file mode 100644 index 000000000000..db69105dbaec --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/examples/SentShares_NotifyUserInvitation.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "accountName.purview.azure.com/share", + "sentShareId": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E", + "sentShareInvitationId": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "api-version": "2023-02-15-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Fri, 12 Aug 2022 18:04:32 GMT", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "properties": { + "targetEmail": "testReceiver@microsoft.com", + "notify": true, + "expirationDate": null, + "sentAt": "2022-08-04T13:04:32.8172128Z", + "shareStatus": "Detached", + "senderName": "Test Sender", + "senderTenantName": "Test Tenant", + "senderEmail": "testSender@microsoft.com", + "state": "Succeeded" + }, + "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21", + "type": "sentShares/sentShareInvitations", + "invitationKind": "User" + } + } + } +} diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json new file mode 100644 index 000000000000..9205529911db --- /dev/null +++ b/specification/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json @@ -0,0 +1,2101 @@ +{ + "swagger": "2.0", + "info": { + "title": "Purview Share Client", + "description": "Creates a data plane client for Purview Share.", + "version": "2023-02-15-preview" + }, + "paths": { + "/receivedShares/{receivedShareId}": { + "get": { + "tags": [ + "ReceivedShare" + ], + "summary": "Get a received share by unique id.", + "description": "Get a received share", + "operationId": "ReceivedShares_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/receivedShareId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ReceivedShare" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "ReceivedShares_Get": { + "$ref": "./examples/ReceivedShares_Get.json" + }, + "ReceivedShares_GetAdlsGen2Account": { + "$ref": "./examples/ReceivedShares_GetAdlsGen2Account.json" + }, + "ReceivedShares_GetBlobAccount": { + "$ref": "./examples/ReceivedShares_GetBlobAccount.json" + } + } + }, + "put": { + "tags": [ + "ReceivedShare" + ], + "summary": "Create or replace a received share.", + "description": "Update changes to a received share", + "operationId": "ReceivedShares_CreateOrReplace", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/receivedShareId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "receivedShare", + "description": "The received share to create or replace", + "required": true, + "schema": { + "$ref": "#/definitions/ReceivedShare" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ReceivedShare" + }, + "headers": { + "Operation-Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ReceivedShare" + }, + "headers": { + "Operation-Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "ReceivedShares_CreateOrReplace": { + "$ref": "./examples/ReceivedShares_CreateOrReplace.json" + }, + "ReceivedShares_CreateOrReplaceAdlsGen2Account": { + "$ref": "./examples/ReceivedShares_CreateOrReplaceAdlsGen2Account.json" + }, + "ReceivedShares_CreateOrReplaceBlobAccount": { + "$ref": "./examples/ReceivedShares_CreateOrReplaceBlobAccount.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ReceivedShare" + ], + "summary": "Deletes a received share", + "description": "Delete a received share", + "operationId": "ReceivedShares_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/receivedShareId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/OperationResponse" + }, + "headers": { + "Operation-Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "ReceivedShares_Delete": { + "$ref": "./examples/ReceivedShares_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/receivedShares/attached": { + "get": { + "tags": [ + "ReceivedShare" + ], + "summary": "Get a list of attached received shares.", + "description": "List attached received shares", + "operationId": "ReceivedShares_ListAttached", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/referenceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/skipToken" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/orderby" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ReceivedShareList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "ReceivedShares_ListAttached": { + "$ref": "./examples/ReceivedShares_ListAttached.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/receivedShares/detached": { + "get": { + "tags": [ + "ReceivedShare" + ], + "summary": "Get a list of detached received shares.", + "description": "List detached received shares", + "operationId": "ReceivedShares_ListDetached", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/skipToken" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/orderby" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ReceivedShareList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "ReceivedShares_ListDetached": { + "$ref": "./examples/ReceivedShares_ListDetached.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sentShares": { + "get": { + "tags": [ + "SentShare" + ], + "summary": "Get a list of sent shares.", + "description": "List sent shares", + "operationId": "SentShares_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/referenceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/skipToken" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/orderby" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SentShareList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "SentShares_List": { + "$ref": "./examples/SentShares_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sentShares/{sentShareId}": { + "get": { + "tags": [ + "SentShare" + ], + "summary": "Get a sent share by guid.", + "description": "Get a sent share", + "operationId": "SentShares_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/sentShareId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SentShare" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "SentShares_Get": { + "$ref": "./examples/SentShares_Get.json" + }, + "SentShares_GetAdlsGen2Account": { + "$ref": "./examples/SentShares_GetAdlsGen2Account.json" + }, + "SentShares_GetBlobAccount": { + "$ref": "./examples/SentShares_GetBlobAccount.json" + } + } + }, + "put": { + "tags": [ + "SentShare" + ], + "summary": "Create or replace a sent share.", + "description": "Create or replace a sent share", + "operationId": "SentShares_CreateOrReplace", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/sentShareId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "sentShare", + "description": "The sent share to create or replace.", + "required": true, + "schema": { + "$ref": "#/definitions/SentShare" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SentShare" + }, + "headers": { + "Operation-Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SentShare" + }, + "headers": { + "Operation-Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "SentShares_CreateOrReplace": { + "$ref": "./examples/SentShares_CreateOrReplace.json" + }, + "SentShares_CreateOrReplaceAdlsGen2Account": { + "$ref": "./examples/SentShares_CreateOrReplaceAdlsGen2Account.json" + }, + "SentShares_CreateOrReplaceBlobAccount": { + "$ref": "./examples/SentShares_CreateOrReplaceBlobAccount.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "SentShare" + ], + "summary": "Deletes a sent share.", + "description": "Delete a sent share", + "operationId": "SentShares_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/sentShareId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/OperationResponse" + }, + "headers": { + "Operation-Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "SentShares_Delete": { + "$ref": "./examples/SentShares_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/sentShares/{sentShareId}/sentShareInvitations": { + "get": { + "tags": [ + "SentShareInvitation" + ], + "summary": "List all sent share invitations in a sent share", + "description": "List sent share recipients", + "operationId": "SentShares_ListInvitations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/sentShareId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/skipToken" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/orderby" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SentShareInvitationList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "SentShares_ListInvitations": { + "$ref": "./examples/SentShares_ListInvitations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/sentShares/{sentShareId}/sentShareInvitations/{sentShareInvitationId}": { + "get": { + "tags": [ + "SentShareInvitation" + ], + "summary": "Get sent share invitation for a given sent share", + "description": "Get recipient for a given sent share", + "operationId": "SentShares_GetInvitation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/sentShareId" + }, + { + "$ref": "#/parameters/sentShareInvitationId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SentShareInvitation" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "SentShares_GetInvitation": { + "$ref": "./examples/SentShares_GetInvitation.json" + }, + "SentShares_GetUserInvitation": { + "$ref": "./examples/SentShares_GetUserInvitation.json" + }, + "SentShares_GetServiceInvitation": { + "$ref": "./examples/SentShares_GetServiceInvitation.json" + } + } + }, + "put": { + "tags": [ + "SentShareInvitation" + ], + "summary": "Create a sent share invitation.", + "description": "Create a recipient for a given sent share", + "operationId": "SentShares_CreateInvitation", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/sentShareId" + }, + { + "$ref": "#/parameters/sentShareInvitationId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "body", + "name": "sentShareInvitation", + "description": "The sent share invitation to create.", + "required": true, + "schema": { + "$ref": "#/definitions/SentShareInvitation" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SentShareInvitation" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "SentShares_CreateInvitation": { + "$ref": "./examples/SentShares_CreateInvitation.json" + }, + "SentShares_CreateServiceInvitation": { + "$ref": "./examples/SentShares_CreateServiceInvitation.json" + }, + "SentShares_CreateUserInvitation": { + "$ref": "./examples/SentShares_CreateUserInvitation.json" + } + } + }, + "delete": { + "tags": [ + "SentShareInvitation" + ], + "summary": "Delete Invitation in a share.", + "description": "Delete a sent share invitation", + "operationId": "SentShares_DeleteInvitation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/sentShareId" + }, + { + "$ref": "#/parameters/sentShareInvitationId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/OperationResponse" + }, + "headers": { + "Operation-Location": { + "description": "The URL to track the status of the long running operation.", + "type": "string" + } + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "SentShares_DeleteInvitation": { + "$ref": "./examples/SentShares_DeleteInvitation.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/sentShares/{sentShareId}/sentShareInvitations/{sentShareInvitationId}:notify": { + "post": { + "tags": [ + "SentShareInvitation" + ], + "summary": "Notifies the recipient of the sent share invitation.", + "description": "Notifies the user recipient of the sent share invitation, does not apply to service invitations.", + "operationId": "SentShares_NotifyUserInvitation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/sentShareId" + }, + { + "$ref": "#/parameters/sentShareInvitationId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "in": "header", + "name": "repeatability-request-id", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SentShareInvitation" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "SentShares_NotifyUserInvitation": { + "$ref": "./examples/SentShares_NotifyUserInvitation.json" + } + } + } + }, + "/emails:activate": { + "post": { + "tags": [ + "TenantEmailRegistration" + ], + "summary": "Activates the tenant and email combination using the activation code received.", + "description": "Activates the email registration for current tenant", + "operationId": "ReceivedShares_ActivateTenantEmailRegistration", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "in": "header", + "name": "repeatability-request-id", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.", + "type": "string" + }, + { + "in": "body", + "name": "tenantEmailRegistration", + "description": "The tenant email registration payload", + "required": true, + "schema": { + "$ref": "#/definitions/TenantEmailRegistration" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantEmailRegistration" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "ReceivedShares_ActivateTenantEmailRegistration": { + "$ref": "./examples/ReceivedShares_ActivateTenantEmailRegistration.json" + } + } + } + }, + "/emails:register": { + "post": { + "tags": [ + "TenantEmailRegistration" + ], + "summary": "Registers the tenant and email combination for activation.", + "description": "Register an email for the current tenant", + "operationId": "ReceivedShares_RegisterTenantEmailRegistration", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "in": "header", + "name": "repeatability-request-id", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TenantEmailRegistration" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/PurviewShareError" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "ReceivedShares_RegisterTenantEmailRegistration": { + "$ref": "./examples/ReceivedShares_RegisterTenantEmailRegistration.json" + } + } + } + } + }, + "definitions": { + "AdlsGen2AccountSink": { + "description": "AdlsGen2 Sink", + "required": [ + "properties", + "storeKind", + "storeReference" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Sink" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AdlsGen2AccountSinkProperties" + } + }, + "x-ms-discriminator-value": "AdlsGen2Account" + }, + "AdlsGen2AccountSinkProperties": { + "description": "Properties for AdlsGen2 storage account", + "required": [ + "containerName", + "folder" + ], + "type": "object", + "properties": { + "containerName": { + "description": "Adls Gen 2 Container Name", + "type": "string" + }, + "folder": { + "description": "Adls Gen 2 Folder", + "type": "string" + }, + "location": { + "description": "Adls Gen 2 Location", + "type": "string", + "readOnly": true + }, + "mountPath": { + "description": "Adls Gen 2 Mount Path", + "type": "string" + } + } + }, + "AdlsGen2Artifact": { + "description": "An Adls Gen2 storage account artifact.", + "required": [ + "properties", + "storeKind", + "storeReference" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Artifact" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AdlsGen2ArtifactProperties" + } + }, + "x-ms-discriminator-value": "AdlsGen2Account" + }, + "AdlsGen2ArtifactProperties": { + "description": "Properties for Adls Gen2 storage account.", + "required": [ + "paths" + ], + "type": "object", + "properties": { + "location": { + "description": "Location of the storage account.", + "type": "string", + "readOnly": true + }, + "paths": { + "description": "A list of Adls Gen2 storage account paths.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountPath" + } + } + } + }, + "Artifact": { + "description": "A class for sent share artifact.", + "required": [ + "storeKind", + "storeReference" + ], + "type": "object", + "properties": { + "storeKind": { + "$ref": "#/definitions/StoreKind" + }, + "storeReference": { + "$ref": "#/definitions/StoreReference" + } + }, + "discriminator": "storeKind" + }, + "BlobAccountSink": { + "description": "Blob Sink", + "required": [ + "properties", + "storeKind", + "storeReference" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Sink" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BlobAccountSinkProperties" + } + }, + "x-ms-discriminator-value": "BlobAccount" + }, + "BlobAccountSinkProperties": { + "description": "Properties for blob storage account", + "required": [ + "containerName", + "folder" + ], + "type": "object", + "properties": { + "containerName": { + "description": "Blob Container Name", + "type": "string" + }, + "folder": { + "description": "Blob Folder", + "type": "string" + }, + "location": { + "description": "Blob Location", + "type": "string", + "readOnly": true + }, + "mountPath": { + "description": "Blob Mount Path", + "type": "string" + } + } + }, + "BlobStorageArtifact": { + "description": "Blob storage account artifact.", + "required": [ + "properties", + "storeKind", + "storeReference" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Artifact" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BlobStorageArtifactProperties" + } + }, + "x-ms-discriminator-value": "BlobAccount" + }, + "BlobStorageArtifactProperties": { + "description": "Properties for blob storage account.", + "required": [ + "paths" + ], + "type": "object", + "properties": { + "location": { + "description": "Location of the storage account.", + "type": "string", + "readOnly": true + }, + "paths": { + "description": "A list of blob storage account paths.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountPath" + } + } + } + }, + "InPlaceReceivedShare": { + "description": "An InPlace received share kind.", + "required": [ + "properties", + "shareKind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReceivedShare" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/InPlaceReceivedShareProperties" + } + }, + "x-ms-discriminator-value": "InPlace" + }, + "InPlaceReceivedShareProperties": { + "description": "Properties of in place received share.", + "type": "object", + "properties": { + "assetLocation": { + "description": "Location of the shared Asset.", + "type": "string", + "readOnly": true + }, + "assetStoreKind": { + "$ref": "#/definitions/StoreKind" + }, + "createdAt": { + "format": "date-time", + "description": "Time at which the received share was created. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "Received Share Name", + "type": "string" + }, + "expirationDate": { + "format": "date-time", + "description": "The expiration date of the received share. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string", + "readOnly": true + }, + "receiverEmail": { + "description": "Email of the user/receiver who received the sent share invitation", + "type": "string", + "readOnly": true + }, + "receiverName": { + "description": "Name of the user/receiver who received the sent share invitation", + "type": "string", + "readOnly": true + }, + "receiverTenantName": { + "description": "Tenant name of the user/receiver who received the sent share invitation", + "type": "string", + "readOnly": true + }, + "senderEmail": { + "description": "Email of the sender who created the sent share invitation", + "type": "string", + "readOnly": true + }, + "senderName": { + "description": "Name of the sender who created the sent share invitation", + "type": "string", + "readOnly": true + }, + "senderTenantName": { + "description": "Tenant name of the sender who created the sent share invitation", + "type": "string", + "readOnly": true + }, + "sentShareDescription": { + "description": "Share description.", + "type": "string", + "readOnly": true + }, + "sharedAt": { + "format": "date-time", + "description": "Time at which the sent share was shared. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string", + "readOnly": true + }, + "shareStatus": { + "$ref": "#/definitions/ShareStatus" + }, + "sink": { + "$ref": "#/definitions/Sink" + }, + "state": { + "$ref": "#/definitions/State", + "readOnly": true + } + } + }, + "InPlaceSentShare": { + "description": "An InPlace share kind.", + "required": [ + "properties", + "shareKind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SentShare" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/InPlaceSentShareProperties" + } + }, + "x-ms-discriminator-value": "InPlace" + }, + "InPlaceSentShareProperties": { + "description": "Properties for InPlace sent share.", + "required": [ + "artifact", + "displayName" + ], + "type": "object", + "properties": { + "artifact": { + "$ref": "#/definitions/Artifact" + }, + "createdAt": { + "format": "date-time", + "description": "Time at which the sent share was created. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string", + "readOnly": true + }, + "dependsOn": { + "description": "List of shares on which the sent share depends.", + "type": "array", + "items": { + "format": "uuid", + "type": "string" + }, + "readOnly": true + }, + "description": { + "description": "Sent share description.", + "type": "string" + }, + "displayName": { + "description": "The name of the sent share", + "type": "string" + }, + "senderEmail": { + "description": "Email of the sender who created the sent share.", + "type": "string", + "readOnly": true + }, + "senderName": { + "description": "Name of the sender who created the sent share.", + "type": "string", + "readOnly": true + }, + "senderTenantName": { + "description": "Tenant name of the sender who created the sent share.", + "type": "string", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/State", + "readOnly": true + } + } + }, + "InvitationKind": { + "description": "The types of invitations.", + "enum": [ + "User", + "Service" + ], + "type": "string", + "x-ms-enum": { + "name": "InvitationKind", + "modelAsString": true, + "values": [ + { + "value": "User", + "description": "The invitation is sent to a user", + "name": "User invitation" + }, + { + "value": "Service", + "description": "The invitation is sent to a service", + "name": "Service invitation" + } + ] + } + }, + "OperationResponse": { + "description": "Response for long running operation.", + "required": [ + "status" + ], + "type": "object", + "properties": { + "endTime": { + "format": "date-time", + "description": "End time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string" + }, + "error": { + "$ref": "#/definitions/PurviewShareErrorInfo" + }, + "id": { + "description": "Job id of the long running operation", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "Start time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string" + }, + "status": { + "$ref": "#/definitions/OperationStatus" + } + } + }, + "OperationStatus": { + "description": "States for long running operations.", + "enum": [ + "Running", + "TransientFailure", + "Succeeded", + "Failed", + "NotStarted" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The long running operation is in 'Running' state", + "name": "Long running operation state is 'Running'" + }, + { + "value": "TransientFailure", + "description": "The long running operation hit a transient failure", + "name": "Long running operation state is 'TransientFailure'" + }, + { + "value": "Succeeded", + "description": "The long running operation is in 'Succeeded' state", + "name": "Long running operation state is 'Succeeded'" + }, + { + "value": "Failed", + "description": "The long running operation is in 'Failed' state", + "name": "Long running operation state is 'Failed'" + }, + { + "value": "NotStarted", + "description": "The long running operation has not started", + "name": "Long running operation state is 'NotStarted'" + } + ] + } + }, + "ProxyResource": { + "description": "Base data transfer object implementation for proxy resources.", + "type": "object", + "properties": { + "id": { + "description": "The unique id of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the resource.", + "type": "string", + "readOnly": true + } + } + }, + "PurviewShareError": { + "description": "The purview share error model.", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/PurviewShareErrorInfo" + } + } + }, + "PurviewShareErrorInfo": { + "description": "The purview share error body model.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "Code of the error", + "type": "string" + }, + "details": { + "description": "Nested details of the error model", + "type": "array", + "items": { + "$ref": "#/definitions/PurviewShareErrorInfo" + } + }, + "message": { + "description": "Message of the error", + "type": "string" + }, + "target": { + "description": "Target of the error", + "type": "string" + } + } + }, + "ReceivedShare": { + "description": "A received share data transfer object.", + "required": [ + "shareKind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "shareKind": { + "$ref": "#/definitions/ShareKind" + } + }, + "discriminator": "shareKind" + }, + "ReceivedShareList": { + "description": "List of received shares.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "type": "array", + "items": { + "$ref": "#/definitions/ReceivedShare" + } + } + } + }, + "ReferenceNameType": { + "description": "Defines the type of resource being shared", + "enum": [ + "ArmResourceReference" + ], + "type": "string", + "x-ms-enum": { + "name": "ReferenceNameType", + "modelAsString": true, + "values": [ + { + "value": "ArmResourceReference", + "description": "The type of reference is an ARM resource", + "name": "Arm resource reference" + } + ] + } + }, + "SentShare": { + "description": "A sent share data transfer object.", + "required": [ + "shareKind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "shareKind": { + "$ref": "#/definitions/ShareKind" + } + }, + "discriminator": "shareKind" + }, + "SentShareInvitation": { + "description": "A sent share invitation data transfer object.", + "required": [ + "invitationKind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "invitationKind": { + "$ref": "#/definitions/InvitationKind" + } + }, + "discriminator": "invitationKind" + }, + "SentShareInvitationList": { + "description": "List of the sent share invitations", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "type": "array", + "items": { + "$ref": "#/definitions/SentShareInvitation" + } + } + } + }, + "SentShareList": { + "description": "List of sent shares.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "type": "array", + "items": { + "$ref": "#/definitions/SentShare" + } + } + } + }, + "ServiceInvitation": { + "description": "An service invitation kind.", + "required": [ + "invitationKind", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SentShareInvitation" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceInvitationProperties" + } + }, + "x-ms-discriminator-value": "Service" + }, + "ServiceInvitationProperties": { + "description": "Properties of the service invitation type.", + "required": [ + "targetActiveDirectoryId", + "targetObjectId" + ], + "type": "object", + "properties": { + "expirationDate": { + "format": "date-time", + "description": "The time at which the invitation will expire. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string" + }, + "senderEmail": { + "description": "Email address of the sender.", + "type": "string", + "readOnly": true + }, + "senderName": { + "description": "Name of the sender", + "type": "string", + "readOnly": true + }, + "senderTenantName": { + "description": "Tenant name of the sender", + "type": "string", + "readOnly": true + }, + "sentAt": { + "format": "date-time", + "description": "Gets the time at which the invitation was sent. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string", + "readOnly": true + }, + "shareStatus": { + "$ref": "#/definitions/ShareStatus" + }, + "state": { + "$ref": "#/definitions/State", + "readOnly": true + }, + "targetActiveDirectoryId": { + "format": "uuid", + "description": "The target azure active directory id the invitation is sent to.", + "type": "string" + }, + "targetObjectId": { + "format": "uuid", + "description": "The target object id in the azure active directory the invitation is sent to.", + "type": "string" + } + } + }, + "ShareKind": { + "description": "Defines the supported types for share.", + "enum": [ + "InPlace" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareKind", + "modelAsString": true, + "values": [ + { + "value": "InPlace", + "description": "The type of share is in-place sharing", + "name": "In place share kind" + } + ] + } + }, + "ShareStatus": { + "description": "Share status.", + "enum": [ + "Detached", + "Attached" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareStatus", + "modelAsString": true, + "values": [ + { + "value": "Detached", + "description": "The share has not been accepted yet", + "name": "Detached share status" + }, + { + "value": "Attached", + "description": "The share has been accepted by the recipient", + "name": "Attached share status" + } + ] + } + }, + "Sink": { + "description": "Holds details on the destination of the mapped artifact", + "required": [ + "storeKind", + "storeReference" + ], + "type": "object", + "properties": { + "storeKind": { + "$ref": "#/definitions/StoreKind" + }, + "storeReference": { + "$ref": "#/definitions/StoreReference" + } + }, + "discriminator": "storeKind" + }, + "State": { + "description": "State of the resource", + "enum": [ + "Unknown", + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "The state of the resource is 'Unknown'", + "name": "Unknown state" + }, + { + "value": "Succeeded", + "description": "The state of the resource is 'Succeeded'", + "name": "Succeeded state" + }, + { + "value": "Creating", + "description": "The state of the resource is 'Creating'", + "name": "Creating state" + }, + { + "value": "Deleting", + "description": "The state of the resource is 'Deleting'", + "name": "Deleting state" + }, + { + "value": "Moving", + "description": "The state of the resource is 'Moving'", + "name": "Moving state" + }, + { + "value": "Failed", + "description": "The state of the resource is 'Failed'", + "name": "Failed state" + } + ] + } + }, + "StorageAccountPath": { + "description": "Defines a single StorageAccountPath path", + "required": [ + "containerName" + ], + "type": "object", + "properties": { + "containerName": { + "description": "Gets or sets the container name", + "type": "string" + }, + "receiverPath": { + "description": "Gets or sets the path on the receiver side where the artifact is to be mapped", + "type": "string" + }, + "senderPath": { + "description": "Gets or sets the path to file/folder within the container to be shared", + "type": "string" + } + } + }, + "StoreKind": { + "description": "The types of asset.", + "enum": [ + "AdlsGen2Account", + "BlobAccount" + ], + "type": "string", + "x-ms-enum": { + "name": "StoreKind", + "modelAsString": true, + "values": [ + { + "value": "AdlsGen2Account", + "description": "The store kind is a Adls Gen 2 storage account", + "name": "Adls gen 2 storage account store kind" + }, + { + "value": "BlobAccount", + "description": "The store kind is a Blob storage account", + "name": "Blob storage account store kind" + } + ] + } + }, + "StoreReference": { + "description": "A Store Reference for an artifact or sink.", + "type": "object", + "properties": { + "referenceName": { + "description": "Reference name for resource associated with the sink or artifact.", + "type": "string" + }, + "type": { + "$ref": "#/definitions/ReferenceNameType" + } + } + }, + "TenantEmailRegistration": { + "description": "A tenant email registration data transfer object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TenantEmailRegistrationProperties" + } + } + }, + "TenantEmailRegistrationProperties": { + "description": "Tenant email registration property bag.", + "required": [ + "activationCode" + ], + "type": "object", + "properties": { + "activationCode": { + "description": "Activation code for the registration.", + "type": "string" + }, + "activationExpiration": { + "format": "date-time", + "description": "Date of the activation expiration. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string", + "readOnly": true + }, + "email": { + "description": "The email to register.", + "type": "string", + "readOnly": true + }, + "registrationStatus": { + "$ref": "#/definitions/TenantEmailRegistrationStatus", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/State", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id to register.", + "type": "string", + "readOnly": true + } + } + }, + "TenantEmailRegistrationStatus": { + "description": "Defines the supported types for registration.", + "enum": [ + "ActivationPending", + "Activated", + "ActivationAttemptsExhausted" + ], + "type": "string", + "x-ms-enum": { + "name": "TenantEmailRegistrationStatus", + "modelAsString": true, + "values": [ + { + "value": "ActivationPending", + "description": "The tenant email registration is in pending state", + "name": "Activation pending" + }, + { + "value": "Activated", + "description": "The tenant email registration is complete and has been activated", + "name": "Activated" + }, + { + "value": "ActivationAttemptsExhausted", + "description": "The tenant email registration has exhausted the max attempts", + "name": "Activation attempts exhausted" + } + ] + } + }, + "UserInvitation": { + "description": "A user invitation kind.", + "required": [ + "invitationKind", + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SentShareInvitation" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/UserInvitationProperties" + } + }, + "x-ms-discriminator-value": "User" + }, + "UserInvitationProperties": { + "description": "Properties of the user invitation type.", + "required": [ + "targetEmail" + ], + "type": "object", + "properties": { + "expirationDate": { + "format": "date-time", + "description": "The time at which the invitation will expire. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string" + }, + "notify": { + "description": "Whether or not the recipient was notified via email.", + "type": "boolean" + }, + "senderEmail": { + "description": "Email address of the sender.", + "type": "string", + "readOnly": true + }, + "senderName": { + "description": "Name of the sender", + "type": "string", + "readOnly": true + }, + "senderTenantName": { + "description": "Tenant name of the sender", + "type": "string", + "readOnly": true + }, + "sentAt": { + "format": "date-time", + "description": "Gets the time at which the invitation was sent. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)", + "type": "string", + "readOnly": true + }, + "shareStatus": { + "$ref": "#/definitions/ShareStatus" + }, + "state": { + "$ref": "#/definitions/State", + "readOnly": true + }, + "targetEmail": { + "description": "The receiver email for the invitation is being sent.", + "type": "string" + } + } + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "The sharing endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + }, + "api-version": { + "in": "query", + "name": "api-version", + "description": "The api version to use", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "jobId": { + "in": "path", + "name": "jobId", + "description": "Id of the corresponding job to the LRO", + "required": true, + "type": "string", + "maxLength": 100, + "pattern": "^[a-zA-z0-9-]{1,100}$", + "x-ms-parameter-location": "method" + }, + "receivedShareId": { + "in": "path", + "name": "receivedShareId", + "description": "Id of the received share", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^(?:\\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\\}{0,1})$", + "x-ms-parameter-location": "method" + }, + "sentShareId": { + "in": "path", + "name": "sentShareId", + "description": "Id of the sent share", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^(?:\\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\\}{0,1})$", + "x-ms-parameter-location": "method" + }, + "sentShareInvitationId": { + "in": "path", + "name": "sentShareInvitationId", + "description": "Id of the sent share invitation", + "required": true, + "type": "string", + "maxLength": 36, + "pattern": "^(?:\\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\\}{0,1})$|^(?:[0-9a-fA-F]+)$", + "x-ms-parameter-location": "method" + }, + "referenceName": { + "in": "query", + "name": "referenceName", + "description": "A name that references a data store.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "skipToken": { + "in": "query", + "name": "skipToken", + "description": "The continuation token to list the next page", + "type": "string", + "x-ms-parameter-location": "method" + }, + "filter": { + "in": "query", + "name": "filter", + "description": "Filters the results using OData syntax", + "type": "string", + "x-ms-parameter-location": "method" + }, + "orderby": { + "in": "query", + "name": "orderby", + "description": "Sorts the results using OData syntax", + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azureAuth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://purview.azure.net/.default": "Purview service scope" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "security": [ + { + "azureAuth": [ + "https://purview.azure.net/.default" + ] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +} diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index 595a23e77f91..6a8b552b33ba 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -167,6 +167,21 @@ input-file: - Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json ``` +``` yaml +openapi-type: data-plane +tag: package-2023-02-15-preview +title: PurviewShareClient +``` + +### Tag: package-2023-02-15-preview + +These settings apply only when `--tag=package-2023-02-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-02-15-preview' +input-file: + - Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json +``` + ``` yaml openapi-type: data-plane tag: package-2022-11-01-preview