Microsoft.DataShare (stable:2021-08-01)

2025/09/19 • 53 new, 53 deleted methods

Accounts_ListBySubscription (new)
Description :  List Accounts in Subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataShare/accounts
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_Get (new)
Description :  Get an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_Create (new)
Description :  Create an account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
account:
{
Description: The account payload. ,
Required: True ,
}
{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_Delete (new)
Description :  DeleteAccount
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error property when status is failed. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation state of the long running operation. ,
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_Update (new)
Description :  Patch an account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
accountUpdateParameters:
{
Description: The account update parameters. ,
Required: True ,
}
{
tags:
{
Description: Tags on the azure resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_ListByResourceGroup (new)
Description :  List Accounts in ResourceGroup
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ConsumerInvitations_ListInvitations (new)
Description :  Lists invitations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataShare/listInvitations
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties on the account ,
Required: True ,
}
{
dataSetCount:
{
Description: Number of data sets in a share ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description shared when the invitation was created ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date for the share subscription created by accepting the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: Unique id of the invitation. ,
Required: True ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: invitation location ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
shareName:
{
Description: Gets the source share Name. ,
Required: False ,
}
string ,
termsOfUse:
{
Description: Terms of use shared when the invitation was created ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ConsumerInvitations_Get (new)
Description :  Get an invitation
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataShare/locations/{location}/consumerInvitations/{invitationId}
{
location:
{
Description: Location of the invitation ,
Required: True ,
}
string ,
invitationId:
{
Description: An invitation id ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the account ,
Required: True ,
}
{
dataSetCount:
{
Description: Number of data sets in a share ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description shared when the invitation was created ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date for the share subscription created by accepting the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: Unique id of the invitation. ,
Required: True ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: invitation location ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
shareName:
{
Description: Gets the source share Name. ,
Required: False ,
}
string ,
termsOfUse:
{
Description: Terms of use shared when the invitation was created ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ConsumerInvitations_RejectInvitation (new)
Description :  Reject an invitation
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.DataShare/locations/{location}/rejectInvitation
{
location:
{
Description: Location of the invitation ,
Required: True ,
}
string ,
invitation:
{
Description: An invitation payload ,
Required: True ,
}
{
properties:
{
Description: Properties on the account ,
Required: True ,
}
{
dataSetCount:
{
Description: Number of data sets in a share ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description shared when the invitation was created ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date for the share subscription created by accepting the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: Unique id of the invitation. ,
Required: True ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: invitation location ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
shareName:
{
Description: Gets the source share Name. ,
Required: False ,
}
string ,
termsOfUse:
{
Description: Terms of use shared when the invitation was created ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the account ,
Required: True ,
}
{
dataSetCount:
{
Description: Number of data sets in a share ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description shared when the invitation was created ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date for the share subscription created by accepting the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: Unique id of the invitation. ,
Required: True ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: invitation location ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
shareName:
{
Description: Gets the source share Name. ,
Required: False ,
}
string ,
termsOfUse:
{
Description: Terms of use shared when the invitation was created ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSets_Get (new)
Description :  Get a DataSet in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets/{dataSetName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
dataSetName:
{
Description: The name of the dataSet. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of data set. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSets_Create (new)
Description :  Create a DataSet
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets/{dataSetName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share to add the data set to. ,
Required: True ,
}
string ,
dataSetName:
{
Description: The name of the dataSet. ,
Required: True ,
}
string ,
dataSet:
{
Description: The new data set information. ,
Required: True ,
}
{
kind:
{
Description: Kind of data set. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Kind of data set. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of data set. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSets_Delete (new)
Description :  Delete a DataSet in a share
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets/{dataSetName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
dataSetName:
{
Description: The name of the dataSet. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSets_ListByShare (new)
Description :  List DataSets in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Kind of data set. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSetMappings_Get (new)
Description :  Get a DataSetMapping in a shareSubscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings/{dataSetMappingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
dataSetMappingName:
{
Description: The name of the dataSetMapping. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of data set mapping. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSetMappings_Create (new)
Description :  Create a DataSetMapping
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings/{dataSetMappingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription which will hold the data set sink. ,
Required: True ,
}
string ,
dataSetMappingName:
{
Description: The name of the data set mapping to be created. ,
Required: True ,
}
string ,
dataSetMapping:
{
Description: Destination data set configuration details. ,
Required: True ,
}
{
kind:
{
Description: Kind of data set mapping. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Kind of data set mapping. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of data set mapping. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSetMappings_Delete (new)
Description :  Delete a DataSetMapping in a shareSubscription
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings/{dataSetMappingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
dataSetMappingName:
{
Description: The name of the dataSetMapping. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSetMappings_ListByShareSubscription (new)
Description :  List DataSetMappings in a share subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Kind of data set mapping. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
EmailRegistrations_ActivateEmail (new)
Description :  Activate the email registration for the current tenant
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.DataShare/locations/{location}/activateEmail
{
location:
{
Description: Location of the activation. ,
Required: True ,
}
string ,
emailRegistration:
{
Description: The payload for tenant domain activation. ,
Required: True ,
}
{
activationCode:
{
Description: Activation code for the registration ,
Required: False ,
}
string ,
activationExpirationDate:
{
Description: Date of the activation expiration ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Registration status ,
Enum:
{
ActivationPending: No description available. ,
Activated: No description available. ,
ActivationAttemptsExhausted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant to register ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
activationCode:
{
Description: Activation code for the registration ,
Required: False ,
}
string ,
activationExpirationDate:
{
Description: Date of the activation expiration ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Registration status ,
Enum:
{
ActivationPending: No description available. ,
Activated: No description available. ,
ActivationAttemptsExhausted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant to register ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
EmailRegistrations_RegisterEmail (new)
Description :  Register an email for the current tenant
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.DataShare/locations/{location}/registerEmail
{
location:
{
Description: Location of the registration ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
activationCode:
{
Description: Activation code for the registration ,
Required: False ,
}
string ,
activationExpirationDate:
{
Description: Date of the activation expiration ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Registration status ,
Enum:
{
ActivationPending: No description available. ,
Activated: No description available. ,
ActivationAttemptsExhausted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant to register ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Invitations_Get (new)
Description :  Get an invitation in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
invitationName:
{
Description: The name of the invitation. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the Invitation ,
Required: False ,
}
{
expirationDate:
{
Description: The expiration date for the invitation and share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: unique invitation id ,
Required: False ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
targetActiveDirectoryId:
{
Description: The target Azure AD Id. Can't be combined with email. ,
Required: False ,
}
string ,
targetEmail:
{
Description: The email the invitation is directed to. ,
Required: False ,
}
string ,
targetObjectId:
{
Description: The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Invitations_Create (new)
Description :  Create an invitation
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share to send the invitation for. ,
Required: True ,
}
string ,
invitationName:
{
Description: The name of the invitation. ,
Required: True ,
}
string ,
invitation:
{
Description: Invitation details. ,
Required: True ,
}
{
properties:
{
Description: Properties on the Invitation ,
Required: False ,
}
{
expirationDate:
{
Description: The expiration date for the invitation and share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: unique invitation id ,
Required: False ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
targetActiveDirectoryId:
{
Description: The target Azure AD Id. Can't be combined with email. ,
Required: False ,
}
string ,
targetEmail:
{
Description: The email the invitation is directed to. ,
Required: False ,
}
string ,
targetObjectId:
{
Description: The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties on the Invitation ,
Required: False ,
}
{
expirationDate:
{
Description: The expiration date for the invitation and share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: unique invitation id ,
Required: False ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
targetActiveDirectoryId:
{
Description: The target Azure AD Id. Can't be combined with email. ,
Required: False ,
}
string ,
targetEmail:
{
Description: The email the invitation is directed to. ,
Required: False ,
}
string ,
targetObjectId:
{
Description: The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the Invitation ,
Required: False ,
}
{
expirationDate:
{
Description: The expiration date for the invitation and share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: unique invitation id ,
Required: False ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
targetActiveDirectoryId:
{
Description: The target Azure AD Id. Can't be combined with email. ,
Required: False ,
}
string ,
targetEmail:
{
Description: The email the invitation is directed to. ,
Required: False ,
}
string ,
targetObjectId:
{
Description: The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Invitations_Delete (new)
Description :  Delete an invitation in a share
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
invitationName:
{
Description: The name of the invitation. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Invitations_ListByShare (new)
Description :  List invitations in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties on the Invitation ,
Required: False ,
}
{
expirationDate:
{
Description: The expiration date for the invitation and share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: unique invitation id ,
Required: False ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
targetActiveDirectoryId:
{
Description: The target Azure AD Id. Can't be combined with email. ,
Required: False ,
}
string ,
targetEmail:
{
Description: The email the invitation is directed to. ,
Required: False ,
}
string ,
targetObjectId:
{
Description: The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  List of available operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataShare/operations
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
display:
{
Description: Properties on the operation ,
Required: False ,
}
{
description:
{
Description: Description of the operation for display purposes ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation for display purposes ,
Required: False ,
}
string ,
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type for display purposes ,
Required: False ,
}
string ,
}
,
name:
{
Description: Operation name for display purposes ,
Required: False ,
}
string ,
origin:
{
Description: origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: properties for the operation meta info ,
Required: False ,
}
{
serviceSpecification:
{
Description: meta service specification ,
Required: False ,
}
{
logSpecifications:
{
Description: log specifications for the operation ,
Required: False ,
}
[
{
blobDuration:
{
Description: blob duration of the log ,
Required: False ,
}
string ,
displayName:
{
Description: localized name of the log category ,
Required: False ,
}
string ,
name:
{
Description: name of the log category ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: metric specifications for the operation ,
Required: False ,
}
[
{
aggregationType:
{
Description: aggregation type of metric ,
Required: False ,
}
string ,
dimensions:
{
Description: properties for dimension ,
Required: False ,
}
[
{
displayName:
{
Description: localized display name of the dimension to customer ,
Required: False ,
}
string ,
name:
{
Description: dimension name ,
Required: False ,
}
string ,
}
,
]
,
displayDescription:
{
Description: description of the metric ,
Required: False ,
}
string ,
displayName:
{
Description: localized name of the metric ,
Required: False ,
}
string ,
enableRegionalMdmAccount:
{
Description: enable regional mdm account ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: fill gap with zero ,
Required: False ,
}
boolean ,
internalMetricName:
{
Description: internal metric name ,
Required: False ,
}
string ,
name:
{
Description: name of the metric ,
Required: False ,
}
string ,
resourceIdDimensionNameOverride:
{
Description: dimension name use to replace resource id if specified ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: supported aggregation types ,
Required: False ,
}
[
string ,
]
,
supportedTimeGrainTypes:
{
Description: supported time grain types ,
Required: False ,
}
[
string ,
]
,
unit:
{
Description: units for the metric ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_ListSynchronizationDetails (new)
Description :  List synchronization details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizationDetails
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
shareSynchronization:
{
Description: Share Synchronization payload. ,
Required: True ,
}
{
consumerEmail:
{
Description: Email of the user who created the synchronization ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the user who created the synchronization ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the synchronization ,
Required: False ,
}
string ,
durationMs:
{
Description: synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: False ,
}
string ,
synchronizationMode:
{
Description: Synchronization mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
dataSetId:
{
Description: Id of data set ,
Required: False ,
}
string ,
dataSetType:
{
Description: Type of the data set ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: False ,
}
enum ,
durationMs:
{
Description: Duration of data set level copy ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of data set level copy ,
Format: date-time ,
Required: False ,
}
string ,
filesRead:
{
Description: The number of files read from the source data set ,
Format: int64 ,
Required: False ,
}
integer ,
filesWritten:
{
Description: The number of files written into the sink data set ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: Error message if any ,
Required: False ,
}
string ,
name:
{
Description: Name of the data set ,
Required: False ,
}
string ,
rowsCopied:
{
Description: The number of files copied into the sink data set ,
Format: int64 ,
Required: False ,
}
integer ,
rowsRead:
{
Description: The number of rows read from the source data set. ,
Format: int64 ,
Required: False ,
}
integer ,
sizeRead:
{
Description: The size of the data read from the source data set in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
sizeWritten:
{
Description: The size of the data written into the sink data set in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: Start time of data set level copy ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
vCore:
{
Description: The vCore units consumed for the data set synchronization ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_ListSynchronizations (new)
Description :  List synchronizations of a share
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
consumerEmail:
{
Description: Email of the user who created the synchronization ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the user who created the synchronization ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the synchronization ,
Required: False ,
}
string ,
durationMs:
{
Description: synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: False ,
}
string ,
synchronizationMode:
{
Description: Synchronization mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ProviderShareSubscriptions_Adjust (new)
Description :  Adjust a share subscription's expiration date in a provider share
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/adjust
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
providerShareSubscriptionId:
{
Description: To locate shareSubscription ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
providerShareSubscription:
{
Description: The provider share subscription ,
Required: True ,
}
{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ProviderShareSubscriptions_Reinstate (new)
Description :  Reinstate share subscription in a provider share
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/reinstate
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
providerShareSubscriptionId:
{
Description: To locate shareSubscription ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
providerShareSubscription:
{
Description: The provider share subscription ,
Required: True ,
}
{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ProviderShareSubscriptions_Revoke (new)
Description :  Revoke share subscription in a provider share
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/revoke
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
providerShareSubscriptionId:
{
Description: To locate shareSubscription ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ProviderShareSubscriptions_GetByShare (new)
Description :  Get share subscription in a provider share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
providerShareSubscriptionId:
{
Description: To locate shareSubscription ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ProviderShareSubscriptions_ListByShare (new)
Description :  List share subscriptions in a provider share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation Token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_Get (new)
Description :  Get a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share to retrieve. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the share ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the share was created. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Share description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareKind:
{
Description: Share kind. ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
terms:
{
Description: Share terms. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_Create (new)
Description :  Create a share
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
share:
{
Description: The share payload ,
Required: True ,
}
{
properties:
{
Description: Properties on the share ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the share was created. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Share description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareKind:
{
Description: Share kind. ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
terms:
{
Description: Share terms. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties on the share ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the share was created. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Share description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareKind:
{
Description: Share kind. ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
terms:
{
Description: Share terms. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the share ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the share was created. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Share description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareKind:
{
Description: Share kind. ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
terms:
{
Description: Share terms. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_Delete (new)
Description :  Delete a share
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error property when status is failed. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation state of the long running operation. ,
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_ListByAccount (new)
Description :  List shares in an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation Token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties on the share ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the share was created. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Share description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareKind:
{
Description: Share kind. ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
terms:
{
Description: Share terms. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_CancelSynchronization (new)
Description :  Request to cancel a synchronization.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/cancelSynchronization
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
shareSubscriptionSynchronization:
{
Description: Share Subscription Synchronization payload. ,
Required: True ,
}
{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ConsumerSourceDataSets_ListByShareSubscription (new)
Description :  Get source dataSets of a shareSubscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/consumerSourceDataSets
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: source dataSet properties ,
Required: False ,
}
{
dataSetId:
{
Description: DataSet Id ,
Required: False ,
}
string ,
dataSetLocation:
{
Description: Location of the data set. ,
Required: False ,
}
string ,
dataSetName:
{
Description: DataSet name ,
Required: False ,
}
string ,
dataSetPath:
{
Description: DataSet path ,
Required: False ,
}
string ,
dataSetType:
{
Description: Type of data set ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_ListSourceShareSynchronizationSettings (new)
Description :  Get synchronization settings set on a share
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSourceShareSynchronizationSettings
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Kind of synchronization setting on share. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_ListSynchronizationDetails (new)
Description :  List synchronization details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription. ,
Required: True ,
}
string ,
shareSubscriptionSynchronization:
{
Description: Share Subscription Synchronization payload. ,
Required: True ,
}
{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
dataSetId:
{
Description: Id of data set ,
Required: False ,
}
string ,
dataSetType:
{
Description: Type of the data set ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: False ,
}
enum ,
durationMs:
{
Description: Duration of data set level copy ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of data set level copy ,
Format: date-time ,
Required: False ,
}
string ,
filesRead:
{
Description: The number of files read from the source data set ,
Format: int64 ,
Required: False ,
}
integer ,
filesWritten:
{
Description: The number of files written into the sink data set ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: Error message if any ,
Required: False ,
}
string ,
name:
{
Description: Name of the data set ,
Required: False ,
}
string ,
rowsCopied:
{
Description: The number of files copied into the sink data set ,
Format: int64 ,
Required: False ,
}
integer ,
rowsRead:
{
Description: The number of rows read from the source data set. ,
Format: int64 ,
Required: False ,
}
integer ,
sizeRead:
{
Description: The size of the data read from the source data set in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
sizeWritten:
{
Description: The size of the data written into the sink data set in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: Start time of data set level copy ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
vCore:
{
Description: The vCore units consumed for the data set synchronization ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_ListSynchronizations (new)
Description :  List synchronizations of a share subscription
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizations
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_Synchronize (new)
Description :  Initiate a copy
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/synchronize
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of share subscription ,
Required: True ,
}
string ,
synchronize:
{
Description: Synchronize payload ,
Required: True ,
}
{
synchronizationMode:
{
Description: Mode of synchronization used in triggers and snapshot sync. Incremental by default ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_Get (new)
Description :  Get a shareSubscription in an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the share subscription ,
Required: True ,
}
{
createdAt:
{
Description: Time at which the share subscription was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of the share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: The invitation id. ,
Required: True ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the share subscription ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareDescription:
{
Description: Description of share ,
Required: False ,
}
string ,
shareKind:
{
Description: Kind of share ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Name of the share ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the current status of share subscription. ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
shareTerms:
{
Description: Terms of a share ,
Required: False ,
}
string ,
sourceShareLocation:
{
Description: Source share location. ,
Required: True ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_Create (new)
Description :  Create a shareSubscription in an account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
shareSubscription:
{
Description: create parameters for shareSubscription ,
Required: True ,
}
{
properties:
{
Description: Properties on the share subscription ,
Required: True ,
}
{
createdAt:
{
Description: Time at which the share subscription was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of the share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: The invitation id. ,
Required: True ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the share subscription ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareDescription:
{
Description: Description of share ,
Required: False ,
}
string ,
shareKind:
{
Description: Kind of share ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Name of the share ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the current status of share subscription. ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
shareTerms:
{
Description: Terms of a share ,
Required: False ,
}
string ,
sourceShareLocation:
{
Description: Source share location. ,
Required: True ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the share subscription ,
Required: True ,
}
{
createdAt:
{
Description: Time at which the share subscription was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of the share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: The invitation id. ,
Required: True ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the share subscription ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareDescription:
{
Description: Description of share ,
Required: False ,
}
string ,
shareKind:
{
Description: Kind of share ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Name of the share ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the current status of share subscription. ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
shareTerms:
{
Description: Terms of a share ,
Required: False ,
}
string ,
sourceShareLocation:
{
Description: Source share location. ,
Required: True ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties on the share subscription ,
Required: True ,
}
{
createdAt:
{
Description: Time at which the share subscription was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of the share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: The invitation id. ,
Required: True ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the share subscription ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareDescription:
{
Description: Description of share ,
Required: False ,
}
string ,
shareKind:
{
Description: Kind of share ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Name of the share ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the current status of share subscription. ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
shareTerms:
{
Description: Terms of a share ,
Required: False ,
}
string ,
sourceShareLocation:
{
Description: Source share location. ,
Required: True ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_Delete (new)
Description :  Delete a shareSubscription in an account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error property when status is failed. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation state of the long running operation. ,
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_ListByAccount (new)
Description :  List share subscriptions in an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation Token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties on the share subscription ,
Required: True ,
}
{
createdAt:
{
Description: Time at which the share subscription was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of the share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: The invitation id. ,
Required: True ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the share subscription ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareDescription:
{
Description: Description of share ,
Required: False ,
}
string ,
shareKind:
{
Description: Kind of share ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Name of the share ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the current status of share subscription. ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
shareTerms:
{
Description: Terms of a share ,
Required: False ,
}
string ,
sourceShareLocation:
{
Description: Source share location. ,
Required: True ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SynchronizationSettings_Get (new)
Description :  Get a synchronizationSetting in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
synchronizationSettingName:
{
Description: The name of the synchronizationSetting. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of synchronization setting. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SynchronizationSettings_Create (new)
Description :  Create a synchronizationSetting
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share to add the synchronization setting to. ,
Required: True ,
}
string ,
synchronizationSettingName:
{
Description: The name of the synchronizationSetting. ,
Required: True ,
}
string ,
synchronizationSetting:
{
Description: The new synchronization setting information. ,
Required: True ,
}
{
kind:
{
Description: Kind of synchronization setting. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Kind of synchronization setting. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of synchronization setting. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SynchronizationSettings_Delete (new)
Description :  Delete a synchronizationSetting in a share
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
synchronizationSettingName:
{
Description: The name of the synchronizationSetting . ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error property when status is failed. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation state of the long running operation. ,
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SynchronizationSettings_ListByShare (new)
Description :  List synchronizationSettings in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Kind of synchronization setting. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Triggers_Get (new)
Description :  Get a Trigger in a shareSubscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of synchronization on trigger. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Triggers_Create (new)
Description :  Create a Trigger
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription which will hold the data set sink. ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
trigger:
{
Description: Trigger details. ,
Required: True ,
}
{
kind:
{
Description: Kind of synchronization on trigger. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Kind of synchronization on trigger. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of synchronization on trigger. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Triggers_Delete (new)
Description :  Delete a Trigger in a shareSubscription
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error property when status is failed. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation state of the long running operation. ,
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Triggers_ListByShareSubscription (new)
Description :  List Triggers in a share subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/triggers
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Kind of synchronization on trigger. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_ListBySubscription (removed)
Description :  List Accounts in Subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DataShare/accounts
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_Get (removed)
Description :  Get an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_Create (removed)
Description :  Create an account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
account:
{
Description: The account payload. ,
Required: True ,
}
{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_Delete (removed)
Description :  DeleteAccount
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error property when status is failed. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation state of the long running operation. ,
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_Update (removed)
Description :  Patch an account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
accountUpdateParameters:
{
Description: The account update parameters. ,
Required: True ,
}
{
tags:
{
Description: Tags on the azure resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Accounts_ListByResourceGroup (removed)
Description :  List Accounts in ResourceGroup
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
identity:
{
Description: Identity Info on the Account ,
Required: True ,
}
{
principalId:
{
Description: service principal Id ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
type:
{
Description: Identity Type ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties on the account ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the account was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the Account ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ConsumerInvitations_ListInvitations (removed)
Description :  Lists invitations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataShare/listInvitations
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties on the account ,
Required: True ,
}
{
dataSetCount:
{
Description: Number of data sets in a share ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description shared when the invitation was created ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date for the share subscription created by accepting the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: Unique id of the invitation. ,
Required: True ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: invitation location ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
shareName:
{
Description: Gets the source share Name. ,
Required: False ,
}
string ,
termsOfUse:
{
Description: Terms of use shared when the invitation was created ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ConsumerInvitations_Get (removed)
Description :  Get an invitation
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataShare/locations/{location}/consumerInvitations/{invitationId}
{
location:
{
Description: Location of the invitation ,
Required: True ,
}
string ,
invitationId:
{
Description: An invitation id ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the account ,
Required: True ,
}
{
dataSetCount:
{
Description: Number of data sets in a share ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description shared when the invitation was created ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date for the share subscription created by accepting the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: Unique id of the invitation. ,
Required: True ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: invitation location ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
shareName:
{
Description: Gets the source share Name. ,
Required: False ,
}
string ,
termsOfUse:
{
Description: Terms of use shared when the invitation was created ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ConsumerInvitations_RejectInvitation (removed)
Description :  Reject an invitation
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.DataShare/locations/{location}/rejectInvitation
{
location:
{
Description: Location of the invitation ,
Required: True ,
}
string ,
invitation:
{
Description: An invitation payload ,
Required: True ,
}
{
properties:
{
Description: Properties on the account ,
Required: True ,
}
{
dataSetCount:
{
Description: Number of data sets in a share ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description shared when the invitation was created ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date for the share subscription created by accepting the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: Unique id of the invitation. ,
Required: True ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: invitation location ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
shareName:
{
Description: Gets the source share Name. ,
Required: False ,
}
string ,
termsOfUse:
{
Description: Terms of use shared when the invitation was created ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the account ,
Required: True ,
}
{
dataSetCount:
{
Description: Number of data sets in a share ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Description shared when the invitation was created ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date for the share subscription created by accepting the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: Unique id of the invitation. ,
Required: True ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: invitation location ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
shareName:
{
Description: Gets the source share Name. ,
Required: False ,
}
string ,
termsOfUse:
{
Description: Terms of use shared when the invitation was created ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSets_Get (removed)
Description :  Get a DataSet in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets/{dataSetName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
dataSetName:
{
Description: The name of the dataSet. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of data set. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSets_Create (removed)
Description :  Create a DataSet
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets/{dataSetName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share to add the data set to. ,
Required: True ,
}
string ,
dataSetName:
{
Description: The name of the dataSet. ,
Required: True ,
}
string ,
dataSet:
{
Description: The new data set information. ,
Required: True ,
}
{
kind:
{
Description: Kind of data set. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Kind of data set. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of data set. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSets_Delete (removed)
Description :  Delete a DataSet in a share
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets/{dataSetName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
dataSetName:
{
Description: The name of the dataSet. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSets_ListByShare (removed)
Description :  List DataSets in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Kind of data set. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSetMappings_Get (removed)
Description :  Get a DataSetMapping in a shareSubscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings/{dataSetMappingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
dataSetMappingName:
{
Description: The name of the dataSetMapping. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of data set mapping. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSetMappings_Create (removed)
Description :  Create a DataSetMapping
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings/{dataSetMappingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription which will hold the data set sink. ,
Required: True ,
}
string ,
dataSetMappingName:
{
Description: The name of the data set mapping to be created. ,
Required: True ,
}
string ,
dataSetMapping:
{
Description: Destination data set configuration details. ,
Required: True ,
}
{
kind:
{
Description: Kind of data set mapping. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Kind of data set mapping. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of data set mapping. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSetMappings_Delete (removed)
Description :  Delete a DataSetMapping in a shareSubscription
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings/{dataSetMappingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
dataSetMappingName:
{
Description: The name of the dataSetMapping. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
DataSetMappings_ListByShareSubscription (removed)
Description :  List DataSetMappings in a share subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/dataSetMappings
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Kind of data set mapping. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
EmailRegistrations_ActivateEmail (removed)
Description :  Activate the email registration for the current tenant
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.DataShare/locations/{location}/activateEmail
{
location:
{
Description: Location of the activation. ,
Required: True ,
}
string ,
emailRegistration:
{
Description: The payload for tenant domain activation. ,
Required: True ,
}
{
activationCode:
{
Description: Activation code for the registration ,
Required: False ,
}
string ,
activationExpirationDate:
{
Description: Date of the activation expiration ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Registration status ,
Enum:
{
ActivationPending: No description available. ,
Activated: No description available. ,
ActivationAttemptsExhausted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant to register ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
activationCode:
{
Description: Activation code for the registration ,
Required: False ,
}
string ,
activationExpirationDate:
{
Description: Date of the activation expiration ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Registration status ,
Enum:
{
ActivationPending: No description available. ,
Activated: No description available. ,
ActivationAttemptsExhausted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant to register ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
EmailRegistrations_RegisterEmail (removed)
Description :  Register an email for the current tenant
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.DataShare/locations/{location}/registerEmail
{
location:
{
Description: Location of the registration ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
activationCode:
{
Description: Activation code for the registration ,
Required: False ,
}
string ,
activationExpirationDate:
{
Description: Date of the activation expiration ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Registration status ,
Enum:
{
ActivationPending: No description available. ,
Activated: No description available. ,
ActivationAttemptsExhausted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant to register ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Invitations_Get (removed)
Description :  Get an invitation in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
invitationName:
{
Description: The name of the invitation. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the Invitation ,
Required: False ,
}
{
expirationDate:
{
Description: The expiration date for the invitation and share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: unique invitation id ,
Required: False ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
targetActiveDirectoryId:
{
Description: The target Azure AD Id. Can't be combined with email. ,
Required: False ,
}
string ,
targetEmail:
{
Description: The email the invitation is directed to. ,
Required: False ,
}
string ,
targetObjectId:
{
Description: The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Invitations_Create (removed)
Description :  Create an invitation
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share to send the invitation for. ,
Required: True ,
}
string ,
invitationName:
{
Description: The name of the invitation. ,
Required: True ,
}
string ,
invitation:
{
Description: Invitation details. ,
Required: True ,
}
{
properties:
{
Description: Properties on the Invitation ,
Required: False ,
}
{
expirationDate:
{
Description: The expiration date for the invitation and share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: unique invitation id ,
Required: False ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
targetActiveDirectoryId:
{
Description: The target Azure AD Id. Can't be combined with email. ,
Required: False ,
}
string ,
targetEmail:
{
Description: The email the invitation is directed to. ,
Required: False ,
}
string ,
targetObjectId:
{
Description: The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties on the Invitation ,
Required: False ,
}
{
expirationDate:
{
Description: The expiration date for the invitation and share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: unique invitation id ,
Required: False ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
targetActiveDirectoryId:
{
Description: The target Azure AD Id. Can't be combined with email. ,
Required: False ,
}
string ,
targetEmail:
{
Description: The email the invitation is directed to. ,
Required: False ,
}
string ,
targetObjectId:
{
Description: The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the Invitation ,
Required: False ,
}
{
expirationDate:
{
Description: The expiration date for the invitation and share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: unique invitation id ,
Required: False ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
targetActiveDirectoryId:
{
Description: The target Azure AD Id. Can't be combined with email. ,
Required: False ,
}
string ,
targetEmail:
{
Description: The email the invitation is directed to. ,
Required: False ,
}
string ,
targetObjectId:
{
Description: The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Invitations_Delete (removed)
Description :  Delete an invitation in a share
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
invitationName:
{
Description: The name of the invitation. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Invitations_ListByShare (removed)
Description :  List invitations in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: The continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties on the Invitation ,
Required: False ,
}
{
expirationDate:
{
Description: The expiration date for the invitation and share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: unique invitation id ,
Required: False ,
}
string ,
invitationStatus:
{
Description: The status of the invitation. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Rejected: No description available. ,
Withdrawn: No description available. ,
}
,
Required: False ,
}
enum ,
respondedAt:
{
Description: The time the recipient responded to the invitation. ,
Format: date-time ,
Required: False ,
}
string ,
sentAt:
{
Description: Gets the time at which the invitation was sent. ,
Format: date-time ,
Required: False ,
}
string ,
targetActiveDirectoryId:
{
Description: The target Azure AD Id. Can't be combined with email. ,
Required: False ,
}
string ,
targetEmail:
{
Description: The email the invitation is directed to. ,
Required: False ,
}
string ,
targetObjectId:
{
Description: The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  List of available operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DataShare/operations
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
display:
{
Description: Properties on the operation ,
Required: False ,
}
{
description:
{
Description: Description of the operation for display purposes ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation for display purposes ,
Required: False ,
}
string ,
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type for display purposes ,
Required: False ,
}
string ,
}
,
name:
{
Description: Operation name for display purposes ,
Required: False ,
}
string ,
origin:
{
Description: origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: properties for the operation meta info ,
Required: False ,
}
{
serviceSpecification:
{
Description: meta service specification ,
Required: False ,
}
{
logSpecifications:
{
Description: log specifications for the operation ,
Required: False ,
}
[
{
blobDuration:
{
Description: blob duration of the log ,
Required: False ,
}
string ,
displayName:
{
Description: localized name of the log category ,
Required: False ,
}
string ,
name:
{
Description: name of the log category ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: metric specifications for the operation ,
Required: False ,
}
[
{
aggregationType:
{
Description: aggregation type of metric ,
Required: False ,
}
string ,
dimensions:
{
Description: properties for dimension ,
Required: False ,
}
[
{
displayName:
{
Description: localized display name of the dimension to customer ,
Required: False ,
}
string ,
name:
{
Description: dimension name ,
Required: False ,
}
string ,
}
,
]
,
displayDescription:
{
Description: description of the metric ,
Required: False ,
}
string ,
displayName:
{
Description: localized name of the metric ,
Required: False ,
}
string ,
enableRegionalMdmAccount:
{
Description: enable regional mdm account ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: fill gap with zero ,
Required: False ,
}
boolean ,
internalMetricName:
{
Description: internal metric name ,
Required: False ,
}
string ,
name:
{
Description: name of the metric ,
Required: False ,
}
string ,
resourceIdDimensionNameOverride:
{
Description: dimension name use to replace resource id if specified ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: supported aggregation types ,
Required: False ,
}
[
string ,
]
,
supportedTimeGrainTypes:
{
Description: supported time grain types ,
Required: False ,
}
[
string ,
]
,
unit:
{
Description: units for the metric ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_ListSynchronizationDetails (removed)
Description :  List synchronization details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizationDetails
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
shareSynchronization:
{
Description: Share Synchronization payload. ,
Required: True ,
}
{
consumerEmail:
{
Description: Email of the user who created the synchronization ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the user who created the synchronization ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the synchronization ,
Required: False ,
}
string ,
durationMs:
{
Description: synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: False ,
}
string ,
synchronizationMode:
{
Description: Synchronization mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
dataSetId:
{
Description: Id of data set ,
Required: False ,
}
string ,
dataSetType:
{
Description: Type of the data set ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: False ,
}
enum ,
durationMs:
{
Description: Duration of data set level copy ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of data set level copy ,
Format: date-time ,
Required: False ,
}
string ,
filesRead:
{
Description: The number of files read from the source data set ,
Format: int64 ,
Required: False ,
}
integer ,
filesWritten:
{
Description: The number of files written into the sink data set ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: Error message if any ,
Required: False ,
}
string ,
name:
{
Description: Name of the data set ,
Required: False ,
}
string ,
rowsCopied:
{
Description: The number of files copied into the sink data set ,
Format: int64 ,
Required: False ,
}
integer ,
rowsRead:
{
Description: The number of rows read from the source data set. ,
Format: int64 ,
Required: False ,
}
integer ,
sizeRead:
{
Description: The size of the data read from the source data set in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
sizeWritten:
{
Description: The size of the data written into the sink data set in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: Start time of data set level copy ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
vCore:
{
Description: The vCore units consumed for the data set synchronization ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_ListSynchronizations (removed)
Description :  List synchronizations of a share
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
consumerEmail:
{
Description: Email of the user who created the synchronization ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the user who created the synchronization ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the synchronization ,
Required: False ,
}
string ,
durationMs:
{
Description: synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: False ,
}
string ,
synchronizationMode:
{
Description: Synchronization mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ProviderShareSubscriptions_Adjust (removed)
Description :  Adjust a share subscription's expiration date in a provider share
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/adjust
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
providerShareSubscriptionId:
{
Description: To locate shareSubscription ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
providerShareSubscription:
{
Description: The provider share subscription ,
Required: True ,
}
{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ProviderShareSubscriptions_Reinstate (removed)
Description :  Reinstate share subscription in a provider share
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/reinstate
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
providerShareSubscriptionId:
{
Description: To locate shareSubscription ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
providerShareSubscription:
{
Description: The provider share subscription ,
Required: True ,
}
{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ProviderShareSubscriptions_Revoke (removed)
Description :  Revoke share subscription in a provider share
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/revoke
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
providerShareSubscriptionId:
{
Description: To locate shareSubscription ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ProviderShareSubscriptions_GetByShare (removed)
Description :  Get share subscription in a provider share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
providerShareSubscriptionId:
{
Description: To locate shareSubscription ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ProviderShareSubscriptions_ListByShare (removed)
Description :  List share subscriptions in a provider share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation Token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: properties of providerShareSubscription ,
Required: False ,
}
{
consumerEmail:
{
Description: Email of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerName:
{
Description: Name of the consumer who created the share subscription ,
Required: False ,
}
string ,
consumerTenantName:
{
Description: Tenant name of the consumer who created the share subscription ,
Required: False ,
}
string ,
createdAt:
{
Description: created at ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date of the share subscription in UTC format ,
Format: date-time ,
Required: False ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the share ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the share ,
Required: False ,
}
string ,
sharedAt:
{
Description: Shared at ,
Format: date-time ,
Required: False ,
}
string ,
shareSubscriptionObjectId:
{
Description: share Subscription Object Id ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the status of share subscription ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_Get (removed)
Description :  Get a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share to retrieve. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the share ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the share was created. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Share description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareKind:
{
Description: Share kind. ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
terms:
{
Description: Share terms. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_Create (removed)
Description :  Create a share
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
share:
{
Description: The share payload ,
Required: True ,
}
{
properties:
{
Description: Properties on the share ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the share was created. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Share description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareKind:
{
Description: Share kind. ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
terms:
{
Description: Share terms. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties on the share ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the share was created. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Share description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareKind:
{
Description: Share kind. ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
terms:
{
Description: Share terms. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the share ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the share was created. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Share description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareKind:
{
Description: Share kind. ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
terms:
{
Description: Share terms. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_Delete (removed)
Description :  Delete a share
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error property when status is failed. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation state of the long running operation. ,
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Shares_ListByAccount (removed)
Description :  List shares in an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation Token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties on the share ,
Required: False ,
}
{
createdAt:
{
Description: Time at which the share was created. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Share description. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Gets or sets the provisioning state ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareKind:
{
Description: Share kind. ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
terms:
{
Description: Share terms. ,
Required: False ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_CancelSynchronization (removed)
Description :  Request to cancel a synchronization.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/cancelSynchronization
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
shareSubscriptionSynchronization:
{
Description: Share Subscription Synchronization payload. ,
Required: True ,
}
{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ConsumerSourceDataSets_ListByShareSubscription (removed)
Description :  Get source dataSets of a shareSubscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/consumerSourceDataSets
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: source dataSet properties ,
Required: False ,
}
{
dataSetId:
{
Description: DataSet Id ,
Required: False ,
}
string ,
dataSetLocation:
{
Description: Location of the data set. ,
Required: False ,
}
string ,
dataSetName:
{
Description: DataSet name ,
Required: False ,
}
string ,
dataSetPath:
{
Description: DataSet path ,
Required: False ,
}
string ,
dataSetType:
{
Description: Type of data set ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_ListSourceShareSynchronizationSettings (removed)
Description :  Get synchronization settings set on a share
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSourceShareSynchronizationSettings
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Kind of synchronization setting on share. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_ListSynchronizationDetails (removed)
Description :  List synchronization details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription. ,
Required: True ,
}
string ,
shareSubscriptionSynchronization:
{
Description: Share Subscription Synchronization payload. ,
Required: True ,
}
{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
dataSetId:
{
Description: Id of data set ,
Required: False ,
}
string ,
dataSetType:
{
Description: Type of the data set ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
BlobFolder: No description available. ,
AdlsGen2FileSystem: No description available. ,
AdlsGen2Folder: No description available. ,
AdlsGen2File: No description available. ,
AdlsGen1Folder: No description available. ,
AdlsGen1File: No description available. ,
KustoCluster: No description available. ,
KustoDatabase: No description available. ,
KustoTable: No description available. ,
SqlDBTable: No description available. ,
SqlDWTable: No description available. ,
SynapseWorkspaceSqlPoolTable: No description available. ,
}
,
Required: False ,
}
enum ,
durationMs:
{
Description: Duration of data set level copy ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of data set level copy ,
Format: date-time ,
Required: False ,
}
string ,
filesRead:
{
Description: The number of files read from the source data set ,
Format: int64 ,
Required: False ,
}
integer ,
filesWritten:
{
Description: The number of files written into the sink data set ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: Error message if any ,
Required: False ,
}
string ,
name:
{
Description: Name of the data set ,
Required: False ,
}
string ,
rowsCopied:
{
Description: The number of files copied into the sink data set ,
Format: int64 ,
Required: False ,
}
integer ,
rowsRead:
{
Description: The number of rows read from the source data set. ,
Format: int64 ,
Required: False ,
}
integer ,
sizeRead:
{
Description: The size of the data read from the source data set in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
sizeWritten:
{
Description: The size of the data written into the sink data set in bytes ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: Start time of data set level copy ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
vCore:
{
Description: The vCore units consumed for the data set synchronization ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_ListSynchronizations (removed)
Description :  List synchronizations of a share subscription
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizations
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_Synchronize (removed)
Description :  Initiate a copy
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/synchronize
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of share subscription ,
Required: True ,
}
string ,
synchronize:
{
Description: Synchronize payload ,
Required: True ,
}
{
synchronizationMode:
{
Description: Mode of synchronization used in triggers and snapshot sync. Incremental by default ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
durationMs:
{
Description: Synchronization duration ,
Format: int32 ,
Required: False ,
}
integer ,
endTime:
{
Description: End time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: message of Synchronization ,
Required: False ,
}
string ,
startTime:
{
Description: start time of synchronization ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Raw Status ,
Required: False ,
}
string ,
synchronizationId:
{
Description: Synchronization id ,
Required: True ,
}
string ,
synchronizationMode:
{
Description: Synchronization Mode ,
Enum:
{
Incremental: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_Get (removed)
Description :  Get a shareSubscription in an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the share subscription ,
Required: True ,
}
{
createdAt:
{
Description: Time at which the share subscription was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of the share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: The invitation id. ,
Required: True ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the share subscription ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareDescription:
{
Description: Description of share ,
Required: False ,
}
string ,
shareKind:
{
Description: Kind of share ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Name of the share ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the current status of share subscription. ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
shareTerms:
{
Description: Terms of a share ,
Required: False ,
}
string ,
sourceShareLocation:
{
Description: Source share location. ,
Required: True ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_Create (removed)
Description :  Create a shareSubscription in an account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
shareSubscription:
{
Description: create parameters for shareSubscription ,
Required: True ,
}
{
properties:
{
Description: Properties on the share subscription ,
Required: True ,
}
{
createdAt:
{
Description: Time at which the share subscription was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of the share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: The invitation id. ,
Required: True ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the share subscription ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareDescription:
{
Description: Description of share ,
Required: False ,
}
string ,
shareKind:
{
Description: Kind of share ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Name of the share ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the current status of share subscription. ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
shareTerms:
{
Description: Terms of a share ,
Required: False ,
}
string ,
sourceShareLocation:
{
Description: Source share location. ,
Required: True ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties on the share subscription ,
Required: True ,
}
{
createdAt:
{
Description: Time at which the share subscription was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of the share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: The invitation id. ,
Required: True ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the share subscription ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareDescription:
{
Description: Description of share ,
Required: False ,
}
string ,
shareKind:
{
Description: Kind of share ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Name of the share ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the current status of share subscription. ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
shareTerms:
{
Description: Terms of a share ,
Required: False ,
}
string ,
sourceShareLocation:
{
Description: Source share location. ,
Required: True ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties on the share subscription ,
Required: True ,
}
{
createdAt:
{
Description: Time at which the share subscription was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of the share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: The invitation id. ,
Required: True ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the share subscription ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareDescription:
{
Description: Description of share ,
Required: False ,
}
string ,
shareKind:
{
Description: Kind of share ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Name of the share ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the current status of share subscription. ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
shareTerms:
{
Description: Terms of a share ,
Required: False ,
}
string ,
sourceShareLocation:
{
Description: Source share location. ,
Required: True ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_Delete (removed)
Description :  Delete a shareSubscription in an account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error property when status is failed. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation state of the long running operation. ,
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ShareSubscriptions_ListByAccount (removed)
Description :  List share subscriptions in an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation Token ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax. ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
properties:
{
Description: Properties on the share subscription ,
Required: True ,
}
{
createdAt:
{
Description: Time at which the share subscription was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The expiration date of the share subscription. ,
Format: date-time ,
Required: False ,
}
string ,
invitationId:
{
Description: The invitation id. ,
Required: True ,
}
string ,
providerEmail:
{
Description: Email of the provider who created the resource ,
Required: False ,
}
string ,
providerName:
{
Description: Name of the provider who created the resource ,
Required: False ,
}
string ,
providerTenantName:
{
Description: Tenant name of the provider who created the resource ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the share subscription ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
shareDescription:
{
Description: Description of share ,
Required: False ,
}
string ,
shareKind:
{
Description: Kind of share ,
Enum:
{
CopyBased: No description available. ,
InPlace: No description available. ,
}
,
Required: False ,
}
enum ,
shareName:
{
Description: Name of the share ,
Required: False ,
}
string ,
shareSubscriptionStatus:
{
Description: Gets the current status of share subscription. ,
Enum:
{
Active: No description available. ,
Revoked: No description available. ,
SourceDeleted: No description available. ,
Revoking: No description available. ,
}
,
Required: False ,
}
enum ,
shareTerms:
{
Description: Terms of a share ,
Required: False ,
}
string ,
sourceShareLocation:
{
Description: Source share location. ,
Required: True ,
}
string ,
userEmail:
{
Description: Email of the user who created the resource ,
Required: False ,
}
string ,
userName:
{
Description: Name of the user who created the resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SynchronizationSettings_Get (removed)
Description :  Get a synchronizationSetting in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
synchronizationSettingName:
{
Description: The name of the synchronizationSetting. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of synchronization setting. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SynchronizationSettings_Create (removed)
Description :  Create a synchronizationSetting
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share to add the synchronization setting to. ,
Required: True ,
}
string ,
synchronizationSettingName:
{
Description: The name of the synchronizationSetting. ,
Required: True ,
}
string ,
synchronizationSetting:
{
Description: The new synchronization setting information. ,
Required: True ,
}
{
kind:
{
Description: Kind of synchronization setting. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Kind of synchronization setting. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of synchronization setting. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SynchronizationSettings_Delete (removed)
Description :  Delete a synchronizationSetting in a share
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
synchronizationSettingName:
{
Description: The name of the synchronizationSetting . ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error property when status is failed. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation state of the long running operation. ,
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SynchronizationSettings_ListByShare (removed)
Description :  List synchronizationSettings in a share
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the share. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Kind of synchronization setting. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Triggers_Get (removed)
Description :  Get a Trigger in a shareSubscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of synchronization on trigger. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Triggers_Create (removed)
Description :  Create a Trigger
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription which will hold the data set sink. ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
trigger:
{
Description: Trigger details. ,
Required: True ,
}
{
kind:
{
Description: Kind of synchronization on trigger. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
kind:
{
Description: Kind of synchronization on trigger. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
kind:
{
Description: Kind of synchronization on trigger. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Triggers_Delete (removed)
Description :  Delete a Trigger in a shareSubscription
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the shareSubscription. ,
Required: True ,
}
string ,
triggerName:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error property when status is failed. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: start time ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation state of the long running operation. ,
Enum:
{
Accepted: No description available. ,
InProgress: No description available. ,
TransientFailure: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Triggers_ListByShareSubscription (removed)
Description :  List Triggers in a share subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/triggers
{
subscriptionId:
{
Description: The subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the share account. ,
Required: True ,
}
string ,
shareSubscriptionName:
{
Description: The name of the share subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
$skipToken:
{
Description: Continuation token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Kind of synchronization on trigger. ,
Enum:
{
ScheduleBased: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The data share error body ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}