Shares - Get

Service:

Data Share

API Version:

2021-08-01

Get a specified share
Get a share

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

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.
shareName	path	True	string	The name of the share to retrieve.
subscriptionId	path	True	string	The subscription identifier
api-version	query	True	string	The api version to use.

Responses

Name	Type	Description
200 OK	Share	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

Shares_Get

Sample Request

HTTP

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

dotnet

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

// Generated from example definition: specification/datashare/resource-manager/Microsoft.DataShare/stable/2021-08-01/examples/Shares_Get.json
// this example is just showing the usage of "Shares_Get" 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 DataShareResource
DataShareCollection collection = dataShareAccount.GetDataShares();

// invoke the operation
string shareName = "Share1";
NullableResponse<DataShareResource> response = await collection.GetIfExistsAsync(shareName);
DataShareResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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
    DataShareData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

{
  "properties": {
    "description": "share description",
    "terms": "Confidential",
    "shareKind": "CopyBased",
    "userName": "John Smith",
    "createdAt": "2018-11-14T06:15:15.6818898Z",
    "userEmail": "johnsmith@microsoft.com"
  },
  "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1",
  "name": "Share1",
  "type": "Microsoft.DataShare/accounts/shares"
}

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
Share	A share data transfer object.
shareKind	Share kind.
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

Share

A share 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 was created.
properties.description	string	Share description.
properties.provisioningState	provisioningState	Gets or sets the provisioning state
properties.shareKind	shareKind	Share kind.
properties.terms	string	Share terms.
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

shareKind

Share kind.

Name	Type	Description
CopyBased	string
InPlace	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.