Azure Datashare
Creates a Microsoft.DataShare management client.
Data & analytics#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Creates a Microsoft.DataShare management client.
Endpoints 53
Account
- GETList Accounts in a subscription
/subscriptions/:subscriptionId/providers/Microsoft.DataShare/accounts?api-version=string&$skipToken=stringList Accounts in Subscription - GETGet an account under a resource group
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName?api-version=stringGet an account - PUTCreate an account in the given resource group
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName?api-version=stringCreate an account - DELETEDelete an account
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName?api-version=stringDeleteAccount - PATCHPatch a given account
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName?api-version=stringPatch an account - GETList Accounts in a resource group
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts?api-version=string&$skipToken=stringList Accounts in ResourceGroup
ConsumerInvitation
- GETList the invitations
/providers/Microsoft.DataShare/listInvitations?api-version=string&$skipToken=stringLists invitations - GETGets the invitation identified by invitationId
/providers/Microsoft.DataShare/locations/:location/consumerInvitations/:invitationId?api-version=stringGet an invitation - POSTRejects the invitation identified by invitationId
/providers/Microsoft.DataShare/locations/:location/rejectInvitation?api-version=stringReject an invitation
DataSet
- GETGet DataSet in a share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/dataSets/:dataSetName?api-version=stringGet a DataSet in a share - PUTAdds a new data set to an existing share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/dataSets/:dataSetName?api-version=stringCreate a DataSet - DELETEDelete DataSet in a share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/dataSets/:dataSetName?api-version=stringDelete a DataSet in a share - GETList DataSets in a share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/dataSets?api-version=string&$skipToken=string&$filter=string&$orderby=stringList DataSets in a share
DataSetMapping
- GETGet DataSetMapping in a shareSubscription.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/dataSetMappings/:dataSetMappingName?api-version=stringGet a DataSetMapping in a shareSubscription - PUTMaps a source data set in the source share to a sink data set in the share subscription.
Enables copying the data set from source to destination.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/dataSetMappings/:dataSetMappingName?api-version=stringCreate a DataSetMapping - DELETEDelete DataSetMapping in a shareSubscription.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/dataSetMappings/:dataSetMappingName?api-version=stringDelete a DataSetMapping in a shareSubscription - GETList DataSetMappings in a share subscription.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/dataSetMappings?api-version=string&$skipToken=string&$filter=string&$orderby=stringList DataSetMappings in a share subscription
EmailRegistration
- POSTActivates the tenant and email combination using email code received.
/providers/Microsoft.DataShare/locations/:location/activateEmail?api-version=stringActivate the email registration for the current tenant - POSTRegisters the tenant and email combination for verification.
/providers/Microsoft.DataShare/locations/:location/registerEmail?api-version=stringRegister an email for the current tenant
Invitation
- GETGet Invitation in a share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/invitations/:invitationName?api-version=stringGet an invitation in a share - PUTSends a new invitation to a recipient to access a share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/invitations/:invitationName?api-version=stringCreate an invitation - DELETEDelete Invitation in a share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/invitations/:invitationName?api-version=stringDelete an invitation in a share - GETList all Invitations in a share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/invitations?api-version=string&$skipToken=string&$filter=string&$orderby=stringList invitations in a share
Operation
- GETLists the available operations
/providers/Microsoft.DataShare/operations?api-version=stringList of available operations
Share
- POSTList data set level details for a share synchronization
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/listSynchronizationDetails?api-version=string&$skipToken=string&$filter=string&$orderby=stringList synchronization details - POSTList Synchronizations in a share
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/listSynchronizations?api-version=string&$skipToken=string&$filter=string&$orderby=stringList synchronizations of a share - POSTAdjust the expiration date of a share subscription in a provider share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/providerShareSubscriptions/:providerShareSubscriptionId/adjust?api-version=stringAdjust a share subscription's expiration date in a provider share - POSTReinstate share subscription in a provider share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/providerShareSubscriptions/:providerShareSubscriptionId/reinstate?api-version=stringReinstate share subscription in a provider share - POSTRevoke share subscription in a provider share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/providerShareSubscriptions/:providerShareSubscriptionId/revoke?api-version=stringRevoke share subscription in a provider share - GETGet share subscription in a provider share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/providerShareSubscriptions/:providerShareSubscriptionId?api-version=stringGet share subscription in a provider share - GETList of available share subscriptions to a provider share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/providerShareSubscriptions?api-version=string&$skipToken=stringList share subscriptions in a provider share - GETGet a specified share
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName?api-version=stringGet a share - PUTCreate a share in the given account.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName?api-version=stringCreate a share - DELETEDeletes a share
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName?api-version=stringDelete a share - GETList of available shares under an account.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares?api-version=string&$skipToken=string&$filter=string&$orderby=stringList shares in an account
ShareSubscription
- POSTRequest cancellation of a data share snapshot
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/cancelSynchronization?api-version=stringRequest to cancel a synchronization. - GETGet source dataSets of a shareSubscription.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/consumerSourceDataSets?api-version=string&$skipToken=stringGet source dataSets of a shareSubscription - POSTGet source share synchronization settings for a shareSubscription.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/listSourceShareSynchronizationSettings?api-version=string&$skipToken=stringGet synchronization settings set on a share - POSTList data set level details for a share subscription synchronization
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/listSynchronizationDetails?api-version=string&$skipToken=string&$filter=string&$orderby=stringList synchronization details - POSTList Synchronizations in a share subscription.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/listSynchronizations?api-version=string&$skipToken=string&$filter=string&$orderby=stringList synchronizations of a share subscription - POSTInitiate an asynchronous data share job
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/synchronize?api-version=stringInitiate a copy - GETGet shareSubscription in an account.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName?api-version=stringGet a shareSubscription in an account - PUTCreate shareSubscription in an account.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName?api-version=stringCreate a shareSubscription in an account - DELETEDelete shareSubscription in an account.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName?api-version=stringDelete a shareSubscription in an account - GETList of available share subscriptions under an account.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions?api-version=string&$skipToken=string&$filter=string&$orderby=stringList share subscriptions in an account
SynchronizationSetting
- GETGet synchronizationSetting in a share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/synchronizationSettings/:synchronizationSettingName?api-version=stringGet a synchronizationSetting in a share - PUTAdds a new synchronization setting to an existing share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/synchronizationSettings/:synchronizationSettingName?api-version=stringCreate a synchronizationSetting - DELETEDelete synchronizationSetting in a share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/synchronizationSettings/:synchronizationSettingName?api-version=stringDelete a synchronizationSetting in a share - GETList synchronizationSettings in a share.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shares/:shareName/synchronizationSettings?api-version=string&$skipToken=stringList synchronizationSettings in a share
Trigger
- GETGet Trigger in a shareSubscription.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/triggers/:triggerName?api-version=stringGet a Trigger in a shareSubscription - PUTThis method creates a trigger for a share subscription
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/triggers/:triggerName?api-version=stringCreate a Trigger - DELETEDelete Trigger in a shareSubscription.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/triggers/:triggerName?api-version=stringDelete a Trigger in a shareSubscription - GETList Triggers in a share subscription.
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataShare/accounts/:accountName/shareSubscriptions/:shareSubscriptionName/triggers?api-version=string&$skipToken=stringList Triggers in a share subscription
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 53 operations on 36 pathsGET 23POST 13PUT 8DELETE 8PATCH 1
- Main resources
- Share 11ShareSubscription 10Account 6DataSet 4DataSetMapping 4Invitation 4SynchronizationSetting 4Trigger 4ConsumerInvitation 3EmailRegistration 2
- Response formats
application/json- Description format
- Swagger 2.0, API version
2021-08-01 - Links
- OpenAPI document
How to test the Azure Datashare in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Datashare collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List Accounts in a subscription” (GET /subscriptions/:subscriptionId/providers/Microsoft.DataShare/accounts?api-version=string&$skipToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Datashare?
Creates a Microsoft.DataShare management client. It is listed under Data & analytics and has 53 endpoints.
Who publishes the Azure Datashare?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Datashare?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Datashare?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Datashare have?
53 operations on 36 paths (23 GET, 13 POST, 8 PUT, 8 DELETE, 1 PATCH). The largest groups are Share, ShareSubscription, Account, DataSet.
Is forking the Azure Datashare free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.