Share Subscriptions - List By Account

Reference

Service:: Data Share

API Version:: 2021-08-01

List of available share subscriptions under an account.
List share subscriptions in an account

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions?api-version=2021-08-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions?api-version=2021-08-01&$skipToken={$skipToken}&$filter={$filter}&$orderby={$orderby}

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the share account.
resourceGroupName	path	True	string	The resource group name.
subscriptionId	path	True	string	The subscription identifier
api-version	query	True	string	The api version to use.
$filter	query		string	Filters the results using OData syntax.
$orderby	query		string	Sorts the results using OData syntax.
$skipToken	query		string	Continuation Token

Responses

Name	Type	Description
200 OK	ShareSubscriptionList	Success
Other Status Codes	DataShareError	An error response received from the Microsoft.DataShare resource provider.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ShareSubscriptions_ListByAccount

GET https://management.azure.com/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions?api-version=2021-08-01

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataShare;

// Generated from example definition: specification/datashare/resource-manager/Microsoft.DataShare/stable/2021-08-01/examples/ShareSubscriptions_ListByAccount.json
// this example is just showing the usage of "ShareSubscriptions_ListByAccount" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataShareAccountResource created on azure
// for more information of creating DataShareAccountResource, please refer to the document of DataShareAccountResource
string subscriptionId = "12345678-1234-1234-12345678abc";
string resourceGroupName = "SampleResourceGroup";
string accountName = "Account1";
ResourceIdentifier dataShareAccountResourceId = DataShareAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
DataShareAccountResource dataShareAccount = client.GetDataShareAccountResource(dataShareAccountResourceId);

// get the collection of this ShareSubscriptionResource
ShareSubscriptionCollection collection = dataShareAccount.GetShareSubscriptions();

// invoke the operation and iterate over the result
await foreach (ShareSubscriptionResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ShareSubscriptionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

Response Body

{
  "value": [
    {
      "properties": {
        "invitationId": "12345678-1234-1234-12345678abd",
        "sourceShareLocation": "eastus2",
        "shareSubscriptionStatus": "Active",
        "userName": "johnsmith@microsoft.com",
        "createdAt": "2018-11-14T06:15:15.6818898Z",
        "userEmail": "john.smith@microsoft.com",
        "shareName": "share1",
        "shareDescription": "Some share",
        "shareTerms": "Confidential",
        "shareKind": "CopyBased",
        "providerTenantName": "Microsoft",
        "providerName": "Jack Rose",
        "providerEmail": "jack.rose@microsoft.com",
        "expirationDate": "2020-08-26T22:33:24.5785265Z"
      },
      "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1",
      "name": "ShareSubscription1",
      "type": "Microsoft.DataShare/accounts/shareSubscriptions"
    },
    {
      "properties": {
        "userName": "John Smith",
        "userEmail": "john.smith@microsoft.com",
        "createdAt": "2020-12-17T22:32:36.8185016Z",
        "shareSubscriptionStatus": "Active",
        "invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
        "sourceShareLocation": "eastus2",
        "shareName": "share1",
        "shareDescription": "Some share",
        "shareTerms": "Confidential",
        "shareKind": "CopyBased",
        "providerTenantName": "Microsoft",
        "providerName": "Jack Rose",
        "providerEmail": "jack.rose@microsoft.com",
        "expirationDate": "2020-08-26T22:33:24.5785265Z"
      },
      "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/sharesubscriptions/ShareSubscription1",
      "name": "ShareSubscription1",
      "type": "Microsoft.DataShare/accounts/shareSubscriptions"
    }
  ]
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DataShareError	The data share error model.
DataShareErrorInfo	The data share error body model.
lastModifiedByType	The type of identity that last modified the resource.
provisioningState	Provisioning state of the Account
shareKind	Share kind.
ShareSubscription	A share subscription data transfer object.
ShareSubscriptionList	List response for get ShareSubscription.
shareSubscriptionStatus	Gets the status of share subscription
SystemData	Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataShareError

The data share error model.

Name	Type	Description
error	DataShareErrorInfo	The data share error body

DataShareErrorInfo

The data share error body model.

Name	Type	Description
code	string	Code of the error
details	DataShareErrorInfo[]	Nested details of the error model
message	string	Message of the error
target	string	Target of the error

lastModifiedByType

The type of identity that last modified the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

provisioningState

Provisioning state of the Account

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Moving	string
Succeeded	string

shareKind

Share kind.

Name	Type	Description
CopyBased	string
InPlace	string

ShareSubscription

A share subscription data transfer object.

Name	Type	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties.createdAt	string	Time at which the share subscription was created.
properties.expirationDate	string	The expiration date of the share subscription.
properties.invitationId	string	The invitation id.
properties.providerEmail	string	Email of the provider who created the resource
properties.providerName	string	Name of the provider who created the resource
properties.providerTenantName	string	Tenant name of the provider who created the resource
properties.provisioningState	provisioningState	Provisioning state of the share subscription
properties.shareDescription	string	Description of share
properties.shareKind	shareKind	Kind of share
properties.shareName	string	Name of the share
properties.shareSubscriptionStatus	shareSubscriptionStatus	Gets the current status of share subscription.
properties.shareTerms	string	Terms of a share
properties.sourceShareLocation	string	Source share location.
properties.userEmail	string	Email of the user who created the resource
properties.userName	string	Name of the user who created the resource
systemData	SystemData	System Data of the Azure resource.
type	string	Type of the azure resource

ShareSubscriptionList

List response for get ShareSubscription.

Name	Type	Description
nextLink	string	The Url of next result page.
value	ShareSubscription[]	Collection of items of type DataTransferObjects.

shareSubscriptionStatus

Gets the status of share subscription

Name	Type	Description
Active	string
Revoked	string
Revoking	string
SourceDeleted	string

SystemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The type of identity that last modified the resource.
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	lastModifiedByType	The type of identity that last modified the resource.