diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json index 734372e92f71..734c0df12808 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json @@ -16,6 +16,53 @@ "application/json" ], "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DataShare/accounts": { + "get": { + "tags": [ + "Account" + ], + "summary": "List Accounts in a subscription", + "description": "List Accounts in Subscription", + "operationId": "Accounts_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Continuation token", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "An error response received from the Microsoft.DataShare resource provider.", + "schema": { + "$ref": "#/definitions/DataShareError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Accounts_ListBySubscription": { + "$ref": "./examples/Accounts_ListBySubscription.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}": { "get": { "tags": [ @@ -214,53 +261,6 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DataShare/accounts": { - "get": { - "tags": [ - "Account" - ], - "summary": "List Accounts in a subscription", - "description": "List Accounts in Subscription", - "operationId": "Accounts_ListBySubscription", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$skipToken", - "in": "query", - "description": "Continuation token", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AccountList" - } - }, - "default": { - "description": "An error response received from the Microsoft.DataShare resource provider.", - "schema": { - "$ref": "#/definitions/DataShareError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Accounts_ListBySubscription": { - "$ref": "./examples/Accounts_ListBySubscription.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts": { "get": { "tags": [ @@ -311,40 +311,31 @@ } } }, - "/providers/Microsoft.DataShare/locations/{location}/RejectInvitation": { - "post": { + "/providers/Microsoft.DataShare/ListInvitations": { + "get": { "tags": [ "ConsumerInvitation" ], - "summary": "Rejects the invitation identified by invitationId", - "description": "Reject an invitation", - "operationId": "ConsumerInvitations_RejectInvitation", + "summary": "List the invitations", + "description": "Lists invitations", + "operationId": "ConsumerInvitations_ListInvitations", "parameters": [ { - "name": "location", - "in": "path", - "description": "Location of the invitation", - "required": true, - "type": "string" - }, - { - "name": "invitation", - "in": "body", - "description": "An invitation payload", - "required": true, - "schema": { - "$ref": "#/definitions/ConsumerInvitation" - } + "$ref": "#/parameters/api-version" }, { - "$ref": "#/parameters/api-version" + "name": "$skipToken", + "in": "query", + "description": "The continuation token", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ConsumerInvitation" + "$ref": "#/definitions/ConsumerInvitationList" } }, "default": { @@ -354,9 +345,12 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "ConsumerInvitations_RejectInvitation": { - "$ref": "./examples/ConsumerInvitations_RejectInvitation.json" + "ConsumerInvitations_ListInvitations": { + "$ref": "./examples/ConsumerInvitations_ListInvitations.json" } } } @@ -409,31 +403,40 @@ } } }, - "/providers/Microsoft.DataShare/ListInvitations": { - "get": { + "/providers/Microsoft.DataShare/locations/{location}/RejectInvitation": { + "post": { "tags": [ "ConsumerInvitation" ], - "summary": "List the invitations", - "description": "Lists invitations", - "operationId": "ConsumerInvitations_ListInvitations", + "summary": "Rejects the invitation identified by invitationId", + "description": "Reject an invitation", + "operationId": "ConsumerInvitations_RejectInvitation", "parameters": [ { - "$ref": "#/parameters/api-version" + "name": "location", + "in": "path", + "description": "Location of the invitation", + "required": true, + "type": "string" }, { - "name": "$skipToken", - "in": "query", - "description": "The continuation token", - "required": false, - "type": "string" + "name": "invitation", + "in": "body", + "description": "An invitation payload", + "required": true, + "schema": { + "$ref": "#/definitions/ConsumerInvitation" + } + }, + { + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ConsumerInvitationList" + "$ref": "#/definitions/ConsumerInvitation" } }, "default": { @@ -443,12 +446,9 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "ConsumerInvitations_ListInvitations": { - "$ref": "./examples/ConsumerInvitations_ListInvitations.json" + "ConsumerInvitations_RejectInvitation": { + "$ref": "./examples/ConsumerInvitations_RejectInvitation.json" } } } @@ -1283,14 +1283,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizationDetails": { + "post": { "tags": [ "Share" ], - "summary": "Get a specified share", - "description": "Get a share ", - "operationId": "Shares_Get", + "summary": "List data set level details for a share synchronization", + "description": "List synchronization details", + "operationId": "Shares_ListSynchronizationDetails", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1304,19 +1304,49 @@ { "name": "shareName", "in": "path", - "description": "The name of the share to retrieve.", + "description": "The name of the share.", "required": true, "type": "string" }, + { + "name": "shareSynchronization", + "in": "body", + "description": "Share Synchronization payload.", + "required": true, + "schema": { + "$ref": "#/definitions/ShareSynchronization" + } + }, { "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Continuation token", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Filters the results using OData syntax.", + "required": false, + "type": "string" + }, + { + "name": "$orderby", + "in": "query", + "description": "Sorts the results using OData syntax.", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/Share" + "$ref": "#/definitions/SynchronizationDetailsList" } }, "default": { @@ -1326,19 +1356,24 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Shares_Get": { - "$ref": "./examples/Shares_Get.json" + "Shares_ListSynchronizationDetails": { + "$ref": "./examples/Shares_ListSynchronizationDetails.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations": { + "post": { "tags": [ "Share" ], - "summary": "Create a share in the given account.", - "description": "Create a share ", - "operationId": "Shares_Create", + "summary": "List Synchronizations in a share", + "description": "List synchronizations of a share", + "operationId": "Shares_ListSynchronizations", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1356,126 +1391,13 @@ "required": true, "type": "string" }, - { - "name": "share", - "in": "body", - "description": "The share payload", - "required": true, - "schema": { - "$ref": "#/definitions/Share" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Share" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Share" - } - }, - "default": { - "description": "An error response received from the Microsoft.DataShare resource provider.", - "schema": { - "$ref": "#/definitions/DataShareError" - } - } - }, - "x-ms-examples": { - "Shares_Create": { - "$ref": "./examples/Shares_Create.json" - } - } - }, - "delete": { - "tags": [ - "Share" - ], - "summary": "Deletes a share", - "description": "Delete a share ", - "operationId": "Shares_Delete", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/accountName" - }, - { - "name": "shareName", - "in": "path", - "description": "The name of the share.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OperationResponse" - } - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "Success" - }, - "default": { - "description": "An error response received from the Microsoft.DataShare resource provider.", - "schema": { - "$ref": "#/definitions/DataShareError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Shares_Delete": { - "$ref": "./examples/Shares_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares": { - "get": { - "tags": [ - "Share" - ], - "summary": "List of available shares under an account.", - "description": "List shares in an account", - "operationId": "Shares_ListByAccount", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/accountName" - }, { "$ref": "#/parameters/api-version" }, { "name": "$skipToken", "in": "query", - "description": "Continuation Token", + "description": "Continuation token", "required": false, "type": "string" }, @@ -1498,7 +1420,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareList" + "$ref": "#/definitions/ShareSynchronizationList" } }, "default": { @@ -1512,20 +1434,20 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Shares_ListByAccount": { - "$ref": "./examples/Shares_ListByAccount.json" + "Shares_ListSynchronizations": { + "$ref": "./examples/Shares_ListSynchronizations.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/reinstate": { "post": { "tags": [ "Share" ], - "summary": "List Synchronizations in a share", - "description": "List synchronizations of a share", - "operationId": "Shares_ListSynchronizations", + "summary": "Reinstate share subscription in a provider share.", + "description": "Reinstate share subscription in a provider share", + "operationId": "ProviderShareSubscriptions_Reinstate", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1544,35 +1466,21 @@ "type": "string" }, { - "$ref": "#/parameters/api-version" - }, - { - "name": "$skipToken", - "in": "query", - "description": "Continuation token", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Filters the results using OData syntax.", - "required": false, + "name": "providerShareSubscriptionId", + "in": "path", + "description": "To locate shareSubscription", + "required": true, "type": "string" }, { - "name": "$orderby", - "in": "query", - "description": "Sorts the results using OData syntax.", - "required": false, - "type": "string" + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSynchronizationList" + "$ref": "#/definitions/ProviderShareSubscription" } }, "default": { @@ -1582,24 +1490,21 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Shares_ListSynchronizations": { - "$ref": "./examples/Shares_ListSynchronizations.json" + "ProviderShareSubscriptions_Reinstate": { + "$ref": "./examples/ProviderShareSubscriptions_Reinstate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizationDetails": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/revoke": { "post": { "tags": [ "Share" ], - "summary": "List data set level details for a share synchronization", - "description": "List synchronization details", - "operationId": "Shares_ListSynchronizationDetails", + "summary": "Revoke share subscription in a provider share.", + "description": "Revoke share subscription in a provider share", + "operationId": "ProviderShareSubscriptions_Revoke", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1618,44 +1523,27 @@ "type": "string" }, { - "name": "shareSynchronization", - "in": "body", - "description": "Share Synchronization payload.", + "name": "providerShareSubscriptionId", + "in": "path", + "description": "To locate shareSubscription", "required": true, - "schema": { - "$ref": "#/definitions/ShareSynchronization" - } - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$skipToken", - "in": "query", - "description": "Continuation token", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Filters the results using OData syntax.", - "required": false, "type": "string" }, { - "name": "$orderby", - "in": "query", - "description": "Sorts the results using OData syntax.", - "required": false, - "type": "string" + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/SynchronizationDetailsList" + "$ref": "#/definitions/ProviderShareSubscription" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ProviderShareSubscription" } }, "default": { @@ -1665,12 +1553,13 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" }, "x-ms-examples": { - "Shares_ListSynchronizationDetails": { - "$ref": "./examples/Shares_ListSynchronizationDetails.json" + "ProviderShareSubscriptions_Revoke": { + "$ref": "./examples/ProviderShareSubscriptions_Revoke.json" } } } @@ -1792,14 +1681,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/revoke": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}": { + "get": { "tags": [ "Share" ], - "summary": "Revoke share subscription in a provider share.", - "description": "Revoke share subscription in a provider share", - "operationId": "ProviderShareSubscriptions_Revoke", + "summary": "Get a specified share", + "description": "Get a share ", + "operationId": "Shares_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1813,14 +1702,7 @@ { "name": "shareName", "in": "path", - "description": "The name of the share.", - "required": true, - "type": "string" - }, - { - "name": "providerShareSubscriptionId", - "in": "path", - "description": "To locate shareSubscription", + "description": "The name of the share to retrieve.", "required": true, "type": "string" }, @@ -1832,13 +1714,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ProviderShareSubscription" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/ProviderShareSubscription" + "$ref": "#/definitions/Share" } }, "default": { @@ -1848,25 +1724,19 @@ } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, "x-ms-examples": { - "ProviderShareSubscriptions_Revoke": { - "$ref": "./examples/ProviderShareSubscriptions_Revoke.json" + "Shares_Get": { + "$ref": "./examples/Shares_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/reinstate": { - "post": { + }, + "put": { "tags": [ "Share" ], - "summary": "Reinstate share subscription in a provider share.", - "description": "Reinstate share subscription in a provider share", - "operationId": "ProviderShareSubscriptions_Reinstate", + "summary": "Create a share in the given account.", + "description": "Create a share ", + "operationId": "Shares_Create", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1885,21 +1755,29 @@ "type": "string" }, { - "name": "providerShareSubscriptionId", - "in": "path", - "description": "To locate shareSubscription", + "name": "share", + "in": "body", + "description": "The share payload", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/Share" + } }, { "$ref": "#/parameters/api-version" } ], "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Share" + } + }, "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ProviderShareSubscription" + "$ref": "#/definitions/Share" } }, "default": { @@ -1910,20 +1788,18 @@ } }, "x-ms-examples": { - "ProviderShareSubscriptions_Reinstate": { - "$ref": "./examples/ProviderShareSubscriptions_Reinstate.json" + "Shares_Create": { + "$ref": "./examples/Shares_Create.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}": { - "get": { + }, + "delete": { "tags": [ - "ShareSubscription" + "Share" ], - "summary": "Get shareSubscription in an account.", - "description": "Get a shareSubscription in an account", - "operationId": "ShareSubscriptions_Get", + "summary": "Deletes a share", + "description": "Delete a share ", + "operationId": "Shares_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1935,9 +1811,9 @@ "$ref": "#/parameters/accountName" }, { - "name": "shareSubscriptionName", + "name": "shareName", "in": "path", - "description": "The name of the shareSubscription.", + "description": "The name of the share.", "required": true, "type": "string" }, @@ -1949,9 +1825,15 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscription" + "$ref": "#/definitions/OperationResponse" } }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "Success" + }, "default": { "description": "An error response received from the Microsoft.DataShare resource provider.", "schema": { @@ -1959,19 +1841,22 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "ShareSubscriptions_Get": { - "$ref": "./examples/ShareSubscriptions_Get.json" + "Shares_Delete": { + "$ref": "./examples/Shares_Delete.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares": { + "get": { "tags": [ - "ShareSubscription" + "Share" ], - "summary": "Create shareSubscription in an account.", - "description": "Create a shareSubscription in an account", - "operationId": "ShareSubscriptions_Create", + "summary": "List of available shares under an account.", + "description": "List shares in an account", + "operationId": "Shares_ListByAccount", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1983,36 +1868,35 @@ "$ref": "#/parameters/accountName" }, { - "name": "shareSubscriptionName", - "in": "path", - "description": "The name of the shareSubscription.", - "required": true, + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Continuation Token", + "required": false, "type": "string" }, { - "name": "shareSubscription", - "in": "body", - "description": "create parameters for shareSubscription", - "required": true, - "schema": { - "$ref": "#/definitions/ShareSubscription" - } + "name": "$filter", + "in": "query", + "description": "Filters the results using OData syntax.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/api-version" + "name": "$orderby", + "in": "query", + "description": "Sorts the results using OData syntax.", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscription" - } - }, - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ShareSubscription" + "$ref": "#/definitions/ShareList" } }, "default": { @@ -2022,19 +1906,24 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "ShareSubscriptions_Create": { - "$ref": "./examples/ShareSubscriptions_Create.json" + "Shares_ListByAccount": { + "$ref": "./examples/Shares_ListByAccount.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/cancelSynchronization": { + "post": { "tags": [ "ShareSubscription" ], - "summary": "Delete shareSubscription in an account.", - "description": "Delete a shareSubscription in an account", - "operationId": "ShareSubscriptions_Delete", + "summary": "Request cancellation of a data share snapshot", + "description": "Request to cancel a synchronization.", + "operationId": "ShareSubscriptions_CancelSynchronization", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2053,85 +1942,29 @@ "type": "string" }, { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OperationResponse" - } - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "Success" - }, - "default": { - "description": "An error response received from the Microsoft.DataShare resource provider.", + "name": "shareSubscriptionSynchronization", + "in": "body", + "description": "Share Subscription Synchronization payload.", + "required": true, "schema": { - "$ref": "#/definitions/DataShareError" + "$ref": "#/definitions/ShareSubscriptionSynchronization" } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "ShareSubscriptions_Delete": { - "$ref": "./examples/ShareSubscriptions_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions": { - "get": { - "tags": [ - "ShareSubscription" - ], - "summary": "List of available share subscriptions under an account.", - "description": "List share subscriptions in an account", - "operationId": "ShareSubscriptions_ListByAccount", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/accountName" }, { "$ref": "#/parameters/api-version" - }, - { - "name": "$skipToken", - "in": "query", - "description": "Continuation Token", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Filters the results using OData syntax.", - "required": false, - "type": "string" - }, - { - "name": "$orderby", - "in": "query", - "description": "Sorts the results using OData syntax.", - "required": false, - "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscriptionList" + "$ref": "#/definitions/ShareSubscriptionSynchronization" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ShareSubscriptionSynchronization" } }, "default": { @@ -2141,12 +1974,13 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" }, "x-ms-examples": { - "ShareSubscriptions_ListByAccount": { - "$ref": "./examples/ShareSubscriptions_ListByAccount.json" + "ShareSubscriptions_CancelSynchronization": { + "$ref": "./examples/ShareSubscriptions_CancelSynchronization.json" } } } @@ -2271,14 +2105,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails": { "post": { "tags": [ "ShareSubscription" ], - "summary": "List Synchronizations in a share subscription.", - "description": "List synchronizations of a share subscription", - "operationId": "ShareSubscriptions_ListSynchronizations", + "summary": "List data set level details for a share subscription synchronization", + "description": "List synchronization details", + "operationId": "ShareSubscriptions_ListSynchronizationDetails", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2296,6 +2130,15 @@ "required": true, "type": "string" }, + { + "name": "shareSubscriptionSynchronization", + "in": "body", + "description": "Share Subscription Synchronization payload.", + "required": true, + "schema": { + "$ref": "#/definitions/ShareSubscriptionSynchronization" + } + }, { "$ref": "#/parameters/api-version" }, @@ -2325,7 +2168,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscriptionSynchronizationList" + "$ref": "#/definitions/SynchronizationDetailsList" } }, "default": { @@ -2339,20 +2182,20 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "ShareSubscriptions_ListSynchronizations": { - "$ref": "./examples/ShareSubscriptions_ListSynchronizations.json" + "ShareSubscriptions_ListSynchronizationDetails": { + "$ref": "./examples/ShareSubscriptions_ListSynchronizationDetails.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizations": { "post": { "tags": [ "ShareSubscription" ], - "summary": "List data set level details for a share subscription synchronization", - "description": "List synchronization details", - "operationId": "ShareSubscriptions_ListSynchronizationDetails", + "summary": "List Synchronizations in a share subscription.", + "description": "List synchronizations of a share subscription", + "operationId": "ShareSubscriptions_ListSynchronizations", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2370,15 +2213,6 @@ "required": true, "type": "string" }, - { - "name": "shareSubscriptionSynchronization", - "in": "body", - "description": "Share Subscription Synchronization payload.", - "required": true, - "schema": { - "$ref": "#/definitions/ShareSubscriptionSynchronization" - } - }, { "$ref": "#/parameters/api-version" }, @@ -2408,7 +2242,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/SynchronizationDetailsList" + "$ref": "#/definitions/ShareSubscriptionSynchronizationList" } }, "default": { @@ -2422,8 +2256,8 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "ShareSubscriptions_ListSynchronizationDetails": { - "$ref": "./examples/ShareSubscriptions_ListSynchronizationDetails.json" + "ShareSubscriptions_ListSynchronizations": { + "$ref": "./examples/ShareSubscriptions_ListSynchronizations.json" } } } @@ -2497,15 +2331,15 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/cancelSynchronization": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}": { + "get": { "tags": [ "ShareSubscription" ], - "summary": "Request cancellation of a data share snapshot", - "description": "Request to cancel a synchronization.", - "operationId": "ShareSubscriptions_CancelSynchronization", - "parameters": [ + "summary": "Get shareSubscription in an account.", + "description": "Get a shareSubscription in an account", + "operationId": "ShareSubscriptions_Get", + "parameters": [ { "$ref": "#/parameters/subscriptionId" }, @@ -2523,12 +2357,60 @@ "type": "string" }, { - "name": "shareSubscriptionSynchronization", + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ShareSubscription" + } + }, + "default": { + "description": "An error response received from the Microsoft.DataShare resource provider.", + "schema": { + "$ref": "#/definitions/DataShareError" + } + } + }, + "x-ms-examples": { + "ShareSubscriptions_Get": { + "$ref": "./examples/ShareSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "ShareSubscription" + ], + "summary": "Create shareSubscription in an account.", + "description": "Create a shareSubscription in an account", + "operationId": "ShareSubscriptions_Create", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "shareSubscriptionName", + "in": "path", + "description": "The name of the shareSubscription.", + "required": true, + "type": "string" + }, + { + "name": "shareSubscription", "in": "body", - "description": "Share Subscription Synchronization payload.", + "description": "create parameters for shareSubscription", "required": true, "schema": { - "$ref": "#/definitions/ShareSubscriptionSynchronization" + "$ref": "#/definitions/ShareSubscription" } }, { @@ -2539,15 +2421,69 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscriptionSynchronization" + "$ref": "#/definitions/ShareSubscription" } }, - "202": { - "description": "Accepted", + "201": { + "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscriptionSynchronization" + "$ref": "#/definitions/ShareSubscription" + } + }, + "default": { + "description": "An error response received from the Microsoft.DataShare resource provider.", + "schema": { + "$ref": "#/definitions/DataShareError" + } + } + }, + "x-ms-examples": { + "ShareSubscriptions_Create": { + "$ref": "./examples/ShareSubscriptions_Create.json" + } + } + }, + "delete": { + "tags": [ + "ShareSubscription" + ], + "summary": "Delete shareSubscription in an account.", + "description": "Delete a shareSubscription in an account", + "operationId": "ShareSubscriptions_Delete", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "shareSubscriptionName", + "in": "path", + "description": "The name of the shareSubscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationResponse" } }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "Success" + }, "default": { "description": "An error response received from the Microsoft.DataShare resource provider.", "schema": { @@ -2556,12 +2492,76 @@ } }, "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" + "x-ms-examples": { + "ShareSubscriptions_Delete": { + "$ref": "./examples/ShareSubscriptions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions": { + "get": { + "tags": [ + "ShareSubscription" + ], + "summary": "List of available share subscriptions under an account.", + "description": "List share subscriptions in an account", + "operationId": "ShareSubscriptions_ListByAccount", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Continuation Token", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Filters the results using OData syntax.", + "required": false, + "type": "string" + }, + { + "name": "$orderby", + "in": "query", + "description": "Sorts the results using OData syntax.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ShareSubscriptionList" + } + }, + "default": { + "description": "An error response received from the Microsoft.DataShare resource provider.", + "schema": { + "$ref": "#/definitions/DataShareError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" }, "x-ms-examples": { - "ShareSubscriptions_CancelSynchronization": { - "$ref": "./examples/ShareSubscriptions_CancelSynchronization.json" + "ShareSubscriptions_ListByAccount": { + "$ref": "./examples/ShareSubscriptions_ListByAccount.json" } } } @@ -3067,6 +3067,27 @@ } }, "definitions": { + "AccountList": { + "description": "List response for get Accounts.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + } + } + } + }, "Account": { "description": "An account data transfer object.", "required": [ @@ -3198,19 +3219,6 @@ } } }, - "AccountUpdateParameters": { - "description": "Update parameters for accounts", - "type": "object", - "properties": { - "tags": { - "description": "Tags on the azure resource.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, "OperationResponse": { "description": "Response for long running operation", "required": [ @@ -3250,8 +3258,21 @@ } } }, - "AccountList": { - "description": "List response for get Accounts.", + "AccountUpdateParameters": { + "description": "Update parameters for accounts", + "type": "object", + "properties": { + "tags": { + "description": "Tags on the azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ConsumerInvitationList": { + "description": "List response for get InvitationList", "required": [ "value" ], @@ -3266,7 +3287,7 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/Account" + "$ref": "#/definitions/ConsumerInvitation" } } } @@ -3381,38 +3402,17 @@ } } }, - "ConsumerInvitationList": { - "description": "List response for get InvitationList", + "DataSet": { + "description": "A DataSet data transfer object.", "required": [ - "value" + "kind" ], "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ConsumerInvitation" - } - } - } - }, - "DataSet": { - "description": "A DataSet data transfer object.", - "required": [ - "kind" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyDto" - } - ], + "allOf": [ + { + "$ref": "#/definitions/ProxyDto" + } + ], "properties": { "kind": { "description": "Kind of data set.", @@ -3805,122 +3805,6 @@ } } }, - "Share": { - "description": "A share data transfer object.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyDto" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ShareProperties", - "description": "Properties on the share", - "x-ms-client-flatten": true - } - } - }, - "ShareProperties": { - "description": "Share property bag.", - "type": "object", - "properties": { - "createdAt": { - "format": "date-time", - "description": "Time at which the share was created.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "Share description.", - "type": "string" - }, - "provisioningState": { - "description": "Gets or sets the provisioning state", - "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - } - }, - "shareKind": { - "description": "Share kind.", - "enum": [ - "CopyBased", - "InPlace" - ], - "type": "string", - "x-ms-enum": { - "name": "shareKind", - "modelAsString": true - } - }, - "terms": { - "description": "Share terms.", - "type": "string" - }, - "userEmail": { - "description": "Email of the user who created the resource", - "type": "string", - "readOnly": true - }, - "userName": { - "description": "Name of the user who created the resource", - "type": "string", - "readOnly": true - } - } - }, - "ShareList": { - "description": "List response for get Shares.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Share" - } - } - } - }, - "ShareSynchronizationList": { - "description": "List response for get ShareSynchronization.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ShareSynchronization" - } - } - } - }, "ShareSynchronization": { "description": "A ShareSynchronization data transfer object.", "type": "object", @@ -4109,6 +3993,27 @@ } } }, + "ShareSynchronizationList": { + "description": "List response for get ShareSynchronization.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ShareSynchronization" + } + } + } + }, "ProviderShareSubscription": { "description": "A provider side share subscription data transfer object.", "type": "object", @@ -4209,11 +4114,8 @@ } } }, - "ShareSubscription": { - "description": "A share subscription data transfer object.", - "required": [ - "properties" - ], + "Share": { + "description": "A share data transfer object.", "type": "object", "allOf": [ { @@ -4222,47 +4124,28 @@ ], "properties": { "properties": { - "$ref": "#/definitions/ShareSubscriptionProperties", - "description": "Properties on the share subscription", + "$ref": "#/definitions/ShareProperties", + "description": "Properties on the share", "x-ms-client-flatten": true } } }, - "ShareSubscriptionProperties": { - "description": "Share subscription property bag.", - "required": [ - "invitationId", - "sourceShareLocation" - ], + "ShareProperties": { + "description": "Share property bag.", "type": "object", "properties": { "createdAt": { "format": "date-time", - "description": "Time at which the share subscription was created.", + "description": "Time at which the share was created.", "type": "string", "readOnly": true }, - "invitationId": { - "description": "The invitation id.", + "description": { + "description": "Share description.", "type": "string" }, - "providerEmail": { - "description": "Email of the provider who created the resource", - "type": "string", - "readOnly": true - }, - "providerName": { - "description": "Name of the provider who created the resource", - "type": "string", - "readOnly": true - }, - "providerTenantName": { - "description": "Tenant name of the provider who created the resource", - "type": "string", - "readOnly": true - }, "provisioningState": { - "description": "Provisioning state of the share subscription", + "description": "Gets or sets the provisioning state", "enum": [ "Succeeded", "Creating", @@ -4277,51 +4160,20 @@ "modelAsString": true } }, - "shareDescription": { - "description": "Description of share", - "type": "string", - "readOnly": true - }, "shareKind": { - "description": "Kind of share", + "description": "Share kind.", "enum": [ "CopyBased", "InPlace" ], "type": "string", - "readOnly": true, "x-ms-enum": { "name": "shareKind", "modelAsString": true } }, - "shareName": { - "description": "Name of the share", - "type": "string", - "readOnly": true - }, - "shareSubscriptionStatus": { - "description": "Gets the current status of share subscription.", - "enum": [ - "Active", - "Revoked", - "SourceDeleted", - "Revoking" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "shareSubscriptionStatus", - "modelAsString": true - } - }, - "shareTerms": { - "description": "Terms of a share", - "type": "string", - "readOnly": true - }, - "sourceShareLocation": { - "description": "Source share location.", + "terms": { + "description": "Share terms.", "type": "string" }, "userEmail": { @@ -4336,8 +4188,8 @@ } } }, - "ShareSubscriptionList": { - "description": "List response for get ShareSubscription.", + "ShareList": { + "description": "List response for get Shares.", "required": [ "value" ], @@ -4352,7 +4204,61 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ShareSubscription" + "$ref": "#/definitions/Share" + } + } + } + }, + "ShareSubscriptionSynchronization": { + "description": "A ShareSubscriptionSynchronization data transfer object.", + "required": [ + "synchronizationId" + ], + "type": "object", + "properties": { + "durationMs": { + "format": "int32", + "description": "Synchronization duration", + "type": "integer", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "End time of synchronization", + "type": "string", + "readOnly": true + }, + "message": { + "description": "message of Synchronization", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "start time of synchronization", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Raw Status", + "type": "string", + "readOnly": true + }, + "synchronizationId": { + "description": "Synchronization id", + "type": "string" + }, + "synchronizationMode": { + "description": "Synchronization Mode", + "enum": [ + "Incremental", + "FullSync" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "synchronizationMode", + "modelAsString": true } } } @@ -4506,74 +4412,168 @@ } } }, - "ShareSubscriptionSynchronization": { - "description": "A ShareSubscriptionSynchronization data transfer object.", + "Synchronize": { + "description": "Payload for the synchronizing the data.", + "type": "object", + "properties": { + "synchronizationMode": { + "description": "Mode of synchronization used in triggers and snapshot sync. Incremental by default", + "enum": [ + "Incremental", + "FullSync" + ], + "type": "string", + "x-ms-enum": { + "name": "synchronizationMode", + "modelAsString": true + } + } + } + }, + "ShareSubscription": { + "description": "A share subscription data transfer object.", "required": [ - "synchronizationId" + "properties" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyDto" + } + ], "properties": { - "durationMs": { - "format": "int32", - "description": "Synchronization duration", - "type": "integer", + "properties": { + "$ref": "#/definitions/ShareSubscriptionProperties", + "description": "Properties on the share subscription", + "x-ms-client-flatten": true + } + } + }, + "ShareSubscriptionProperties": { + "description": "Share subscription property bag.", + "required": [ + "invitationId", + "sourceShareLocation" + ], + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "description": "Time at which the share subscription was created.", + "type": "string", "readOnly": true }, - "endTime": { - "format": "date-time", - "description": "End time of synchronization", + "invitationId": { + "description": "The invitation id.", + "type": "string" + }, + "providerEmail": { + "description": "Email of the provider who created the resource", "type": "string", "readOnly": true }, - "message": { - "description": "message of Synchronization", + "providerName": { + "description": "Name of the provider who created the resource", "type": "string", "readOnly": true }, - "startTime": { - "format": "date-time", - "description": "start time of synchronization", + "providerTenantName": { + "description": "Tenant name of the provider who created the resource", "type": "string", "readOnly": true }, - "status": { - "description": "Raw Status", + "provisioningState": { + "description": "Provisioning state of the share subscription", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "shareDescription": { + "description": "Description of share", "type": "string", "readOnly": true }, - "synchronizationId": { - "description": "Synchronization id", - "type": "string" + "shareKind": { + "description": "Kind of share", + "enum": [ + "CopyBased", + "InPlace" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "shareKind", + "modelAsString": true + } }, - "synchronizationMode": { - "description": "Synchronization Mode", + "shareName": { + "description": "Name of the share", + "type": "string", + "readOnly": true + }, + "shareSubscriptionStatus": { + "description": "Gets the current status of share subscription.", "enum": [ - "Incremental", - "FullSync" + "Active", + "Revoked", + "SourceDeleted", + "Revoking" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "synchronizationMode", + "name": "shareSubscriptionStatus", "modelAsString": true } + }, + "shareTerms": { + "description": "Terms of a share", + "type": "string", + "readOnly": true + }, + "sourceShareLocation": { + "description": "Source share location.", + "type": "string" + }, + "userEmail": { + "description": "Email of the user who created the resource", + "type": "string", + "readOnly": true + }, + "userName": { + "description": "Name of the user who created the resource", + "type": "string", + "readOnly": true } } }, - "Synchronize": { - "description": "Payload for the synchronizing the data.", + "ShareSubscriptionList": { + "description": "List response for get ShareSubscription.", + "required": [ + "value" + ], "type": "object", "properties": { - "synchronizationMode": { - "description": "Mode of synchronization used in triggers and snapshot sync. Incremental by default", - "enum": [ - "Incremental", - "FullSync" - ], - "type": "string", - "x-ms-enum": { - "name": "synchronizationMode", - "modelAsString": true + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ShareSubscription" } } }