Consumer Invitations - List Invitations

Referencia

Service:: Data Share

API Version:: 2021-08-01

Enumeración de las invitaciones
invitaciones de Listas

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	La versión de api que se va a usar.
$skipToken	query		string	Token de continuación

Respuestas

Nombre	Tipo	Description
200 OK	ConsumerInvitationList	Correcto
Other Status Codes	DataShareError	Respuesta de error recibida del proveedor de recursos Microsoft.DataShare.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
ConsumerInvitation	Objeto de transferencia de datos invitación de consumidor.
ConsumerInvitationList	Respuesta de lista para get InvitationList
createdByType	Tipo de identidad que creó el recurso.
DataShareError	Modelo de error del recurso compartido de datos.
DataShareErrorInfo	Modelo de cuerpo del error del recurso compartido de datos.
invitationStatus	Estado de la invitación.
lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.
SystemData	Metadatos relacionados con la creación y la última modificación del recurso.

ConsumerInvitation

Objeto de transferencia de datos invitación de consumidor.

Nombre	Tipo	Description
id	string	El identificador de recurso del recurso de Azure
name	string	Nombre del recurso de Azure
properties.dataSetCount	integer	Número de conjuntos de datos de un recurso compartido
properties.description	string	Descripción compartida cuando se creó la invitación
properties.expirationDate	string	Fecha de expiración de la suscripción de recurso compartido creada aceptando la invitación.
properties.invitationId	string	Identificador único de la invitación.
properties.invitationStatus	invitationStatus	Estado de la invitación.
properties.location	string	ubicación de invitación
properties.providerEmail	string	Email del proveedor que creó el recurso
properties.providerName	string	Nombre del proveedor que creó el recurso
properties.providerTenantName	string	Nombre de inquilino del proveedor que creó el recurso
properties.respondedAt	string	Hora a la que el destinatario respondió a la invitación.
properties.sentAt	string	Obtiene la hora en la que se envió la invitación.
properties.shareName	string	Obtiene el nombre del recurso compartido de origen.
properties.termsOfUse	string	Términos de uso compartidos cuando se creó la invitación
properties.userEmail	string	Email del usuario que creó el recurso
properties.userName	string	Nombre del usuario que creó el recurso
systemData	SystemData	Datos del sistema del recurso de Azure.
type	string	Tipo del recurso de Azure

ConsumerInvitationList

Respuesta de lista para get InvitationList

Nombre	Tipo	Description
nextLink	string	Dirección URL de la página de resultados siguiente.
value	ConsumerInvitation[]	Colección de elementos de tipo DataTransferObjects.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataShareError

Modelo de error del recurso compartido de datos.

Nombre	Tipo	Description
error	DataShareErrorInfo	Cuerpo del error del recurso compartido de datos

DataShareErrorInfo

Modelo de cuerpo del error del recurso compartido de datos.

Nombre	Tipo	Description
code	string	Código del error
details	DataShareErrorInfo[]	Detalles anidados del modelo de error
message	string	Mensaje del error
target	string	Destino del error

invitationStatus

Estado de la invitación.

Nombre	Tipo	Description
Accepted	string
Pending	string
Rejected	string
Withdrawn	string

lastModifiedByType

Tipo de identidad que modificó por última vez el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Tipo de identidad que modificó por última vez el recurso.
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.