Consumer Invitations - List Invitations

Riferimento

Service:: Data Share

API Version:: 2021-08-01

Elencare gli inviti
inviti Elenchi

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}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
api-version	query	True	string	Versione dell'API da usare.
$skipToken	query		string	Token di continuazione

Risposte

Nome	Tipo	Descrizione
200 OK	ConsumerInvitationList	Operazione riuscita
Other Status Codes	DataShareError	Risposta di errore ricevuta dal provider di risorse Microsoft.DataShare.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ConsumerInvitations_ListInvitations

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

Definizioni

Nome	Descrizione
ConsumerInvitation	Oggetto di trasferimento dei dati di invito del consumer.
ConsumerInvitationList	Risposta elenco per get InvitationList
createdByType	Tipo di identità che ha creato la risorsa.
DataShareError	Modello di errore di condivisione dati.
DataShareErrorInfo	Modello del corpo dell'errore di condivisione dati.
invitationStatus	Stato dell'invito.
lastModifiedByType	Tipo di identità che ha modificato l'ultima risorsa.
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

ConsumerInvitation

Oggetto di trasferimento dei dati di invito del consumer.

Nome	Tipo	Descrizione
id	string	ID risorsa della risorsa di Azure
name	string	Nome della risorsa di Azure
properties.dataSetCount	integer	Numero di set di dati in una condivisione
properties.description	string	Descrizione condivisa quando è stato creato l'invito
properties.expirationDate	string	Data di scadenza per la sottoscrizione di condivisione creata accettando l'invito.
properties.invitationId	string	ID univoco dell'invito.
properties.invitationStatus	invitationStatus	Stato dell'invito.
properties.location	string	posizione dell'invito
properties.providerEmail	string	Email del provider che ha creato la risorsa
properties.providerName	string	Nome del provider che ha creato la risorsa
properties.providerTenantName	string	Nome tenant del provider che ha creato la risorsa
properties.respondedAt	string	Ora in cui il destinatario ha risposto all'invito.
properties.sentAt	string	Ottiene l'ora in cui è stato inviato l'invito.
properties.shareName	string	Ottiene il nome della condivisione di origine.
properties.termsOfUse	string	Condizioni di utilizzo condivise quando è stato creato l'invito
properties.userEmail	string	Email dell'utente che ha creato la risorsa
properties.userName	string	Nome dell'utente che ha creato la risorsa
systemData	SystemData	Dati di sistema della risorsa di Azure.
type	string	Tipo della risorsa di Azure

ConsumerInvitationList

Risposta elenco per get InvitationList

Nome	Tipo	Descrizione
nextLink	string	Url della pagina dei risultati successiva.
value	ConsumerInvitation[]	Raccolta di elementi di tipo DataTransferObjects.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

DataShareError

Modello di errore di condivisione dati.

Nome	Tipo	Descrizione
error	DataShareErrorInfo	Corpo dell'errore di condivisione dati

DataShareErrorInfo

Modello del corpo dell'errore di condivisione dati.

Nome	Tipo	Descrizione
code	string	Codice dell'errore
details	DataShareErrorInfo[]	Dettagli annidati del modello di errore
message	string	Messaggio dell'errore
target	string	Destinazione dell'errore

invitationStatus

Stato dell'invito.

Nome	Tipo	Descrizione
Accepted	string
Pending	string
Rejected	string
Withdrawn	string

lastModifiedByType

Tipo di identità che ha modificato l'ultima risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Tipo di identità che ha modificato l'ultima risorsa.
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	lastModifiedByType	Tipo di identità che ha modificato l'ultima risorsa.