Consumer Invitations - List Invitations

Service:

Data Share

API Version:

2021-08-01

Auflisten der Einladungen
Listen Einladungen

GET https://management.azure.com/providers/Microsoft.DataShare/listInvitations?api-version=2021-08-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.DataShare/listInvitations?api-version=2021-08-01&$skipToken={$skipToken}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Die zu verwendende API-Version.
$skipToken	query		string	Das Fortsetzungstoken

Antworten

Name	Typ	Beschreibung
200 OK	ConsumerInvitationList	Erfolg
Other Status Codes	DataShareError	Eine Vom Microsoft.DataShare-Ressourcenanbieter empfangene Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ConsumerInvitations_ListInvitations

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.DataShare/listInvitations?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;

// Generated from example definition: specification/datashare/resource-manager/Microsoft.DataShare/stable/2021-08-01/examples/ConsumerInvitations_ListInvitations.json
// this example is just showing the usage of "ConsumerInvitations_ListInvitations" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

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

// invoke the operation and iterate over the result
await foreach (DataShareConsumerInvitationResource 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
    DataShareConsumerInvitationData 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 17:33:55 GMT
x-ms-request-id: 8e58266a-de42-40d5-b3c4-c6a7e159cfba
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14993
x-ms-correlation-request-id: 5d862c55-4de9-4a46-969d-cf1ed3e235ed

Response Body

{
  "value": [
    {
      "properties": {
        "location": "eastus2",
        "invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
        "providerName": "John Smith",
        "providerEmail": "john.smith@microsoft.com",
        "sentAt": "2019-01-15T01:45:25.6226946Z",
        "respondedAt": "2019-01-15T02:01:51.8953054Z",
        "invitationStatus": "Accepted",
        "description": "Some share",
        "termsOfUse": "Confidential",
        "dataSetCount": 1,
        "providerTenantName": "microsoft",
        "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"
    }
  ]
}

Definitionen

Name	Beschreibung
ConsumerInvitation	Ein Consumer-Einladungs-Datenübertragungsobjekt.
ConsumerInvitationList	List response for get InvitationList
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DataShareError	Das Datenfreigabefehlermodell.
DataShareErrorInfo	Das Datenfreigabefehlermodell.
invitationStatus	Die status der Einladung.
lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.
SystemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

ConsumerInvitation

Ein Consumer-Einladungs-Datenübertragungsobjekt.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Azure-Ressource
name	string	Name der Azure-Ressource
properties.dataSetCount	integer	Anzahl von Datasets in einer Freigabe
properties.description	string	Beschreibung, die beim Erstellen der Einladung freigegeben wurde
properties.expirationDate	string	Das Ablaufdatum für das Freigabeabonnement, das durch Annehmen der Einladung erstellt wurde.
properties.invitationId	string	Eindeutige ID der Einladung.
properties.invitationStatus	invitationStatus	Die status der Einladung.
properties.location	string	Einladungsspeicherort
properties.providerEmail	string	Email des Anbieters, der die Ressource erstellt hat
properties.providerName	string	Name des Anbieters, der die Ressource erstellt hat
properties.providerTenantName	string	Mandantenname des Anbieters, der die Ressource erstellt hat
properties.respondedAt	string	Der Zeitpunkt, zu dem der Empfänger auf die Einladung geantwortet hat.
properties.sentAt	string	Ruft den Zeitpunkt ab, zu dem die Einladung gesendet wurde.
properties.shareName	string	Ruft den Namen der Quellfreigabe ab.
properties.termsOfUse	string	Nutzungsbedingungen, die beim Erstellen der Einladung freigegeben wurden
properties.userEmail	string	Email des Benutzers, der die Ressource erstellt hat
properties.userName	string	Name des Benutzers, der die Ressource erstellt hat
systemData	SystemData	Systemdaten der Azure-Ressource.
type	string	Typ der Azure-Ressource

ConsumerInvitationList

List response for get InvitationList

Name	Typ	Beschreibung
nextLink	string	Die URL der nächsten Ergebnisseite.
value	ConsumerInvitation[]	Auflistung von Elementen des Typs DataTransferObjects.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

DataShareError

Das Datenfreigabefehlermodell.

Name	Typ	Beschreibung
error	DataShareErrorInfo	Fehlertext der Datenfreigabe

DataShareErrorInfo

Das Datenfreigabefehlermodell.

Name	Typ	Beschreibung
code	string	Code des Fehlers
details	DataShareErrorInfo[]	Geschachtelte Details des Fehlermodells
message	string	Meldung des Fehlers
target	string	Ziel des Fehlers

invitationStatus

Die status der Einladung.

Name	Typ	Beschreibung
Accepted	string
Pending	string
Rejected	string
Withdrawn	string

lastModifiedByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.