你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Consumer Invitations - List Invitations

Service:

Data Share

API Version:

2021-08-01

列出邀请
Lists邀请

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 参数

名称	在	必需	类型	说明
api-version	query	True	string	要使用的 API 版本。
$skipToken	query		string	继续标记

响应

名称	类型	说明
200 OK	ConsumerInvitationList	成功
Other Status Codes	DataShareError	从 Microsoft.DataShare 资源提供程序收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

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

定义

名称	说明
ConsumerInvitation	使用者邀请数据传输对象。
ConsumerInvitationList	列出获取 InvitationList 的响应
createdByType	创建资源的标识类型。
DataShareError	数据共享错误模型。
DataShareErrorInfo	数据共享错误主体模型。
invitationStatus	邀请的状态。
lastModifiedByType	上次修改资源的标识类型。
SystemData	与资源的创建和上次修改相关的元数据。

ConsumerInvitation

使用者邀请数据传输对象。

名称	类型	说明
id	string	Azure 资源的资源 ID
name	string	Azure 资源的名称
properties.dataSetCount	integer	共享中的数据集数
properties.description	string	创建邀请时共享的说明
properties.expirationDate	string	通过接受邀请创建的共享订阅的到期日期。
properties.invitationId	string	邀请的唯一 ID。
properties.invitationStatus	invitationStatus	邀请的状态。
properties.location	string	邀请位置
properties.providerEmail	string	创建资源的提供程序的Email
properties.providerName	string	创建资源的提供程序的名称
properties.providerTenantName	string	创建资源的提供程序的租户名称
properties.respondedAt	string	收件人响应邀请的时间。
properties.sentAt	string	获取发送邀请的时间。
properties.shareName	string	获取源共享名称。
properties.termsOfUse	string	创建邀请时共享的使用条款
properties.userEmail	string	创建资源的用户的Email
properties.userName	string	创建资源的用户的名称
systemData	SystemData	Azure 资源的系统数据。
type	string	Azure 资源的类型

ConsumerInvitationList

列出获取 InvitationList 的响应

名称	类型	说明
nextLink	string	下一个结果页的 URL。
value	ConsumerInvitation[]	DataTransferObjects 类型的项的集合。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DataShareError

数据共享错误模型。

名称	类型	说明
error	DataShareErrorInfo	数据共享错误正文

DataShareErrorInfo

数据共享错误主体模型。

名称	类型	说明
code	string	错误代码
details	DataShareErrorInfo[]	错误模型的嵌套详细信息
message	string	错误消息
target	string	错误的目标

invitationStatus

邀请的状态。

名称	类型	说明
Accepted	string
Pending	string
Rejected	string
Withdrawn	string

lastModifiedByType

上次修改资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	上次修改资源的标识类型。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	lastModifiedByType	上次修改资源的标识类型。