Consumer Invitations - Get

Service:

Data Share

API Version:

2021-08-01

Gets the invitation identified by invitationId
Get an invitation

GET https://management.azure.com/providers/Microsoft.DataShare/locations/{location}/consumerInvitations/{invitationId}?api-version=2021-08-01

URI Parameters

Name	In	Required	Type	Description
invitationId	path	True	string	An invitation id
location	path	True	string	Location of the invitation
api-version	query	True	string	The api version to use.

Responses

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

ConsumerInvitations_Get

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.DataShare/locations/East US 2/consumerInvitations/dfbbc788-19eb-4607-a5a1-c74181bfff03?api-version=2021-08-01

dotnet

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

// Generated from example definition: specification/datashare/resource-manager/Microsoft.DataShare/stable/2021-08-01/examples/ConsumerInvitations_Get.json
// this example is just showing the usage of "ConsumerInvitations_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);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this DataShareConsumerInvitationResource
DataShareConsumerInvitationCollection collection = tenantResource.GetDataShareConsumerInvitations();

// invoke the operation
AzureLocation location = new AzureLocation("East US 2");
Guid invitationId = Guid.Parse("dfbbc788-19eb-4607-a5a1-c74181bfff03");
NullableResponse<DataShareConsumerInvitationResource> response = await collection.GetIfExistsAsync(location, invitationId);
DataShareConsumerInvitationResource 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
    DataShareConsumerInvitationData 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

{
  "properties": {
    "location": "eastus2",
    "invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
    "providerName": "John Smith",
    "providerEmail": "john.smith@microsoft.com",
    "providerTenantName": "Microsoft",
    "sentAt": "2019-01-15T01:45:25.6226946Z",
    "respondedAt": "2019-01-15T02:01:51.8953054Z",
    "invitationStatus": "Accepted",
    "description": "Some share",
    "termsOfUse": "Confidential",
    "dataSetCount": 1,
    "shareName": "share1",
    "expirationDate": "2020-08-26T22:33:24.5785265Z"
  },
  "id": "providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487",
  "name": "invitation1",
  "type": "Microsoft.DataShare/locations/consumerInvitations"
}

Definitions

Name	Description
ConsumerInvitation	A consumer Invitation data transfer object.
createdByType	The type of identity that created the resource.
DataShareError	The data share error model.
DataShareErrorInfo	The data share error body model.
invitationStatus	The status of the invitation.
lastModifiedByType	The type of identity that last modified the resource.
SystemData	Metadata pertaining to creation and last modification of the resource.

ConsumerInvitation

Object

A consumer Invitation data transfer object.

Name	Type	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties.dataSetCount	integer (int32)	Number of data sets in a share
properties.description	string	Description shared when the invitation was created
properties.expirationDate	string (date-time)	The expiration date for the share subscription created by accepting the invitation.
properties.invitationId	string	Unique id of the invitation.
properties.invitationStatus	invitationStatus	The status of the invitation.
properties.location	string	invitation location
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.respondedAt	string (date-time)	The time the recipient responded to the invitation.
properties.sentAt	string (date-time)	Gets the time at which the invitation was sent.
properties.shareName	string	Gets the source share Name.
properties.termsOfUse	string	Terms of use shared when the invitation was created
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

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DataShareError

Object

The data share error model.

Name	Type	Description
error	DataShareErrorInfo	The data share error body

DataShareErrorInfo

Object

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

invitationStatus

Enumeration

The status of the invitation.

Value	Description
Pending
Accepted
Rejected
Withdrawn

lastModifiedByType

Enumeration

The type of identity that last modified the resource.

Value	Description
User
Application
ManagedIdentity
Key

SystemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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.