Consumer Invitations - Get

Service:

Data Share

API Version:

2021-08-01

Pobiera zaproszenie zidentyfikowane przez identyfikator zaproszenia
Uzyskiwanie zaproszenia

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
invitationId	path	True	string	Identyfikator zaproszenia
location	path	True	string	Lokalizacja zaproszenia
api-version	query	True	string	Wersja interfejsu API do użycia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ConsumerInvitation	Powodzenie
Other Status Codes	DataShareError	Odpowiedź o błędzie odebrana od dostawcy zasobów Microsoft.DataShare.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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 System;
using System.Threading.Tasks;
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/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);

// this example assumes you already have this DataShareConsumerInvitationResource created on azure
// for more information of creating DataShareConsumerInvitationResource, please refer to the document of DataShareConsumerInvitationResource
AzureLocation location = new AzureLocation("East US 2");
Guid invitationId = Guid.Parse("dfbbc788-19eb-4607-a5a1-c74181bfff03");
ResourceIdentifier dataShareConsumerInvitationResourceId = DataShareConsumerInvitationResource.CreateResourceIdentifier(location, invitationId);
DataShareConsumerInvitationResource dataShareConsumerInvitation = client.GetDataShareConsumerInvitationResource(dataShareConsumerInvitationResourceId);

// invoke the operation
DataShareConsumerInvitationResource result = await dataShareConsumerInvitation.GetAsync();

// 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

Response Body

{
  "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"
}

Definicje

Nazwa	Opis
ConsumerInvitation	Obiekt transferu danych zaproszenia użytkownika.
createdByType	Typ tożsamości, która utworzyła zasób.
DataShareError	Model błędu udziału danych.
DataShareErrorInfo	Model treści błędu udziału danych.
invitationStatus	Stan zaproszenia.
lastModifiedByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ConsumerInvitation

Obiekt transferu danych zaproszenia użytkownika.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu platformy Azure
name	string	Nazwa zasobu platformy Azure
properties.dataSetCount	integer	Liczba zestawów danych w udziale
properties.description	string	Opis udostępniony podczas tworzenia zaproszenia
properties.expirationDate	string	Data wygaśnięcia subskrypcji udziału utworzonej przez zaakceptowanie zaproszenia.
properties.invitationId	string	Unikatowy identyfikator zaproszenia.
properties.invitationStatus	invitationStatus	Stan zaproszenia.
properties.location	string	lokalizacja zaproszenia
properties.providerEmail	string	Email dostawcy, który utworzył zasób
properties.providerName	string	Nazwa dostawcy, który utworzył zasób
properties.providerTenantName	string	Nazwa dzierżawy dostawcy, który utworzył zasób
properties.respondedAt	string	Czas odpowiedzi adresata na zaproszenie.
properties.sentAt	string	Pobiera czas wysłania zaproszenia.
properties.shareName	string	Pobiera nazwę udziału źródłowego.
properties.termsOfUse	string	Warunki użytkowania udostępnione podczas tworzenia zaproszenia
properties.userEmail	string	Email użytkownika, który utworzył zasób
properties.userName	string	Nazwa użytkownika, który utworzył zasób
systemData	SystemData	Dane systemowe zasobu platformy Azure.
type	string	Typ zasobu platformy Azure

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DataShareError

Model błędu udziału danych.

Nazwa	Typ	Opis
error	DataShareErrorInfo	Treść błędu udziału danych

DataShareErrorInfo

Model treści błędu udziału danych.

Nazwa	Typ	Opis
code	string	Kod błędu
details	DataShareErrorInfo[]	Zagnieżdżone szczegóły modelu błędów
message	string	Komunikat o błędzie
target	string	Element docelowy błędu

invitationStatus

Stan zaproszenia.

Nazwa	Typ	Opis
Accepted	string
Pending	string
Rejected	string
Withdrawn	string

lastModifiedByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Typ tożsamości, która ostatnio zmodyfikowała zasób.
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	lastModifiedByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.