DataShareManagementClient
Creates a Microsoft
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"description": "Creates a Microsoft.DataShare management client.",
"title": "DataShareManagementClient",
"version": "2019-11-01",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json",
"version": "2.0"
}
],
"x-preferred": true,
"x-providerName": "azure.com",
"x-serviceName": "datashare-DataShare",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 Flow.",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"parameters": {
"accountName": {
"description": "The name of the share account.",
"in": "path",
"name": "accountName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"api-version": {
"description": "The api version to use.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
"resourceGroupName": {
"description": "The resource group name.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"subscriptionId": {
"description": "The subscription identifier",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
}
},
"tags": [],
"paths": {
"/providers/Microsoft.DataShare/ListInvitations": {
"get": {
"description": "Lists invitations",
"operationId": "ConsumerInvitations_ListInvitations",
"parameters": [
{
"$ref": "#/parameters/api-version"
},
{
"description": "The continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ConsumerInvitationList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List the invitations",
"tags": [
"ConsumerInvitation"
],
"x-ms-examples": {
"ConsumerInvitations_ListInvitations": {
"parameters": {
"api-version": "2019-11-01"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487",
"name": "invitation1",
"properties": {
"dataSetCount": 1,
"description": "Some share",
"invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
"invitationStatus": "Accepted",
"location": "eastus2",
"providerEmail": "john.smith@microsoft.com",
"providerName": "John Smith",
"providerTenantName": "microsoft",
"respondedAt": "2019-01-15T02:01:51.8953054Z",
"sentAt": "2019-01-15T01:45:25.6226946Z",
"shareName": "share1",
"termsOfUse": "Confidential"
},
"type": "Microsoft.DataShare/consumerInvitations"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.DataShare/locations/{location}/RejectInvitation": {
"post": {
"description": "Reject an invitation",
"operationId": "ConsumerInvitations_RejectInvitation",
"parameters": [
{
"description": "Location of the invitation",
"in": "path",
"name": "location",
"required": true,
"type": "string"
},
{
"description": "An invitation payload",
"in": "body",
"name": "invitation",
"required": true,
"schema": {
"$ref": "#/definitions/ConsumerInvitation"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ConsumerInvitation"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Rejects the invitation identified by invitationId",
"tags": [
"ConsumerInvitation"
],
"x-ms-examples": {
"ConsumerInvitations_RejectInvitation": {
"parameters": {
"api-version": "2019-11-01",
"invitation": {
"properties": {
"invitationId": "dfbbc788-19eb-4607-a5a1-c74181bfff03"
}
},
"location": "East US 2"
},
"responses": {
"200": {
"body": {
"id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487",
"name": "invitation1",
"properties": {
"dataSetCount": 1,
"description": "Some share",
"invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
"invitationStatus": "Rejected",
"location": "eastus2",
"providerEmail": "john.smith@microsoft.com",
"providerName": "John Smith",
"providerTenantName": "microsoft",
"respondedAt": "2019-01-15T02:01:51.8953054Z",
"sentAt": "2019-01-15T01:45:25.6226946Z",
"shareName": "share1",
"termsOfUse": "Confidential"
},
"type": "Microsoft.DataShare/consumerInvitations"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
}
},
"/providers/Microsoft.DataShare/locations/{location}/consumerInvitations/{invitationId}": {
"get": {
"description": "Get an invitation",
"operationId": "ConsumerInvitations_Get",
"parameters": [
{
"description": "Location of the invitation",
"in": "path",
"name": "location",
"required": true,
"type": "string"
},
{
"description": "An invitation id",
"in": "path",
"name": "invitationId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ConsumerInvitation"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Gets the invitation identified by invitationId",
"tags": [
"ConsumerInvitation"
],
"x-ms-examples": {
"ConsumerInvitations_Get": {
"parameters": {
"api-version": "2019-11-01",
"invitationId": "dfbbc788-19eb-4607-a5a1-c74181bfff03",
"location": "East US 2"
},
"responses": {
"200": {
"body": {
"id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487",
"name": "invitation1",
"properties": {
"dataSetCount": 1,
"description": "Some share",
"invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
"invitationStatus": "Accepted",
"location": "eastus2",
"providerEmail": "john.smith@microsoft.com",
"providerName": "John Smith",
"providerTenantName": "Microsoft",
"respondedAt": "2019-01-15T02:01:51.8953054Z",
"sentAt": "2019-01-15T01:45:25.6226946Z",
"shareName": "share1",
"termsOfUse": "Confidential"
},
"type": "Microsoft.DataShare/consumerInvitations"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
}
},
"/providers/Microsoft.DataShare/operations": {
"get": {
"description": "List of available operations",
"operationId": "Operations_List",
"parameters": [
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/OperationList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Lists the available operations",
"tags": [
"Operation"
],
"x-ms-examples": {
"Operations_List": {
"parameters": {
"api-version": "2019-11-01",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"value": [
{
"display": {
"description": "Reads all available operations in Data Share Resource Provider.",
"operation": "Read all operations",
"provider": "Microsoft Data Share",
"resource": "Data Share Resource Provider"
},
"name": "Microsoft.DataShare/operations/read"
},
{
"display": {
"description": "Register the subscription for the Data Share Resource Provider.",
"operation": "Register Data Share Resource Provider",
"provider": "Microsoft Data Share",
"resource": "Data Share Resource Provider"
},
"name": "Microsoft.DataShare/register/action"
},
{
"display": {
"description": "Unregister the subscription for the Data Share Resource Provider.",
"operation": "Unregister Data Share Resource Provider",
"provider": "Microsoft Data Share",
"resource": "Data Share Resource Provider"
},
"name": "Microsoft.DataShare/unregister/action"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.DataShare/accounts": {
"get": {
"description": "List Accounts in Subscription",
"operationId": "Accounts_ListBySubscription",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation token",
"in": "query",
"name": "$skipToken",
"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"
}
}
},
"summary": "List Accounts in a subscription",
"tags": [
"Account"
],
"x-ms-examples": {
"Accounts_ListBySubscription": {
"parameters": {
"api-version": "2019-11-01",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1",
"identity": {
"type": "SystemAssigned"
},
"location": "West US 2",
"name": "Account1",
"properties": {
"createdAt": "2018-11-14T04:47:52.9614956Z",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"tags": {
"tag1": "Red",
"tag2": "White"
},
"type": "Microsoft.DataShare/Accounts"
},
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account2",
"identity": {
"type": "SystemAssigned"
},
"location": "East US 2",
"name": "Account2",
"properties": {
"createdAt": "2018-11-14T04:47:52.9614956Z",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Accounts"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts": {
"get": {
"description": "List Accounts in ResourceGroup",
"operationId": "Accounts_ListByResourceGroup",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation token",
"in": "query",
"name": "$skipToken",
"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"
}
}
},
"summary": "List Accounts in a resource group",
"tags": [
"Account"
],
"x-ms-examples": {
"Accounts_ListByResourceGroup": {
"parameters": {
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1",
"identity": {
"type": "SystemAssigned"
},
"location": "West US 2",
"name": "Account1",
"properties": {
"createdAt": "2018-11-14T04:47:52.9614956Z",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith,"
},
"tags": {
"tag1": "Red",
"tag2": "White"
},
"type": "Microsoft.DataShare/Accounts"
},
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account2",
"identity": {
"type": "SystemAssigned"
},
"location": "East US 2",
"name": "Account2",
"properties": {
"createdAt": "2018-11-14T04:47:52.9614956Z",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith,"
},
"type": "Microsoft.DataShare/Accounts"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}": {
"delete": {
"description": "DeleteAccount",
"operationId": "Accounts_Delete",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"$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"
}
}
},
"summary": "Delete an account",
"tags": [
"Account"
],
"x-ms-examples": {
"Accounts_Delete": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"status": "Succeeded"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/sourceAccount/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview",
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-long-running-operation": true,
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"204": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"description": "Get an account",
"operationId": "Accounts_Get",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Account"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Get an account under a resource group",
"tags": [
"Account"
],
"x-ms-examples": {
"Accounts_Get": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1",
"identity": {
"type": "SystemAssigned"
},
"location": "West US 2",
"name": "Account1",
"properties": {
"createdAt": "2018-11-14T04:47:52.9614956Z",
"provisioningState": "Succeeded",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"tags": {
"tag1": "Red",
"tag2": "White"
},
"type": "Microsoft.DataShare/Accounts"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"patch": {
"description": "Patch an account",
"operationId": "Accounts_Update",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The account update parameters.",
"in": "body",
"name": "accountUpdateParameters",
"required": true,
"schema": {
"$ref": "#/definitions/AccountUpdateParameters"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Account"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Patch a given account",
"tags": [
"Account"
],
"x-ms-examples": {
"Accounts_Update": {
"parameters": {
"accountName": "Account1",
"accountUpdateParameters": {
"tags": {
"tag1": "Red",
"tag2": "White"
}
},
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1",
"identity": {
"type": "SystemAssigned"
},
"location": "West US 2",
"name": "Account1",
"properties": {
"createdAt": "2018-11-14T04:47:52.9614956Z",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"tags": {
"tag1": "Red",
"tag2": "White"
},
"type": "Microsoft.DataShare/Accounts"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"put": {
"description": "Create an account",
"operationId": "Accounts_Create",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The account payload.",
"in": "body",
"name": "account",
"required": true,
"schema": {
"$ref": "#/definitions/Account"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Account"
}
},
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Account"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Create an account in the given resource group",
"tags": [
"Account"
],
"x-ms-examples": {
"Accounts_Create": {
"parameters": {
"account": {
"identity": {
"type": "SystemAssigned"
},
"location": "West US 2",
"tags": {
"tag1": "Red",
"tag2": "White"
}
},
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1",
"identity": {
"type": "SystemAssigned"
},
"location": "West US 2",
"name": "Account1",
"properties": {
"createdAt": "2018-11-14T04:47:52.9614956Z",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"tags": {
"tag1": "Red",
"tag2": "White"
},
"type": "Microsoft.DataShare/Accounts"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1",
"identity": {
"type": "SystemAssigned"
},
"location": "West US 2",
"name": "Account1",
"properties": {
"createdAt": "2018-11-14T04:47:52.9614956Z",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"tags": {
"tag1": "Red",
"tag2": "White"
},
"type": "Microsoft.DataShare/Accounts"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions": {
"get": {
"description": "List share subscriptions in an account",
"operationId": "ShareSubscriptions_ListByAccount",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation Token",
"in": "query",
"name": "$skipToken",
"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"
}
}
},
"summary": "List of available share subscriptions under an account.",
"tags": [
"ShareSubscription"
],
"x-ms-examples": {
"ShareSubscriptions_ListByAccount": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1",
"name": "ShareSubscription1",
"properties": {
"createdAt": "2018-11-14T06:15:15.6818898Z",
"invitationId": "12345678-1234-1234-12345678abd",
"providerEmail": "jack.rose@microsoft.com",
"providerName": "Jack Rose",
"providerTenantName": "Microsoft",
"shareDescription": "Some share",
"shareKind": "CopyBased",
"shareName": "share1",
"shareSubscriptionStatus": "Active",
"shareTerms": "Confidential",
"sourceShareLocation": "eastus2",
"userEmail": "john.smith@microsoft.com",
"userName": "johnsmith@microsoft.com"
},
"type": "Microsoft.DataShare/ShareSubscription"
},
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1",
"name": "ShareSubscription1",
"properties": {
"createdAt": "2019-01-17T22:32:36.8185016Z",
"invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
"providerEmail": "jack.rose@microsoft.com",
"providerName": "Jack Rose",
"providerTenantName": "Microsoft",
"shareDescription": "Some share",
"shareKind": "CopyBased",
"shareName": "share1",
"shareSubscriptionStatus": "Active",
"shareTerms": "Confidential",
"sourceShareLocation": "eastus2",
"userEmail": "john.smith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/ShareSubscription"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}": {
"delete": {
"description": "Delete a shareSubscription in an account",
"operationId": "ShareSubscriptions_Delete",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the shareSubscription.",
"in": "path",
"name": "shareSubscriptionName",
"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"
}
}
},
"summary": "Delete shareSubscription in an account.",
"tags": [
"ShareSubscription"
],
"x-ms-examples": {
"ShareSubscriptions_Delete": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"status": "Succeeded"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/consumerAccount/shareSubscriptions/shareSub1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview",
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-long-running-operation": true,
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"204": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"description": "Get a shareSubscription in an account",
"operationId": "ShareSubscriptions_Get",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the shareSubscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"$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"
}
}
},
"summary": "Get shareSubscription in an account.",
"tags": [
"ShareSubscription"
],
"x-ms-examples": {
"ShareSubscriptions_Get": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1",
"name": "ShareSubscription1",
"properties": {
"createdAt": "2019-01-17T22:32:36.8185016Z",
"invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
"providerEmail": "jack.rose@microsoft.com",
"providerName": "Jack Rose",
"providerTenantName": "ShareSenderCompanyName",
"provisioningState": "Succeeded",
"shareDescription": "Some share",
"shareKind": "CopyBased",
"shareName": "share1",
"shareSubscriptionStatus": "Active",
"shareTerms": "Confidential",
"sourceShareLocation": "eastus2",
"userEmail": "john.smith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/ShareSubscription"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"put": {
"description": "Create a shareSubscription in an account",
"operationId": "ShareSubscriptions_Create",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the shareSubscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "create parameters for shareSubscription",
"in": "body",
"name": "shareSubscription",
"required": true,
"schema": {
"$ref": "#/definitions/ShareSubscription"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ShareSubscription"
}
},
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ShareSubscription"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Create shareSubscription in an account.",
"tags": [
"ShareSubscription"
],
"x-ms-examples": {
"ShareSubscriptions_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscription": {
"properties": {
"invitationId": "12345678-1234-1234-12345678abd",
"sourceShareLocation": "eastus2"
}
},
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1",
"name": "ShareSubscription1",
"properties": {
"createdAt": "2019-01-17T22:32:36.8185016Z",
"invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
"providerEmail": "jack.rose@microsoft.com",
"providerName": "Jack Rose",
"providerTenantName": "Microsoft",
"shareDescription": "Some share",
"shareKind": "CopyBased",
"shareName": "share1",
"shareSubscriptionStatus": "Active",
"shareTerms": "Confidential",
"sourceShareLocation": "eastus2",
"userEmail": "john.smith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/ShareSubscription"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1",
"name": "ShareSubscription1",
"properties": {
"createdAt": "2019-01-17T22:32:36.8185016Z",
"invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
"providerEmail": "jack.rose@microsoft.com",
"providerName": "Jack Rose",
"providerTenantName": "Microsoft",
"shareDescription": "Some share",
"shareKind": "CopyBased",
"shareName": "share1",
"shareSubscriptionStatus": "Active",
"shareTerms": "Confidential",
"sourceShareLocation": "eastus2",
"userEmail": "john.smith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/ShareSubscription"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/ConsumerSourceDataSets": {
"get": {
"description": "Get source dataSets of a shareSubscription",
"operationId": "ConsumerSourceDataSets_ListByShareSubscription",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the shareSubscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ConsumerSourceDataSetList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Get source dataSets of a shareSubscription.",
"tags": [
"ShareSubscription"
],
"x-ms-examples": {
"ConsumerSourceDataSets_ListByShareSubscription": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "Share1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1/consumerSourceDataSets/4256e2cf-0f82-4865-961b-12f83333f487",
"name": "invitation1",
"properties": {
"dataSetId": "0b9d4394-8bb3-49a1-aa4f-4be49cd10375",
"dataSetName": "input.text",
"dataSetPath": "cars.text",
"dataSetType": "Blob"
},
"type": "Microsoft.DataShare/consumerSourceDataSets"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/Synchronize": {
"post": {
"description": "Initiate a copy",
"operationId": "ShareSubscriptions_Synchronize",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of share subscription",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "Synchronize payload",
"in": "body",
"name": "synchronize",
"required": true,
"schema": {
"$ref": "#/definitions/Synchronize"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ShareSubscriptionSynchronization"
}
},
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/ShareSubscriptionSynchronization"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Initiate an asynchronous data share job",
"tags": [
"ShareSubscription"
],
"x-ms-examples": {
"ShareSubscriptions_Synchronize": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "12345678-1234-1234-12345678abc",
"synchronize": {
"synchronizationMode": "Incremental"
}
},
"responses": {
"200": {
"body": {
"startTime": "2019-06-30T02:37:48.4979104Z",
"status": "Succeeded",
"synchronizationId": "343c4772-ad68-41aa-91b9-bab1c92f9c27"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"202": {
"body": {
"startTime": "2019-06-30T02:37:48.4979104Z",
"status": "Accepted",
"synchronizationId": "343c4772-ad68-41aa-91b9-bab1c92f9c27"
},
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/consumerAccount/shareSubscriptions/shareSub1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview",
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-long-running-operation": true,
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/cancelSynchronization": {
"post": {
"description": "Request to cancel a synchronization.",
"operationId": "ShareSubscriptions_CancelSynchronization",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the shareSubscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "Share Subscription Synchronization payload.",
"in": "body",
"name": "shareSubscriptionSynchronization",
"required": true,
"schema": {
"$ref": "#/definitions/ShareSubscriptionSynchronization"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ShareSubscriptionSynchronization"
}
},
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/ShareSubscriptionSynchronization"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Request cancellation of a data share snapshot",
"tags": [
"ShareSubscription"
],
"x-ms-examples": {
"ShareSubscriptions_CancelSynchronization": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"shareSubscriptionSynchronization": {
"synchronizationId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"
},
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"startTime": "2019-06-30T02:37:48.4979104Z",
"status": "Cancelled",
"synchronizationId": "343c4772-ad68-41aa-91b9-bab1c92f9c27"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"202": {
"body": {
"startTime": "2019-06-30T02:37:48.4979104Z",
"status": "Queued",
"synchronizationId": "343c4772-ad68-41aa-91b9-bab1c92f9c27"
},
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/consumerAccount/shareSubscriptions/shareSub1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview",
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-long-running-operation": true,
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings": {
"get": {
"description": "List DataSetMappings in a share subscription",
"operationId": "DataSetMappings_ListByShareSubscription",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share subscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/DataSetMappingList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List DataSetMappings in a share subscription.",
"tags": [
"DataSetMapping"
],
"x-ms-examples": {
"DataSetMappings_ListByShareSubscription": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "Blob",
"name": "DatasetMapping1",
"properties": {
"containerName": "C1",
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"filePath": "file21",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSetMapping"
},
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "Blob",
"name": "DatasetMapping1",
"properties": {
"containerName": "C1",
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d227",
"filePath": "file21",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSetMapping"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings/{dataSetMappingName}": {
"delete": {
"description": "Delete a DataSetMapping in a shareSubscription",
"operationId": "DataSetMappings_Delete",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the shareSubscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "The name of the dataSetMapping.",
"in": "path",
"name": "dataSetMappingName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success"
},
"204": {
"description": "Success"
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Delete DataSetMapping in a shareSubscription.",
"tags": [
"DataSetMapping"
],
"x-ms-examples": {
"DataSetMappings_Delete": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSetMappingName": "DatasetMapping1",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"204": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"get": {
"description": "Get a DataSetMapping in a shareSubscription",
"operationId": "DataSetMappings_Get",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the shareSubscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "The name of the dataSetMapping.",
"in": "path",
"name": "dataSetMappingName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/DataSetMapping"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Get DataSetMapping in a shareSubscription.",
"tags": [
"DataSetMapping"
],
"x-ms-examples": {
"DataSetMappings_Get": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSetMappingName": "DatasetMapping1",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "Blob",
"name": "DatasetMapping1",
"properties": {
"containerName": "C1",
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"filePath": "file21",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSetMapping"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"put": {
"description": "Create a DataSetMapping ",
"operationId": "DataSetMappings_Create",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share subscription which will hold the data set sink.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "The name of the data set mapping to be created.",
"in": "path",
"name": "dataSetMappingName",
"required": true,
"type": "string"
},
{
"description": "Destination data set configuration details.",
"in": "body",
"name": "dataSetMapping",
"required": true,
"schema": {
"$ref": "#/definitions/DataSetMapping"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/DataSetMapping"
}
},
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/DataSetMapping"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Maps a source data set in the source share to a sink data set in the share subscription.\r\nEnables copying the data set from source to destination.",
"tags": [
"DataSetMapping"
],
"x-ms-examples": {
"DataSetMappings_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSetMapping": {
"kind": "Blob",
"properties": {
"containerName": "C1",
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"filePath": "file21",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
}
},
"dataSetMappingName": "DatasetMapping1",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "Blob",
"name": "DatasetMapping1",
"properties": {
"containerName": "C1",
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"filePath": "file21",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSetMapping"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "Blob",
"name": "DatasetMapping1",
"properties": {
"containerName": "C1",
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d227",
"filePath": "file21",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSetMapping"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
},
"DataSetMappings_SqlDB_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSetMapping": {
"kind": "SqlDBTable",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"databaseName": "Database1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
}
},
"dataSetMappingName": "DatasetMapping1",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "SqlDBTable",
"name": "DatasetMapping1",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"databaseName": "Database1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
},
"type": "Microsoft.DataShare/DataSetMapping"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "SqlDBTable",
"name": "DatasetMapping1",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"databaseName": "Database1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
},
"type": "Microsoft.DataShare/DataSetMapping"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
},
"DataSetMappings_SqlDWDataSetToAdlsGen2File_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSetMapping": {
"kind": "AdlsGen2File",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"filePath": "file21",
"fileSystem": "fileSystem",
"outputType": "Csv",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
}
},
"dataSetMappingName": "DatasetMapping1",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "AdlsGen2File",
"name": "DatasetMapping1",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"filePath": "file21",
"fileSystem": "fileSystem",
"outputType": "Csv",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSetMapping"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "AdlsGen2File",
"name": "DatasetMapping1",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"filePath": "file21",
"fileSystem": "fileSystem",
"outputType": "Csv",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSetMapping"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
},
"DataSetMappings_SqlDW_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSetMapping": {
"kind": "SqlDWTable",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"dataWarehouseName": "DataWarehouse1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
}
},
"dataSetMappingName": "DatasetMapping1",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "SqlDWTable",
"name": "DatasetMapping1",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"dataWarehouseName": "DataWarehouse1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
},
"type": "Microsoft.DataShare/DataSetMapping"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/dataSetMappings/DatasetMapping1",
"kind": "SqlDWTable",
"name": "DatasetMapping1",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"dataWarehouseName": "DataWarehouse1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
},
"type": "Microsoft.DataShare/DataSetMapping"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSourceShareSynchronizationSettings": {
"post": {
"description": "Get synchronization settings set on a share",
"operationId": "ShareSubscriptions_ListSourceShareSynchronizationSettings",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the shareSubscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/SourceShareSynchronizationSettingList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Get source share synchronization settings for a shareSubscription.",
"tags": [
"ShareSubscription"
],
"x-ms-examples": {
"ShareSubscriptions_ListSourceShareSynchronizationSettings": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSub1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"value": [
{
"kind": "ScheduleBased",
"properties": {
"recurrenceInterval": "Hour",
"synchronizationTime": "2019-03-15T19:45:58Z"
}
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails": {
"post": {
"description": "List synchronization details",
"operationId": "ShareSubscriptions_ListSynchronizationDetails",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share subscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "Share Subscription Synchronization payload.",
"in": "body",
"name": "shareSubscriptionSynchronization",
"required": true,
"schema": {
"$ref": "#/definitions/ShareSubscriptionSynchronization"
}
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/SynchronizationDetailsList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List data set level details for a share subscription synchronization",
"tags": [
"ShareSubscription"
],
"x-ms-examples": {
"ShareSubscriptions_ListSynchronizationDetails": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSub1",
"shareSubscriptionSynchronization": {
"synchronizationId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"
},
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"value": [
{
"dataSetId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb",
"dataSetType": "Blob",
"durationMs": 2000,
"endTime": "2018-11-14T04:47:52.9614956Z",
"name": "dataset1",
"startTime": "2018-11-14T04:47:52.9614956Z",
"status": "Completed"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizations": {
"post": {
"description": "List synchronizations of a share subscription",
"operationId": "ShareSubscriptions_ListSynchronizations",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share subscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ShareSubscriptionSynchronizationList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List Synchronizations in a share subscription.",
"tags": [
"ShareSubscription"
],
"x-ms-examples": {
"ShareSubscriptions_ListSynchronizations": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSub1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"value": [
{
"durationMs": 2000,
"endTime": "2018-11-14T04:47:52.9614956Z",
"message": "nda",
"startTime": "2018-11-14T04:47:52.9614956Z",
"status": "Completed",
"synchronizationId": "runId",
"synchronizationMode": "Incremental"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/triggers": {
"get": {
"description": "List Triggers in a share subscription",
"operationId": "Triggers_ListByShareSubscription",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share subscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/TriggerList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List Triggers in a share subscription.",
"tags": [
"Trigger"
],
"x-ms-examples": {
"Triggers_ListByShareSubscription": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a",
"triggerName": "Trigger1"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/triggers/Trigger1",
"kind": "ScheduleBased",
"name": "Trigger1",
"properties": {
"provisioningState": "Succeeded",
"recurrenceInterval": "Day",
"synchronizationMode": "Incremental",
"synchronizationTime": "2018-11-14T04:47:52.9614956Z",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Trigger"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/triggers/{triggerName}": {
"delete": {
"description": "Delete a Trigger in a shareSubscription",
"operationId": "Triggers_Delete",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the shareSubscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "The name of the trigger.",
"in": "path",
"name": "triggerName",
"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"
}
}
},
"summary": "Delete Trigger in a shareSubscription.",
"tags": [
"Trigger"
],
"x-ms-examples": {
"Triggers_Delete": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a",
"triggerName": "Trigger1"
},
"responses": {
"200": {
"body": {
"status": "Succeeded"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/consumerAccount/shareSubscriptions/shareSub1/triggers/trigger1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview",
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888",
"x-ms-retry-after-ms": "30"
}
},
"204": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"description": "Get a Trigger in a shareSubscription",
"operationId": "Triggers_Get",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the shareSubscription.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "The name of the trigger.",
"in": "path",
"name": "triggerName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Trigger"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Get Trigger in a shareSubscription.",
"tags": [
"Trigger"
],
"x-ms-examples": {
"Triggers_Get": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a",
"triggerName": "Trigger1"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/triggers/Trigger1",
"kind": "ScheduleBased",
"name": "Trigger1",
"properties": {
"provisioningState": "Succeeded",
"recurrenceInterval": "Day",
"synchronizationMode": "Incremental",
"synchronizationTime": "2018-11-14T04:47:52.9614956Z",
"triggerStatus": "Active",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Trigger"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"put": {
"description": "Create a Trigger ",
"operationId": "Triggers_Create",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share subscription which will hold the data set sink.",
"in": "path",
"name": "shareSubscriptionName",
"required": true,
"type": "string"
},
{
"description": "The name of the trigger.",
"in": "path",
"name": "triggerName",
"required": true,
"type": "string"
},
{
"description": "Trigger details.",
"in": "body",
"name": "trigger",
"required": true,
"schema": {
"$ref": "#/definitions/Trigger"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Trigger"
}
},
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Trigger"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "This method creates a trigger for a share subscription",
"tags": [
"Trigger"
],
"x-ms-examples": {
"Triggers_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareSubscriptionName": "ShareSubscription1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a",
"trigger": {
"kind": "ScheduleBased",
"properties": {
"recurrenceInterval": "Day",
"synchronizationMode": "Incremental",
"synchronizationTime": "2018-11-14T04:47:52.9614956Z"
}
},
"triggerName": "Trigger1"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/triggers/Trigger1",
"kind": "ScheduleBased",
"name": "Trigger1",
"properties": {
"provisioningState": "Succeeded",
"recurrenceInterval": "Day",
"synchronizationMode": "Incremental",
"synchronizationTime": "2018-11-14T04:47:52.9614956Z",
"triggerStatus": "Active",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Trigger"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/triggers/Trigger1",
"kind": "ScheduleBased",
"name": "Trigger1",
"properties": {
"provisioningState": "Creating",
"recurrenceInterval": "Day",
"synchronizationMode": "Incremental",
"synchronizationTime": "2018-11-14T04:47:52.9614956Z",
"triggerStatus": "Active",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Trigger"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-long-running-operation": true,
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares": {
"get": {
"description": "List shares in an account",
"operationId": "Shares_ListByAccount",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation Token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ShareList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List of available shares under an account.",
"tags": [
"Share"
],
"x-ms-examples": {
"Shares_ListByAccount": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1",
"name": "Share1",
"properties": {
"createdAt": "2018-11-14T06:15:15.6818898Z",
"description": "share description",
"shareKind": "CopyBased",
"terms": "Confidential",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Share"
},
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1",
"name": "Share1",
"properties": {
"createdAt": "2018-11-14T06:15:15.6818898Z",
"description": "share description",
"shareKind": "CopyBased",
"terms": "Confidential",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Share"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}": {
"delete": {
"description": "Delete a share ",
"operationId": "Shares_Delete",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"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"
}
}
},
"summary": "Deletes a share",
"tags": [
"Share"
],
"x-ms-examples": {
"Shares_Delete": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"status": "Succeeded"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/consumerAccount/shareSubscriptions/shareSub1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview",
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-long-running-operation": true,
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"204": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"description": "Get a share ",
"operationId": "Shares_Get",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share to retrieve.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Share"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Get a specified share",
"tags": [
"Share"
],
"x-ms-examples": {
"Shares_Get": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1",
"name": "Share1",
"properties": {
"createdAt": "2018-11-14T06:15:15.6818898Z",
"description": "share description",
"shareKind": "CopyBased",
"terms": "Confidential",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Share"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"put": {
"description": "Create a share ",
"operationId": "Shares_Create",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "The share payload",
"in": "body",
"name": "share",
"required": true,
"schema": {
"$ref": "#/definitions/Share"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Share"
}
},
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Share"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Create a share in the given account.",
"tags": [
"Share"
],
"x-ms-examples": {
"Shares_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"share": {
"properties": {
"description": "share description",
"shareKind": "CopyBased",
"terms": "Confidential"
}
},
"shareName": "Share1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1",
"name": "Share1",
"properties": {
"createdAt": "2018-11-14T06:15:15.6818898Z",
"description": "share description",
"shareKind": "CopyBased",
"terms": "Confidential",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Share"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1",
"name": "Share1",
"properties": {
"createdAt": "2018-11-14T06:15:15.6818898Z",
"description": "share description",
"shareKind": "CopyBased",
"terms": "Confidential",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Share"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets": {
"get": {
"description": "List DataSets in a share",
"operationId": "DataSets_ListByShare",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/DataSetList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List DataSets in a share.",
"tags": [
"DataSet"
],
"x-ms-examples": {
"DataSets_ListByShare": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "Blob",
"name": "Dataset1",
"properties": {
"containerName": "C1",
"filePath": "file22",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSet"
},
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset2",
"kind": "Blob",
"name": "Dataset1",
"properties": {
"containerName": "C1",
"filePath": "file21",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSet"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets/{dataSetName}": {
"delete": {
"description": "Delete a DataSet in a share",
"operationId": "DataSets_Delete",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "The name of the dataSet.",
"in": "path",
"name": "dataSetName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success"
},
"202": {
"description": "Accepted"
},
"204": {
"description": "Success"
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Delete DataSet in a share.",
"tags": [
"DataSet"
],
"x-ms-examples": {
"DataSets_Delete": {
"parameters": {
"accountName": "Account1",
"api-version": "2018-11-01-preview",
"dataSetName": "Dataset1",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview",
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-long-running-operation": true,
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"204": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"description": "Get a DataSet in a share",
"operationId": "DataSets_Get",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "The name of the dataSet.",
"in": "path",
"name": "dataSetName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/DataSet"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Get DataSet in a share.",
"tags": [
"DataSet"
],
"x-ms-examples": {
"DataSets_Get": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSetName": "Dataset1",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "Blob",
"name": "Dataset1",
"properties": {
"containerName": "C1",
"filePath": "file21",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSet"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"put": {
"description": "Create a DataSet ",
"operationId": "DataSets_Create",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share to add the data set to.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "The name of the dataSet.",
"in": "path",
"name": "dataSetName",
"required": true,
"type": "string"
},
{
"description": "The new data set information.",
"in": "body",
"name": "dataSet",
"required": true,
"schema": {
"$ref": "#/definitions/DataSet"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/DataSet"
}
},
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/DataSet"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Adds a new data set to an existing share or updates it if existing.",
"tags": [
"DataSet"
],
"x-ms-examples": {
"DataSets_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSet": {
"kind": "Blob",
"properties": {
"containerName": "C1",
"filePath": "file21",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
}
},
"dataSetName": "Dataset1",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "Blob",
"name": null,
"properties": {
"containerName": "C1",
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"filePath": "inputpath",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "adspipelinemetadatatable",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSets"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "Blob",
"name": "Dataset1",
"properties": {
"containerName": "C1",
"filePath": "file21",
"resourceGroup": "SampleResourceGroup",
"storageAccountName": "storage2",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"type": "Microsoft.DataShare/DataSet"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
},
"DataSets_KustoCluster_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSet": {
"kind": "KustoCluster",
"properties": {
"kustoClusterResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1"
}
},
"dataSetName": "Dataset1",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "KustoCluster",
"name": null,
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"kustoClusterResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1",
"location": "West US 2"
},
"type": "Microsoft.DataShare/DataSets"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "KustoCluster",
"name": "Dataset1",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"kustoClusterResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1",
"location": "West US 2"
},
"type": "Microsoft.DataShare/DataSet"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
},
"DataSets_KustoDatabase_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSet": {
"kind": "KustoDatabase",
"properties": {
"kustoDatabaseResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1/databases/Database1"
}
},
"dataSetName": "Dataset1",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "KustoDatabase",
"name": null,
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"kustoDatabaseResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1/databases/Database1",
"location": "West US 2"
},
"type": "Microsoft.DataShare/DataSets"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "KustoDatabase",
"name": "Dataset1",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"kustoDatabaseResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Kusto/clusters/Cluster1/databases/Database1",
"location": "West US 2"
},
"type": "Microsoft.DataShare/DataSet"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
},
"DataSets_SqlDBTable_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSet": {
"kind": "SqlDBTable",
"properties": {
"databaseName": "SqlDB1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
}
},
"dataSetName": "Dataset1",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "SqlDBTable",
"name": null,
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"databaseName": "SqlDB1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
},
"type": "Microsoft.DataShare/DataSets"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "SqlDBTable",
"name": "Dataset1",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"databaseName": "SqlDB1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
},
"type": "Microsoft.DataShare/DataSet"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
},
"DataSets_SqlDWTable_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"dataSet": {
"kind": "SqlDWTable",
"properties": {
"dataWarehouseName": "DataWarehouse1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
}
},
"dataSetName": "Dataset1",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "SqlDWTable",
"name": null,
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"dataWarehouseName": "DataWarehouse1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
},
"type": "Microsoft.DataShare/DataSets"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/datasets/Dataset1",
"kind": "SqlDWTable",
"name": "Dataset1",
"properties": {
"dataSetId": "a08f184b-0567-4b11-ba22-a1199336d226",
"dataWarehouseName": "DataWarehouse1",
"schemaName": "dbo",
"sqlServerResourceId": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.Sql/servers/Server1",
"tableName": "Table1"
},
"type": "Microsoft.DataShare/DataSet"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations": {
"get": {
"description": "List invitations in a share",
"operationId": "Invitations_ListByShare",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "The continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/InvitationList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List all Invitations in a share.",
"tags": [
"Invitation"
],
"x-ms-examples": {
"Invitations_ListByShare": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/account1/shares/share1/invitations/ancd",
"name": "ancd",
"properties": {
"invitationStatus": "Accepted",
"sentAt": "2018-11-26T22:33:24.5785265Z",
"targetEmail": "johnsmith@microsoft.com",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Invitation"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}": {
"delete": {
"description": "Delete an invitation in a share",
"operationId": "Invitations_Delete",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "The name of the invitation.",
"in": "path",
"name": "invitationName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success"
},
"204": {
"description": "Success"
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Delete Invitation in a share.",
"tags": [
"Invitation"
],
"x-ms-examples": {
"Invitations_Delete": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"invitationName": "Invitation1",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"204": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"get": {
"description": "Get an invitation in a share",
"operationId": "Invitations_Get",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "The name of the invitation.",
"in": "path",
"name": "invitationName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Invitation"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Get Invitation in a share.",
"tags": [
"Invitation"
],
"x-ms-examples": {
"Invitations_Get": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"invitationName": "Invitation1",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/invitations/Invitation1",
"name": "Invitation1",
"properties": {
"invitationStatus": "Pending",
"respondedAt": null,
"sentAt": "2018-11-26T22:33:24.5785265Z",
"targetEmail": "receiver@microsoft.com",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Invitation1"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"put": {
"description": "Create an invitation ",
"operationId": "Invitations_Create",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share to send the invitation for.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "The name of the invitation.",
"in": "path",
"name": "invitationName",
"required": true,
"type": "string"
},
{
"description": "Invitation details.",
"in": "body",
"name": "invitation",
"required": true,
"schema": {
"$ref": "#/definitions/Invitation"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Invitation"
}
},
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Invitation"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Sends a new invitation to a recipient to access a share.",
"tags": [
"Invitation"
],
"x-ms-examples": {
"Invitations_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"invitation": {
"properties": {
"targetEmail": "receiver@microsoft.com"
}
},
"invitationName": "Invitation1",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/invitations/Invitation1",
"name": "Invitation1",
"properties": {
"invitationStatus": "Pending",
"respondedAt": null,
"sentAt": "2018-11-26T22:33:24.5785265Z",
"targetEmail": "receiver@microsoft.com",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Invitation1"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/invitations/Invitation1",
"name": "Invitation1",
"properties": {
"invitationStatus": "Pending",
"respondedAt": null,
"sentAt": "2018-11-26T22:33:24.5785265Z",
"targetEmail": "receiver@microsoft.com",
"userEmail": "johnsmith@microsoft.com",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/Invitation1"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizationDetails": {
"post": {
"description": "List synchronization details",
"operationId": "Shares_ListSynchronizationDetails",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "Share Synchronization payload.",
"in": "body",
"name": "shareSynchronization",
"required": true,
"schema": {
"$ref": "#/definitions/ShareSynchronization"
}
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/SynchronizationDetailsList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List data set level details for a share synchronization",
"tags": [
"Share"
],
"x-ms-examples": {
"Shares_ListSynchronizationDetails": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"shareSynchronization": {
"synchronizationId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"
},
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"value": [
{
"dataSetId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb",
"dataSetType": "Blob",
"durationMs": 2000,
"endTime": "2018-11-14T04:47:52.9614956Z",
"name": "dataset1",
"startTime": "2018-11-14T04:47:52.9614956Z",
"status": "Completed"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations": {
"post": {
"description": "List synchronizations of a share",
"operationId": "Shares_ListSynchronizations",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ShareSynchronizationList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List Synchronizations in a share",
"tags": [
"Share"
],
"x-ms-examples": {
"Shares_ListSynchronizations": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"value": [
{
"consumerName": "abc@yahoo.com",
"consumerTenantName": "nda",
"durationMs": 2000,
"endTime": "2018-11-14T04:47:52.9614956Z",
"message": "nda",
"startTime": "2018-11-14T04:47:52.9614956Z",
"status": "Completed",
"synchronizationId": "runId",
"synchronizationMode": "Incremental"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions": {
"get": {
"description": "List share subscriptions in a provider share",
"operationId": "ProviderShareSubscriptions_ListByShare",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "Continuation Token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ProviderShareSubscriptionList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List of available share subscriptions to a provider share.",
"tags": [
"Share"
],
"x-ms-examples": {
"ProviderShareSubscriptions_ListByShare": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487",
"name": "invitation1",
"properties": {
"consumerEmail": "john.smith@microsoft.com",
"consumerName": "John Smith",
"consumerTenantName": "Microsoft",
"createdAt": "2018-12-13T08:52:42.6224087Z",
"providerEmail": "john.smith@microsoft.com",
"providerName": "John Smith",
"shareSubscriptionStatus": "Active",
"sharedAt": "2018-12-13T08:45:40.9005877Z"
},
"type": "Microsoft.DataShare/shareSubscripitons"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}": {
"get": {
"description": "Get share subscription in a provider share",
"operationId": "ProviderShareSubscriptions_GetByShare",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "To locate shareSubscription",
"in": "path",
"name": "providerShareSubscriptionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ProviderShareSubscription"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Get share subscription in a provider share.",
"tags": [
"Share"
],
"x-ms-examples": {
"ProviderShareSubscriptions_GetByShare": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"providerShareSubscriptionId": "d5496da4-9c52-402f-b067-83cc9ddea888",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487",
"name": "invitation1",
"properties": {
"consumerEmail": "john.smith@microsoft.com",
"consumerName": "John Smith",
"consumerTenantName": "Microsoft",
"createdAt": "2018-12-13T08:52:42.6224087Z",
"providerEmail": "john.smith@microsoft.com",
"providerName": "John Smith",
"shareSubscriptionStatus": "Active",
"sharedAt": "2018-12-13T08:45:40.9005877Z"
},
"type": "Microsoft.DataShare/shareSubscripitons"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/reinstate": {
"post": {
"description": "Reinstate share subscription in a provider share",
"operationId": "ProviderShareSubscriptions_Reinstate",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "To locate shareSubscription",
"in": "path",
"name": "providerShareSubscriptionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ProviderShareSubscription"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Reinstate share subscription in a provider share.",
"tags": [
"Share"
],
"x-ms-examples": {
"ProviderShareSubscriptions_Reinstate": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"providerShareSubscriptionId": "d5496da4-9c52-402f-b067-83cc9ddea888",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487",
"name": "invitation1",
"properties": {
"consumerEmail": "john.smith@microsoft.com",
"consumerName": "John Smith",
"consumerTenantName": "Microsoft",
"createdAt": "2018-12-13T08:52:42.6224087Z",
"providerEmail": "john.smith@microsoft.com",
"providerName": "John Smith",
"shareSubscriptionStatus": "Active",
"sharedAt": "2018-12-13T08:45:40.9005877Z"
},
"type": "Microsoft.DataShare/shareSubscripitons"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/revoke": {
"post": {
"description": "Revoke share subscription in a provider share",
"operationId": "ProviderShareSubscriptions_Revoke",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "To locate shareSubscription",
"in": "path",
"name": "providerShareSubscriptionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ProviderShareSubscription"
}
},
"202": {
"description": "Accepted",
"schema": {
"$ref": "#/definitions/ProviderShareSubscription"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Revoke share subscription in a provider share.",
"tags": [
"Share"
],
"x-ms-examples": {
"ProviderShareSubscriptions_Revoke": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"providerShareSubscriptionId": "d5496da4-9c52-402f-b067-83cc9ddea888",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "12345678-1234-1234-12345678abc"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/account1/shares/share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487",
"name": "providerShareSubscripiton",
"properties": {
"consumerEmail": "john.smith@microsoft.com",
"consumerName": "John Smith",
"consumerTenantName": "Microsoft",
"createdAt": "2018-12-13T08:52:42.6224087Z",
"providerEmail": "john.smith@microsoft.com",
"providerName": "John Smith",
"shareSubscriptionStatus": "Revoked",
"sharedAt": "2018-12-13T08:45:40.9005877Z"
},
"type": "Microsoft.DataShare/providerShareSubscripitons"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"202": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/account1/shares/share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487",
"name": "providerShareSubscripiton",
"properties": {
"consumerEmail": "john.smith@microsoft.com",
"consumerName": "John Smith",
"consumerTenantName": "Microsoft",
"createdAt": "2018-12-13T08:52:42.6224087Z",
"providerName": "John Smith",
"shareSubscriptionStatus": "Revoked",
"sharedAt": "2018-12-13T08:45:40.9005877Z"
},
"type": "Microsoft.DataShare/providerShareSubscripitons"
},
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/consumerAccount/shares/shareSub1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview",
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-long-running-operation": true,
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings": {
"get": {
"description": "List synchronizationSettings in a share",
"operationId": "SynchronizationSettings_ListByShare",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
},
{
"description": "continuation token",
"in": "query",
"name": "$skipToken",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/SynchronizationSettingList"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "List synchronizationSettings in a share.",
"tags": [
"SynchronizationSetting"
],
"x-ms-examples": {
"SynchronizationSettings_ListByShare": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/syncrhonizationSettings/SyncrhonizationSetting1",
"kind": "ScheduleBased",
"name": "SyncrhonizationSetting1",
"properties": {
"recurrenceInterval": "Day",
"synchronizationTime": "2018-11-14T04:47:52.9614956Z",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/SyncrhonizationSetting"
}
]
},
"headers": {
"Date": "Wed, 13 Sep 2017 17:33:55 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed",
"x-ms-ratelimit-remaining-subscription-reads": "14993",
"x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba"
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName}": {
"delete": {
"description": "Delete a synchronizationSetting in a share",
"operationId": "SynchronizationSettings_Delete",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "The name of the synchronizationSetting .",
"in": "path",
"name": "synchronizationSettingName",
"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"
}
}
},
"summary": "Delete synchronizationSetting in a share.",
"tags": [
"SynchronizationSetting"
],
"x-ms-examples": {
"SynchronizationSettings_Delete": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a",
"synchronizationSettingName": "SyncrhonizationSetting1"
},
"responses": {
"200": {
"body": {
"status": "Succeeded"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/consumerAccount/shares/share1/synchronizationSettings/trigger1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview",
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888",
"x-ms-retry-after-ms": "30"
}
},
"204": {
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
},
"x-ms-long-running-operation": true
},
"get": {
"description": "Get a synchronizationSetting in a share",
"operationId": "SynchronizationSettings_Get",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "The name of the synchronizationSetting.",
"in": "path",
"name": "synchronizationSettingName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/SynchronizationSetting"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Get synchronizationSetting in a share.",
"tags": [
"SynchronizationSetting"
],
"x-ms-examples": {
"SynchronizationSettings_Get": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a",
"synchronizationSettingName": "SyncrhonizationSetting1"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/syncrhonizationSettings/SyncrhonizationSetting1",
"kind": "ScheduleBased",
"name": "SyncrhonizationSetting1",
"properties": {
"provisioningState": "Succeeded",
"recurrenceInterval": "Day",
"synchronizationTime": "2018-11-14T04:47:52.9614956Z",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/SyncrhonizationSetting"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
},
"put": {
"description": "Create or update a synchronizationSetting ",
"operationId": "SynchronizationSettings_Create",
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/accountName"
},
{
"description": "The name of the share to add the synchronization setting to.",
"in": "path",
"name": "shareName",
"required": true,
"type": "string"
},
{
"description": "The name of the synchronizationSetting.",
"in": "path",
"name": "synchronizationSettingName",
"required": true,
"type": "string"
},
{
"description": "The new synchronization setting information.",
"in": "body",
"name": "synchronizationSetting",
"required": true,
"schema": {
"$ref": "#/definitions/SynchronizationSetting"
}
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/SynchronizationSetting"
}
},
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/SynchronizationSetting"
}
},
"default": {
"description": "An error response received from the Microsoft.DataShare resource provider.",
"schema": {
"$ref": "#/definitions/DataShareError"
}
}
},
"summary": "Adds a new synchronization setting to an existing share or updates it if existing.",
"tags": [
"SynchronizationSetting"
],
"x-ms-examples": {
"SynchronizationSettings_Create": {
"parameters": {
"accountName": "Account1",
"api-version": "2019-11-01",
"resourceGroupName": "SampleResourceGroup",
"shareName": "Share1",
"subscriptionId": "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a",
"synchronizationSetting": {
"kind": "ScheduleBased",
"properties": {
"recurrenceInterval": "Day",
"synchronizationTime": "2018-11-14T04:47:52.9614956Z"
}
},
"synchronizationSettingName": "Dataset1"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/syncrhonizationSettings/SyncrhonizationSetting1",
"kind": "ScheduleBased",
"name": "SyncrhonizationSetting1",
"properties": {
"provisioningState": "Succeeded",
"recurrenceInterval": "Day",
"synchronizationTime": "2018-11-14T04:47:52.9614956Z",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/SyncrhonizationSetting"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
},
"201": {
"body": {
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/syncrhonizationSettings/SyncrhonizationSetting1",
"kind": "ScheduleBased",
"name": "SyncrhonizationSetting1",
"properties": {
"provisioningState": "Succeeded",
"recurrenceInterval": "Day",
"synchronizationTime": "2018-11-14T04:47:52.9614956Z",
"userName": "John Smith"
},
"type": "Microsoft.DataShare/SyncrhonizationSetting"
},
"headers": {
"Date": "Wed, 13 Sep 2017 18:04:32 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd",
"x-ms-long-running-operation": true,
"x-ms-ratelimit-remaining-tenant-reads": "14999",
"x-ms-request-id": "d5496da4-9c52-402f-b067-83cc9ddea888"
}
}
}
}
}
}
}
},
"definitions": {
"ADLSGen1FileDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "An ADLS Gen 1 file data set.",
"properties": {
"properties": {
"$ref": "#/definitions/ADLSGen1FileProperties",
"description": "ADLS Gen 1 file data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "AdlsGen1File"
},
"ADLSGen1FileProperties": {
"description": "Properties of the ADLS Gen1 file data set.",
"properties": {
"accountName": {
"description": "The ADLS account name.",
"type": "string"
},
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"fileName": {
"description": "The file name in the ADLS account.",
"type": "string"
},
"folderPath": {
"description": "The folder path within the ADLS account.",
"type": "string"
},
"resourceGroup": {
"description": "Resource group of ADLS account.",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of ADLS account.",
"type": "string"
}
},
"required": [
"subscriptionId",
"resourceGroup",
"accountName",
"folderPath",
"fileName"
],
"type": "object"
},
"ADLSGen1FolderDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "An ADLS Gen 1 folder data set.",
"properties": {
"properties": {
"$ref": "#/definitions/ADLSGen1FolderProperties",
"description": "ADLS Gen 1 folder data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "AdlsGen1Folder"
},
"ADLSGen1FolderProperties": {
"description": "Properties of the ADLS Gen1 folder data set.",
"properties": {
"accountName": {
"description": "The ADLS account name.",
"type": "string"
},
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"folderPath": {
"description": "The folder path within the ADLS account.",
"type": "string"
},
"resourceGroup": {
"description": "Resource group of ADLS account.",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of ADLS account.",
"type": "string"
}
},
"required": [
"subscriptionId",
"resourceGroup",
"accountName",
"folderPath"
],
"type": "object"
},
"ADLSGen2FileDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "An ADLS Gen 2 file data set.",
"properties": {
"properties": {
"$ref": "#/definitions/ADLSGen2FileProperties",
"description": "ADLS Gen 2 file data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "AdlsGen2File"
},
"ADLSGen2FileDataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/DataSetMapping"
}
],
"description": "An ADLS Gen2 file data set mapping.",
"properties": {
"properties": {
"$ref": "#/definitions/ADLSGen2FileDataSetMappingProperties",
"description": "ADLS Gen2 file data set mapping properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "AdlsGen2File"
},
"ADLSGen2FileDataSetMappingProperties": {
"description": "ADLS Gen 2 file data set mapping property bag.",
"properties": {
"dataSetId": {
"description": "The id of the source data set.",
"type": "string"
},
"dataSetMappingStatus": {
"description": "Gets the status of the data set mapping.",
"enum": [
"Ok",
"Broken"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetMappingStatus"
}
},
"filePath": {
"description": "File path within the file system.",
"type": "string"
},
"fileSystem": {
"description": "File system to which the file belongs.",
"type": "string"
},
"outputType": {
"description": "Type of output file",
"enum": [
"Csv",
"Parquet"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "outputType"
}
},
"provisioningState": {
"description": "Provisioning state of the data set mapping.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"resourceGroup": {
"description": "Resource group of storage account.",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set.",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account.",
"type": "string"
}
},
"required": [
"fileSystem",
"filePath",
"subscriptionId",
"resourceGroup",
"storageAccountName",
"dataSetId"
],
"type": "object"
},
"ADLSGen2FileProperties": {
"description": "Properties of the ADLS Gen2 file data set.",
"properties": {
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"filePath": {
"description": "File path within the file system.",
"type": "string"
},
"fileSystem": {
"description": "File system to which the file belongs.",
"type": "string"
},
"resourceGroup": {
"description": "Resource group of storage account",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account",
"type": "string"
}
},
"required": [
"fileSystem",
"filePath",
"subscriptionId",
"resourceGroup",
"storageAccountName"
],
"type": "object"
},
"ADLSGen2FileSystemDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "An ADLS Gen 2 file system data set.",
"properties": {
"properties": {
"$ref": "#/definitions/ADLSGen2FileSystemProperties",
"description": "ADLS Gen 2 file system data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "AdlsGen2FileSystem"
},
"ADLSGen2FileSystemDataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/DataSetMapping"
}
],
"description": "An ADLS Gen2 file system data set mapping.",
"properties": {
"properties": {
"$ref": "#/definitions/ADLSGen2FileSystemDataSetMappingProperties",
"description": "ADLS Gen2 file system data set mapping properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "AdlsGen2FileSystem"
},
"ADLSGen2FileSystemDataSetMappingProperties": {
"description": "ADLS Gen 2 file system data set mapping property bag.",
"properties": {
"dataSetId": {
"description": "The id of the source data set.",
"type": "string"
},
"dataSetMappingStatus": {
"description": "Gets the status of the data set mapping.",
"enum": [
"Ok",
"Broken"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetMappingStatus"
}
},
"fileSystem": {
"description": "The file system name.",
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the data set mapping.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"resourceGroup": {
"description": "Resource group of storage account.",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set.",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account.",
"type": "string"
}
},
"required": [
"fileSystem",
"subscriptionId",
"resourceGroup",
"storageAccountName",
"dataSetId"
],
"type": "object"
},
"ADLSGen2FileSystemProperties": {
"description": "Properties of the ADLS Gen2 file system data set.",
"properties": {
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"fileSystem": {
"description": "The file system name.",
"type": "string"
},
"resourceGroup": {
"description": "Resource group of storage account",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account",
"type": "string"
}
},
"required": [
"fileSystem",
"subscriptionId",
"resourceGroup",
"storageAccountName"
],
"type": "object"
},
"ADLSGen2FolderDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "An ADLS Gen 2 folder data set.",
"properties": {
"properties": {
"$ref": "#/definitions/ADLSGen2FolderProperties",
"description": "ADLS Gen 2 folder data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "AdlsGen2Folder"
},
"ADLSGen2FolderDataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/DataSetMapping"
}
],
"description": "An ADLS Gen2 folder data set mapping.",
"properties": {
"properties": {
"$ref": "#/definitions/ADLSGen2FolderDataSetMappingProperties",
"description": "ADLS Gen2 folder data set mapping properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "AdlsGen2Folder"
},
"ADLSGen2FolderDataSetMappingProperties": {
"description": "ADLS Gen 2 folder data set mapping property bag.",
"properties": {
"dataSetId": {
"description": "The id of the source data set.",
"type": "string"
},
"dataSetMappingStatus": {
"description": "Gets the status of the data set mapping.",
"enum": [
"Ok",
"Broken"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetMappingStatus"
}
},
"fileSystem": {
"description": "File system to which the folder belongs.",
"type": "string"
},
"folderPath": {
"description": "Folder path within the file system.",
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the data set mapping.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"resourceGroup": {
"description": "Resource group of storage account.",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set.",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account.",
"type": "string"
}
},
"required": [
"fileSystem",
"folderPath",
"subscriptionId",
"resourceGroup",
"storageAccountName",
"dataSetId"
],
"type": "object"
},
"ADLSGen2FolderProperties": {
"description": "Properties of the ADLS Gen2 folder data set.",
"properties": {
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"fileSystem": {
"description": "File system to which the folder belongs.",
"type": "string"
},
"folderPath": {
"description": "Folder path within the file system.",
"type": "string"
},
"resourceGroup": {
"description": "Resource group of storage account",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account",
"type": "string"
}
},
"required": [
"fileSystem",
"folderPath",
"subscriptionId",
"resourceGroup",
"storageAccountName"
],
"type": "object"
},
"Account": {
"allOf": [
{
"$ref": "#/definitions/DefaultDto"
}
],
"description": "An account data transfer object.",
"properties": {
"identity": {
"$ref": "#/definitions/Identity",
"description": "Identity Info on the Account"
},
"properties": {
"$ref": "#/definitions/AccountProperties",
"description": "Properties on the account",
"x-ms-client-flatten": true
}
},
"required": [
"identity"
],
"type": "object"
},
"AccountList": {
"description": "List response for get Accounts.",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/Account"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"AccountProperties": {
"description": "Account property bag.",
"properties": {
"createdAt": {
"description": "Time at which the account was created.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the Account",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"userEmail": {
"description": "Email of the user who created the resource",
"readOnly": true,
"type": "string"
},
"userName": {
"description": "Name of the user who created the resource",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AccountUpdateParameters": {
"description": "Update parameters for accounts",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Tags on the azure resource.",
"type": "object"
}
},
"type": "object"
},
"BlobContainerDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "An Azure storage blob container data set.",
"properties": {
"properties": {
"$ref": "#/definitions/BlobContainerProperties",
"description": "Blob container data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "Container"
},
"BlobContainerDataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/DataSetMapping"
}
],
"description": "A Blob container data set mapping.",
"properties": {
"properties": {
"$ref": "#/definitions/BlobContainerMappingProperties",
"description": "Blob container data set mapping properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "Container"
},
"BlobContainerMappingProperties": {
"description": "Azure storage Blob container data set mapping property bag.",
"properties": {
"containerName": {
"description": "BLOB Container name.",
"type": "string"
},
"dataSetId": {
"description": "The id of the source data set.",
"type": "string"
},
"dataSetMappingStatus": {
"description": "Gets the status of the data set mapping.",
"enum": [
"Ok",
"Broken"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetMappingStatus"
}
},
"provisioningState": {
"description": "Provisioning state of the data set mapping.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"resourceGroup": {
"description": "Resource group of storage account.",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set.",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account.",
"type": "string"
}
},
"required": [
"containerName",
"subscriptionId",
"resourceGroup",
"storageAccountName",
"dataSetId"
],
"type": "object"
},
"BlobContainerProperties": {
"description": "Properties of the BLOB container data set.",
"properties": {
"containerName": {
"description": "BLOB Container name.",
"type": "string"
},
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"resourceGroup": {
"description": "Resource group of storage account",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account",
"type": "string"
}
},
"required": [
"containerName",
"subscriptionId",
"resourceGroup",
"storageAccountName"
],
"type": "object"
},
"BlobDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "An Azure storage blob data set.",
"properties": {
"properties": {
"$ref": "#/definitions/BlobProperties",
"description": "Blob data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "Blob"
},
"BlobDataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/DataSetMapping"
}
],
"description": "A Blob data set mapping.",
"properties": {
"properties": {
"$ref": "#/definitions/BlobMappingProperties",
"description": "Blob data set mapping properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "Blob"
},
"BlobFolderDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "An Azure storage blob folder data set.",
"properties": {
"properties": {
"$ref": "#/definitions/BlobFolderProperties",
"description": "Blob folder data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "BlobFolder"
},
"BlobFolderDataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/DataSetMapping"
}
],
"description": "A Blob folder data set mapping.",
"properties": {
"properties": {
"$ref": "#/definitions/BlobFolderMappingProperties",
"description": "Blob folder data set mapping properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "BlobFolder"
},
"BlobFolderMappingProperties": {
"description": "Azure storage Blob folder data set mapping property bag.",
"properties": {
"containerName": {
"description": "Container that has the file path.",
"type": "string"
},
"dataSetId": {
"description": "The id of the source data set.",
"type": "string"
},
"dataSetMappingStatus": {
"description": "Gets the status of the data set mapping.",
"enum": [
"Ok",
"Broken"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetMappingStatus"
}
},
"prefix": {
"description": "Prefix for blob folder",
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the data set mapping.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"resourceGroup": {
"description": "Resource group of storage account.",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set.",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account.",
"type": "string"
}
},
"required": [
"containerName",
"prefix",
"subscriptionId",
"resourceGroup",
"storageAccountName",
"dataSetId"
],
"type": "object"
},
"BlobFolderProperties": {
"description": "Properties of the blob folder data set.",
"properties": {
"containerName": {
"description": "Container that has the file path.",
"type": "string"
},
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"prefix": {
"description": "Prefix for blob folder",
"type": "string"
},
"resourceGroup": {
"description": "Resource group of storage account",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account",
"type": "string"
}
},
"required": [
"containerName",
"prefix",
"subscriptionId",
"resourceGroup",
"storageAccountName"
],
"type": "object"
},
"BlobMappingProperties": {
"description": "Azure storage Blob data set mapping property bag.",
"properties": {
"containerName": {
"description": "Container that has the file path.",
"type": "string"
},
"dataSetId": {
"description": "The id of the source data set.",
"type": "string"
},
"dataSetMappingStatus": {
"description": "Gets the status of the data set mapping.",
"enum": [
"Ok",
"Broken"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetMappingStatus"
}
},
"filePath": {
"description": "File path within the source data set",
"type": "string"
},
"outputType": {
"description": "File output type",
"enum": [
"Csv",
"Parquet"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "outputType"
}
},
"provisioningState": {
"description": "Provisioning state of the data set mapping.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"resourceGroup": {
"description": "Resource group of storage account.",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set.",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account.",
"type": "string"
}
},
"required": [
"containerName",
"filePath",
"subscriptionId",
"resourceGroup",
"storageAccountName",
"dataSetId"
],
"type": "object"
},
"BlobProperties": {
"description": "Properties of the blob data set.",
"properties": {
"containerName": {
"description": "Container that has the file path.",
"type": "string"
},
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"filePath": {
"description": "File path within the source data set",
"type": "string"
},
"resourceGroup": {
"description": "Resource group of storage account",
"type": "string"
},
"storageAccountName": {
"description": "Storage account name of the source data set",
"type": "string"
},
"subscriptionId": {
"description": "Subscription id of storage account",
"type": "string"
}
},
"required": [
"containerName",
"filePath",
"subscriptionId",
"resourceGroup",
"storageAccountName"
],
"type": "object"
},
"ConsumerInvitation": {
"allOf": [
{
"$ref": "#/definitions/ProxyDto"
}
],
"description": "A consumer Invitation data transfer object.",
"properties": {
"properties": {
"$ref": "#/definitions/ConsumerInvitationProperties",
"description": "Properties on the account",
"x-ms-client-flatten": true
}
},
"required": [
"properties"
],
"type": "object"
},
"ConsumerInvitationList": {
"description": "List response for get InvitationList",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/ConsumerInvitation"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"ConsumerInvitationProperties": {
"description": "Properties of consumer invitation",
"properties": {
"dataSetCount": {
"description": "Number of data sets in a share",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"description": {
"description": "Description shared when the invitation was created",
"readOnly": true,
"type": "string"
},
"invitationId": {
"description": "Unique id of the invitation.",
"type": "string"
},
"invitationStatus": {
"description": "The status of the invitation.",
"enum": [
"Pending",
"Accepted",
"Rejected",
"Withdrawn"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "invitationStatus"
}
},
"location": {
"description": "invitation location",
"readOnly": true,
"type": "string"
},
"providerEmail": {
"description": "Email of the provider who created the resource",
"readOnly": true,
"type": "string"
},
"providerName": {
"description": "Name of the provider who created the resource",
"readOnly": true,
"type": "string"
},
"providerTenantName": {
"description": "Tenant name of the provider who created the resource",
"readOnly": true,
"type": "string"
},
"respondedAt": {
"description": "The time the recipient responded to the invitation.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"sentAt": {
"description": "Gets the time at which the invitation was sent.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"shareName": {
"description": "Gets the source share Name.",
"readOnly": true,
"type": "string"
},
"termsOfUse": {
"description": "Terms of use shared when the invitation was created",
"readOnly": true,
"type": "string"
},
"userEmail": {
"description": "Email of the user who created the resource",
"readOnly": true,
"type": "string"
},
"userName": {
"description": "Name of the user who created the resource",
"readOnly": true,
"type": "string"
}
},
"required": [
"invitationId"
],
"type": "object"
},
"ConsumerSourceDataSet": {
"allOf": [
{
"$ref": "#/definitions/ProxyDto"
}
],
"description": "A consumer side dataSet data transfer object.",
"properties": {
"properties": {
"$ref": "#/definitions/ConsumerSourceDataSetProperties",
"description": "source dataSet properties",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ConsumerSourceDataSetList": {
"description": "A consumer side list of source dataSets",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/ConsumerSourceDataSet"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"ConsumerSourceDataSetProperties": {
"description": "Properties of consumer source dataSet",
"properties": {
"dataSetId": {
"description": "DataSet Id",
"readOnly": true,
"type": "string"
},
"dataSetLocation": {
"description": "Location of the data set.",
"readOnly": true,
"type": "string"
},
"dataSetName": {
"description": "DataSet name",
"readOnly": true,
"type": "string"
},
"dataSetPath": {
"description": "DataSet path",
"readOnly": true,
"type": "string"
},
"dataSetType": {
"description": "Type of data set",
"enum": [
"Blob",
"Container",
"BlobFolder",
"AdlsGen2FileSystem",
"AdlsGen2Folder",
"AdlsGen2File",
"AdlsGen1Folder",
"AdlsGen1File",
"KustoCluster",
"KustoDatabase",
"SqlDBTable",
"SqlDWTable"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetType"
}
}
},
"type": "object"
},
"DataSet": {
"allOf": [
{
"$ref": "#/definitions/ProxyDto"
}
],
"description": "A DataSet data transfer object.",
"discriminator": "kind",
"properties": {
"kind": {
"description": "Kind of data set.",
"enum": [
"Blob",
"Container",
"BlobFolder",
"AdlsGen2FileSystem",
"AdlsGen2Folder",
"AdlsGen2File",
"AdlsGen1Folder",
"AdlsGen1File",
"KustoCluster",
"KustoDatabase",
"SqlDBTable",
"SqlDWTable"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "kind"
}
}
},
"required": [
"kind"
],
"type": "object"
},
"DataSetList": {
"description": "List response for get DataSets",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/DataSet"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"DataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/ProxyDto"
}
],
"description": "A data set mapping data transfer object.",
"discriminator": "kind",
"properties": {
"kind": {
"description": "Kind of data set mapping.",
"enum": [
"Blob",
"Container",
"BlobFolder",
"AdlsGen2FileSystem",
"AdlsGen2Folder",
"AdlsGen2File",
"KustoCluster",
"KustoDatabase",
"SqlDBTable",
"SqlDWTable"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "kind"
}
}
},
"required": [
"kind"
],
"type": "object"
},
"DataSetMappingList": {
"description": "List response for get DataSetMappings",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/DataSetMapping"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"DataShareError": {
"description": "The data share error model.",
"properties": {
"error": {
"$ref": "#/definitions/DataShareErrorInfo",
"description": "The data share error body"
}
},
"required": [
"error"
],
"type": "object"
},
"DataShareErrorInfo": {
"description": "The data share error body model.",
"properties": {
"code": {
"description": "Code of the error",
"type": "string"
},
"details": {
"description": "Nested details of the error model",
"items": {
"$ref": "#/definitions/DataShareErrorInfo"
},
"type": "array",
"uniqueItems": false
},
"message": {
"description": "Message of the error",
"type": "string"
},
"target": {
"description": "Target of the error",
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"DefaultDto": {
"description": "Base data transfer object implementation for default resources.",
"properties": {
"id": {
"description": "The resource id of the azure resource",
"readOnly": true,
"type": "string"
},
"location": {
"description": "Location of the azure resource.",
"type": "string"
},
"name": {
"description": "Name of the azure resource",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Tags on the azure resource.",
"type": "object"
},
"type": {
"description": "Type of the azure resource",
"readOnly": true,
"type": "string"
}
},
"type": "object",
"x-ms-azure-resource": true
},
"DimensionProperties": {
"description": "properties for dimension",
"properties": {
"displayName": {
"description": "localized display name of the dimension to customer",
"type": "string"
},
"name": {
"description": "dimension name",
"type": "string"
}
},
"type": "object"
},
"Identity": {
"description": "Identity of resource",
"properties": {
"principalId": {
"description": "service principal Id",
"readOnly": true,
"type": "string"
},
"tenantId": {
"description": "Tenant Id",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Identity Type",
"enum": [
"SystemAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "type"
}
}
},
"type": "object"
},
"Invitation": {
"allOf": [
{
"$ref": "#/definitions/ProxyDto"
}
],
"description": "A Invitation data transfer object.",
"properties": {
"properties": {
"$ref": "#/definitions/InvitationProperties",
"description": "Properties on the Invitation",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"InvitationList": {
"description": "List response for get InvitationList",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/Invitation"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"InvitationProperties": {
"description": "Invitation property bag.",
"properties": {
"invitationId": {
"description": "unique invitation id",
"readOnly": true,
"type": "string"
},
"invitationStatus": {
"description": "The status of the invitation.",
"enum": [
"Pending",
"Accepted",
"Rejected",
"Withdrawn"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "invitationStatus"
}
},
"respondedAt": {
"description": "The time the recipient responded to the invitation.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"sentAt": {
"description": "Gets the time at which the invitation was sent.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"targetActiveDirectoryId": {
"description": "The target Azure AD Id. Can't be combined with email.",
"type": "string"
},
"targetEmail": {
"description": "The email the invitation is directed to.",
"type": "string"
},
"targetObjectId": {
"description": "The target user or application Id that invitation is being sent to.\r\nMust be specified along TargetActiveDirectoryId. This enables sending\r\ninvitations to specific users or applications in an AD tenant.",
"type": "string"
},
"userEmail": {
"description": "Email of the user who created the resource",
"readOnly": true,
"type": "string"
},
"userName": {
"description": "Name of the user who created the resource",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"KustoClusterDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "A kusto cluster data set.",
"properties": {
"properties": {
"$ref": "#/definitions/KustoClusterDataSetProperties",
"description": "Kusto cluster data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "KustoCluster"
},
"KustoClusterDataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/DataSetMapping"
}
],
"description": "A Kusto cluster data set mapping",
"properties": {
"properties": {
"$ref": "#/definitions/KustoClusterDataSetMappingProperties",
"description": "Kusto cluster data set mapping properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "KustoCluster"
},
"KustoClusterDataSetMappingProperties": {
"description": "Properties of the Kusto cluster data set mapping",
"properties": {
"dataSetId": {
"description": "The id of the source data set.",
"type": "string"
},
"dataSetMappingStatus": {
"description": "Gets the status of the data set mapping.",
"enum": [
"Ok",
"Broken"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetMappingStatus"
}
},
"kustoClusterResourceId": {
"description": "Resource id of the sink kusto cluster.",
"type": "string"
},
"location": {
"description": "Location of the sink kusto cluster.",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the data set mapping.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
}
},
"required": [
"kustoClusterResourceId",
"dataSetId"
],
"type": "object"
},
"KustoClusterDataSetProperties": {
"description": "Properties of the kusto cluster data set.",
"properties": {
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"kustoClusterResourceId": {
"description": "Resource id of the kusto cluster.",
"type": "string"
},
"location": {
"description": "Location of the kusto cluster.",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the kusto cluster data set.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
}
},
"required": [
"kustoClusterResourceId"
],
"type": "object"
},
"KustoDatabaseDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "A kusto database data set.",
"properties": {
"properties": {
"$ref": "#/definitions/KustoDatabaseDataSetProperties",
"description": "Kusto database data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "KustoDatabase"
},
"KustoDatabaseDataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/DataSetMapping"
}
],
"description": "A Kusto database data set mapping",
"properties": {
"properties": {
"$ref": "#/definitions/KustoDatabaseDataSetMappingProperties",
"description": "Kusto database data set mapping properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "KustoDatabase"
},
"KustoDatabaseDataSetMappingProperties": {
"description": "Properties of the Kusto database data set mapping",
"properties": {
"dataSetId": {
"description": "The id of the source data set.",
"type": "string"
},
"dataSetMappingStatus": {
"description": "Gets the status of the data set mapping.",
"enum": [
"Ok",
"Broken"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetMappingStatus"
}
},
"kustoClusterResourceId": {
"description": "Resource id of the sink kusto cluster.",
"type": "string"
},
"location": {
"description": "Location of the sink kusto cluster.",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the data set mapping.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
}
},
"required": [
"kustoClusterResourceId",
"dataSetId"
],
"type": "object"
},
"KustoDatabaseDataSetProperties": {
"description": "Properties of the kusto database data set.",
"properties": {
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"kustoDatabaseResourceId": {
"description": "Resource id of the kusto database.",
"type": "string"
},
"location": {
"description": "Location of the kusto cluster.",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the kusto database data set.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
}
},
"required": [
"kustoDatabaseResourceId"
],
"type": "object"
},
"OperationList": {
"description": "List response for get operations.",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/OperationModel"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"OperationMetaLogSpecification": {
"description": "log specifications for operation api",
"properties": {
"blobDuration": {
"description": "blob duration of the log",
"type": "string"
},
"displayName": {
"description": "localized name of the log category",
"type": "string"
},
"name": {
"description": "name of the log category",
"type": "string"
}
},
"type": "object"
},
"OperationMetaMetricSpecification": {
"description": "metric specifications for the operation",
"properties": {
"aggregationType": {
"description": "aggregation type of metric",
"type": "string"
},
"dimensions": {
"description": "properties for dimension",
"items": {
"$ref": "#/definitions/DimensionProperties"
},
"type": "array",
"uniqueItems": false
},
"displayDescription": {
"description": "description of the metric",
"type": "string"
},
"displayName": {
"description": "localized name of the metric",
"type": "string"
},
"enableRegionalMdmAccount": {
"description": "enable regional mdm account",
"type": "string"
},
"internalMetricName": {
"description": "internal metric name",
"type": "string"
},
"name": {
"description": "name of the metric",
"type": "string"
},
"resourceIdDimensionNameOverride": {
"description": "dimension name use to replace resource id if specified",
"type": "string"
},
"supportedAggregationTypes": {
"description": "supported aggregation types",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": false
},
"supportedTimeGrainTypes": {
"description": "supported time grain types",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": false
},
"unit": {
"description": "units for the metric",
"type": "string"
}
},
"type": "object"
},
"OperationMetaPropertyInfo": {
"description": "properties on meta info",
"properties": {
"serviceSpecification": {
"$ref": "#/definitions/OperationMetaServiceSpecification",
"description": "meta service specification"
}
},
"type": "object"
},
"OperationMetaServiceSpecification": {
"description": "The operation meta service specification",
"properties": {
"logSpecifications": {
"description": "log specifications for the operation",
"items": {
"$ref": "#/definitions/OperationMetaLogSpecification"
},
"type": "array",
"uniqueItems": false
},
"metricSpecifications": {
"description": "metric specifications for the operation",
"items": {
"$ref": "#/definitions/OperationMetaMetricSpecification"
},
"type": "array",
"uniqueItems": false
}
},
"type": "object"
},
"OperationModel": {
"description": "The response model for get operations",
"properties": {
"display": {
"$ref": "#/definitions/OperationModelProperties",
"description": "Properties on the operation"
},
"name": {
"description": "Operation name for display purposes",
"type": "string"
},
"origin": {
"description": "origin of the operation",
"type": "string"
},
"properties": {
"$ref": "#/definitions/OperationMetaPropertyInfo",
"description": "properties for the operation meta info",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"OperationModelProperties": {
"description": "Properties on operations",
"properties": {
"description": {
"description": "Description of the operation for display purposes",
"type": "string"
},
"operation": {
"description": "Name of the operation for display purposes",
"type": "string"
},
"provider": {
"description": "Name of the provider for display purposes",
"type": "string"
},
"resource": {
"description": "Name of the resource type for display purposes",
"type": "string"
}
},
"type": "object"
},
"OperationResponse": {
"description": "Response for long running operation",
"properties": {
"endTime": {
"description": "start time",
"format": "date-time",
"type": "string"
},
"error": {
"$ref": "#/definitions/DataShareErrorInfo",
"description": "The error property when status is failed."
},
"startTime": {
"description": "start time",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Operation state of the long running operation.",
"enum": [
"Accepted",
"InProgress",
"TransientFailure",
"Succeeded",
"Failed",
"Canceled"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "status"
}
}
},
"required": [
"status"
],
"type": "object"
},
"ProviderShareSubscription": {
"allOf": [
{
"$ref": "#/definitions/ProxyDto"
}
],
"description": "A provider side share subscription data transfer object.",
"properties": {
"properties": {
"$ref": "#/definitions/ProviderShareSubscriptionProperties",
"description": "properties of providerShareSubscription",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ProviderShareSubscriptionList": {
"description": "List response for get ShareSubscription.",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/ProviderShareSubscription"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"ProviderShareSubscriptionProperties": {
"description": "Provider share subscription properties",
"properties": {
"consumerEmail": {
"description": "Email of the consumer who created the share subscription",
"readOnly": true,
"type": "string"
},
"consumerName": {
"description": "Name of the consumer who created the share subscription",
"readOnly": true,
"type": "string"
},
"consumerTenantName": {
"description": "Tenant name of the consumer who created the share subscription",
"readOnly": true,
"type": "string"
},
"createdAt": {
"description": "created at",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"providerEmail": {
"description": "Email of the provider who created the share",
"readOnly": true,
"type": "string"
},
"providerName": {
"description": "Name of the provider who created the share",
"readOnly": true,
"type": "string"
},
"shareSubscriptionObjectId": {
"description": "share Subscription Object Id",
"readOnly": true,
"type": "string"
},
"shareSubscriptionStatus": {
"description": "Gets the status of share subscription",
"enum": [
"Active",
"Revoked",
"SourceDeleted",
"Revoking"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "shareSubscriptionStatus"
}
},
"sharedAt": {
"description": "Shared at",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ProxyDto": {
"description": "Base data transfer object implementation for proxy resources.",
"properties": {
"id": {
"description": "The resource id of the azure resource",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the azure resource",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of the azure resource",
"readOnly": true,
"type": "string"
}
},
"type": "object",
"x-ms-azure-resource": true
},
"ScheduledSourceShareSynchronizationSettingProperties": {
"description": "A Scheduled source synchronization setting data transfer object.",
"properties": {
"recurrenceInterval": {
"description": "Recurrence Interval",
"enum": [
"Hour",
"Day"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "recurrenceInterval"
}
},
"synchronizationTime": {
"description": "Synchronization time",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"ScheduledSourceSynchronizationSetting": {
"allOf": [
{
"$ref": "#/definitions/SourceShareSynchronizationSetting"
}
],
"description": "A type of synchronization setting based on schedule",
"properties": {
"properties": {
"$ref": "#/definitions/ScheduledSourceShareSynchronizationSettingProperties",
"description": "Properties of scheduled synchronization",
"x-ms-client-flatten": true
}
},
"required": [
"kind"
],
"type": "object",
"x-ms-discriminator-value": "ScheduleBased"
},
"ScheduledSynchronizationSetting": {
"allOf": [
{
"$ref": "#/definitions/SynchronizationSetting"
}
],
"description": "A type of synchronization setting based on schedule",
"properties": {
"properties": {
"$ref": "#/definitions/ScheduledSynchronizationSettingProperties",
"description": "Properties of scheduled synchronization",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "ScheduleBased"
},
"ScheduledSynchronizationSettingProperties": {
"description": "A Scheduled synchronization setting data transfer object.",
"properties": {
"createdAt": {
"description": "Time at which the synchronization setting was created.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Gets or sets the provisioning state",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"recurrenceInterval": {
"description": "Recurrence Interval",
"enum": [
"Hour",
"Day"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "recurrenceInterval"
}
},
"synchronizationTime": {
"description": "Synchronization time",
"format": "date-time",
"type": "string"
},
"userName": {
"description": "Name of the user who created the synchronization setting.",
"readOnly": true,
"type": "string"
}
},
"required": [
"recurrenceInterval",
"synchronizationTime"
],
"type": "object"
},
"ScheduledTrigger": {
"allOf": [
{
"$ref": "#/definitions/Trigger"
}
],
"description": "A type of trigger based on schedule",
"properties": {
"properties": {
"$ref": "#/definitions/ScheduledTriggerProperties",
"description": "Properties of scheduled synchronization",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "ScheduleBased"
},
"ScheduledTriggerProperties": {
"description": "A Scheduled trigger data transfer object.",
"properties": {
"createdAt": {
"description": "Time at which the trigger was created.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Gets the provisioning state",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"recurrenceInterval": {
"description": "Recurrence Interval",
"enum": [
"Hour",
"Day"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "recurrenceInterval"
}
},
"synchronizationMode": {
"description": "Synchronization mode",
"enum": [
"Incremental",
"FullSync"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "synchronizationMode"
}
},
"synchronizationTime": {
"description": "Synchronization time",
"format": "date-time",
"type": "string"
},
"triggerStatus": {
"description": "Gets the trigger state",
"enum": [
"Active",
"Inactive",
"SourceSynchronizationSettingDeleted"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "triggerStatus"
}
},
"userName": {
"description": "Name of the user who created the trigger.",
"readOnly": true,
"type": "string"
}
},
"required": [
"recurrenceInterval",
"synchronizationTime"
],
"type": "object"
},
"Share": {
"allOf": [
{
"$ref": "#/definitions/ProxyDto"
}
],
"description": "A share data transfer object.",
"properties": {
"properties": {
"$ref": "#/definitions/ShareProperties",
"description": "Properties on the share",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ShareList": {
"description": "List response for get Shares.",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/Share"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"ShareProperties": {
"description": "Share property bag.",
"properties": {
"createdAt": {
"description": "Time at which the share was created.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Share description.",
"type": "string"
},
"provisioningState": {
"description": "Gets or sets the provisioning state",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"shareKind": {
"description": "Share kind.",
"enum": [
"CopyBased",
"InPlace"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "shareKind"
}
},
"terms": {
"description": "Share terms.",
"type": "string"
},
"userEmail": {
"description": "Email of the user who created the resource",
"readOnly": true,
"type": "string"
},
"userName": {
"description": "Name of the user who created the resource",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ShareSubscription": {
"allOf": [
{
"$ref": "#/definitions/ProxyDto"
}
],
"description": "A share subscription data transfer object.",
"properties": {
"properties": {
"$ref": "#/definitions/ShareSubscriptionProperties",
"description": "Properties on the share subscription",
"x-ms-client-flatten": true
}
},
"required": [
"properties"
],
"type": "object"
},
"ShareSubscriptionList": {
"description": "List response for get ShareSubscription.",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/ShareSubscription"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"ShareSubscriptionProperties": {
"description": "Share subscription property bag.",
"properties": {
"createdAt": {
"description": "Time at which the share subscription was created.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"invitationId": {
"description": "The invitation id.",
"type": "string"
},
"providerEmail": {
"description": "Email of the provider who created the resource",
"readOnly": true,
"type": "string"
},
"providerName": {
"description": "Name of the provider who created the resource",
"readOnly": true,
"type": "string"
},
"providerTenantName": {
"description": "Tenant name of the provider who created the resource",
"readOnly": true,
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the share subscription",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"shareDescription": {
"description": "Description of share",
"readOnly": true,
"type": "string"
},
"shareKind": {
"description": "Kind of share",
"enum": [
"CopyBased",
"InPlace"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "shareKind"
}
},
"shareName": {
"description": "Name of the share",
"readOnly": true,
"type": "string"
},
"shareSubscriptionStatus": {
"description": "Gets the current status of share subscription.",
"enum": [
"Active",
"Revoked",
"SourceDeleted",
"Revoking"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "shareSubscriptionStatus"
}
},
"shareTerms": {
"description": "Terms of a share",
"readOnly": true,
"type": "string"
},
"sourceShareLocation": {
"description": "Source share location.",
"type": "string"
},
"userEmail": {
"description": "Email of the user who created the resource",
"readOnly": true,
"type": "string"
},
"userName": {
"description": "Name of the user who created the resource",
"readOnly": true,
"type": "string"
}
},
"required": [
"invitationId",
"sourceShareLocation"
],
"type": "object"
},
"ShareSubscriptionSynchronization": {
"description": "A ShareSubscriptionSynchronization data transfer object.",
"properties": {
"durationMs": {
"description": "Synchronization duration",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"endTime": {
"description": "End time of synchronization",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"description": "message of Synchronization",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "start time of synchronization",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Raw Status",
"readOnly": true,
"type": "string"
},
"synchronizationId": {
"description": "Synchronization id",
"type": "string"
},
"synchronizationMode": {
"description": "Synchronization Mode",
"enum": [
"Incremental",
"FullSync"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "synchronizationMode"
}
}
},
"required": [
"synchronizationId"
],
"type": "object"
},
"ShareSubscriptionSynchronizationList": {
"description": "A consumer side list of share subscription synchronizations",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/ShareSubscriptionSynchronization"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"ShareSynchronization": {
"description": "A ShareSynchronization data transfer object.",
"properties": {
"consumerEmail": {
"description": "Email of the user who created the synchronization",
"type": "string"
},
"consumerName": {
"description": "Name of the user who created the synchronization",
"type": "string"
},
"consumerTenantName": {
"description": "Tenant name of the consumer who created the synchronization",
"type": "string"
},
"durationMs": {
"description": "synchronization duration",
"format": "int32",
"type": "integer"
},
"endTime": {
"description": "End time of synchronization",
"format": "date-time",
"type": "string"
},
"message": {
"description": "message of synchronization",
"type": "string"
},
"startTime": {
"description": "start time of synchronization",
"format": "date-time",
"type": "string"
},
"status": {
"description": "Raw Status",
"type": "string"
},
"synchronizationId": {
"description": "Synchronization id",
"type": "string"
},
"synchronizationMode": {
"description": "Synchronization mode",
"enum": [
"Incremental",
"FullSync"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "synchronizationMode"
}
}
},
"type": "object"
},
"ShareSynchronizationList": {
"description": "List response for get ShareSynchronization.",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/ShareSynchronization"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"SourceShareSynchronizationSetting": {
"description": "A view of synchronization setting added by the provider",
"discriminator": "kind",
"properties": {
"kind": {
"description": "Kind of synchronization",
"enum": [
"ScheduleBased"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "kind"
}
}
},
"required": [
"kind"
],
"type": "object"
},
"SourceShareSynchronizationSettingList": {
"description": "List response for get source share Synchronization settings",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/SourceShareSynchronizationSetting"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"SqlDBTableDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "A SQL DB table data set.",
"properties": {
"properties": {
"$ref": "#/definitions/SqlDBTableProperties",
"description": "SQL DB table data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"kind"
],
"type": "object",
"x-ms-discriminator-value": "SqlDBTable"
},
"SqlDBTableDataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/DataSetMapping"
}
],
"description": "A SQL DB Table data set mapping.",
"properties": {
"properties": {
"$ref": "#/definitions/SqlDBTableDataSetMappingProperties",
"description": "Sql DB data set mapping properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "SqlDBTable"
},
"SqlDBTableDataSetMappingProperties": {
"description": "Properties of the SQL DB table data set mapping.",
"properties": {
"dataSetId": {
"description": "The id of the source data set.",
"type": "string"
},
"dataSetMappingStatus": {
"description": "Gets the status of the data set mapping.",
"enum": [
"Ok",
"Broken"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetMappingStatus"
}
},
"databaseName": {
"description": "DatabaseName name of the sink data set",
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the data set mapping.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"schemaName": {
"description": "Schema of the table. Default value is dbo.",
"type": "string"
},
"sqlServerResourceId": {
"description": "Resource id of SQL server",
"type": "string"
},
"tableName": {
"description": "SQL DB table name.",
"type": "string"
}
},
"required": [
"databaseName",
"tableName",
"schemaName",
"sqlServerResourceId",
"dataSetId"
],
"type": "object"
},
"SqlDBTableProperties": {
"description": "Properties of the SQL DB table data set.",
"properties": {
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"databaseName": {
"description": "Database name of the source data set",
"type": "string"
},
"schemaName": {
"description": "Schema of the table. Default value is dbo.",
"type": "string"
},
"sqlServerResourceId": {
"description": "Resource id of SQL server",
"type": "string"
},
"tableName": {
"description": "SQL DB table name.",
"type": "string"
}
},
"required": [
"databaseName",
"tableName",
"schemaName",
"sqlServerResourceId"
],
"type": "object"
},
"SqlDWTableDataSet": {
"allOf": [
{
"$ref": "#/definitions/DataSet"
}
],
"description": "A SQL DW table data set.",
"properties": {
"properties": {
"$ref": "#/definitions/SqlDWTableProperties",
"description": "SQL DW table data set properties.",
"x-ms-client-flatten": true
}
},
"required": [
"kind"
],
"type": "object",
"x-ms-discriminator-value": "SqlDWTable"
},
"SqlDWTableDataSetMapping": {
"allOf": [
{
"$ref": "#/definitions/DataSetMapping"
}
],
"description": "A SQL DW Table data set mapping.",
"properties": {
"properties": {
"$ref": "#/definitions/SqlDWTableDataSetMappingProperties",
"description": "Sql DW data set mapping properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties",
"kind"
],
"type": "object",
"x-ms-discriminator-value": "SqlDWTable"
},
"SqlDWTableDataSetMappingProperties": {
"description": "Properties of the SQL DW table data set mapping.",
"properties": {
"dataSetId": {
"description": "The id of the source data set.",
"type": "string"
},
"dataSetMappingStatus": {
"description": "Gets the status of the data set mapping.",
"enum": [
"Ok",
"Broken"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetMappingStatus"
}
},
"dataWarehouseName": {
"description": "DataWarehouse name of the source data set",
"type": "string"
},
"provisioningState": {
"description": "Provisioning state of the data set mapping.",
"enum": [
"Succeeded",
"Creating",
"Deleting",
"Moving",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "provisioningState"
}
},
"schemaName": {
"description": "Schema of the table. Default value is dbo.",
"type": "string"
},
"sqlServerResourceId": {
"description": "Resource id of SQL server",
"type": "string"
},
"tableName": {
"description": "SQL DW table name.",
"type": "string"
}
},
"required": [
"dataWarehouseName",
"tableName",
"schemaName",
"sqlServerResourceId",
"dataSetId"
],
"type": "object"
},
"SqlDWTableProperties": {
"description": "Properties of the SQL DW table data set.",
"properties": {
"dataSetId": {
"description": "Unique id for identifying a data set resource",
"readOnly": true,
"type": "string"
},
"dataWarehouseName": {
"description": "DataWarehouse name of the source data set",
"type": "string"
},
"schemaName": {
"description": "Schema of the table. Default value is dbo.",
"type": "string"
},
"sqlServerResourceId": {
"description": "Resource id of SQL server",
"type": "string"
},
"tableName": {
"description": "SQL DW table name.",
"type": "string"
}
},
"required": [
"dataWarehouseName",
"tableName",
"schemaName",
"sqlServerResourceId"
],
"type": "object"
},
"SynchronizationDetails": {
"description": "Synchronization details at data set level",
"properties": {
"dataSetId": {
"description": "Id of data set",
"readOnly": true,
"type": "string"
},
"dataSetType": {
"description": "Type of the data set",
"enum": [
"Blob",
"Container",
"BlobFolder",
"AdlsGen2FileSystem",
"AdlsGen2Folder",
"AdlsGen2File",
"AdlsGen1Folder",
"AdlsGen1File",
"KustoCluster",
"KustoDatabase",
"SqlDBTable",
"SqlDWTable"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "dataSetType"
}
},
"durationMs": {
"description": "Duration of data set level copy",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"endTime": {
"description": "End time of data set level copy",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"filesRead": {
"description": "The number of files read from the source data set",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"filesWritten": {
"description": "The number of files written into the sink data set",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"message": {
"description": "Error message if any",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the data set",
"readOnly": true,
"type": "string"
},
"rowsCopied": {
"description": "The number of files copied into the sink data set",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"rowsRead": {
"description": "The number of rows read from the source data set.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"sizeRead": {
"description": "The size of the data read from the source data set in bytes",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"sizeWritten": {
"description": "The size of the data written into the sink data set in bytes",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"startTime": {
"description": "Start time of data set level copy",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Raw Status",
"readOnly": true,
"type": "string"
},
"vCore": {
"description": "The vCore units consumed for the data set synchronization",
"format": "int64",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"SynchronizationDetailsList": {
"description": "details of synchronization",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/SynchronizationDetails"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"SynchronizationSetting": {
"allOf": [
{
"$ref": "#/definitions/ProxyDto"
}
],
"description": "A Synchronization Setting data transfer object.",
"discriminator": "kind",
"properties": {
"kind": {
"description": "Kind of synchronization",
"enum": [
"ScheduleBased"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "kind"
}
}
},
"required": [
"kind"
],
"type": "object"
},
"SynchronizationSettingList": {
"description": "List response for get Synchronization settings",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/SynchronizationSetting"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
},
"Synchronize": {
"description": "Payload for the synchronizing the data.",
"properties": {
"synchronizationMode": {
"description": "Mode of synchronization used in triggers and snapshot sync. Incremental by default",
"enum": [
"Incremental",
"FullSync"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "synchronizationMode"
}
}
},
"type": "object"
},
"Trigger": {
"allOf": [
{
"$ref": "#/definitions/ProxyDto"
}
],
"description": "A Trigger data transfer object.",
"discriminator": "kind",
"properties": {
"kind": {
"description": "Kind of synchronization",
"enum": [
"ScheduleBased"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "kind"
}
}
},
"required": [
"kind"
],
"type": "object"
},
"TriggerList": {
"description": "List response for get triggers",
"properties": {
"nextLink": {
"description": "The Url of next result page.",
"type": "string"
},
"value": {
"description": "Collection of items of type DataTransferObjects.",
"items": {
"$ref": "#/definitions/Trigger"
},
"type": "array",
"uniqueItems": false
}
},
"required": [
"value"
],
"type": "object"
}
}
}