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

Consumer Invitations - List Invitations

列出邀请
列出邀请

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

URI 参数

Name In Required Type Description
api-version
query True
  • string

要使用的 API 版本。

$skipToken
query
  • string

延续标记

响应

Name Type Description
200 OK

成功

Other Status Codes

从 Microsoft.DataShare 资源提供程序收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

ConsumerInvitations_ListInvitations

Sample Request

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

Sample Response

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
{
  "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"
      },
      "id": "providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487",
      "name": "invitation1",
      "type": "Microsoft.DataShare/locations/consumerInvitations"
    }
  ]
}

定义

ConsumerInvitation

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

ConsumerInvitationList

获取 InvitationList 的列表响应

DataShareError

数据共享错误模型。

DataShareErrorInfo

数据共享错误正文模型。

invitationStatus

邀请的状态。

ConsumerInvitation

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

Name Type Description
id
  • string

Azure 资源的资源 ID

name
  • string

Azure 资源的名称

properties.dataSetCount
  • integer

共享中的数据集数

properties.description
  • string

创建邀请时共享的说明

properties.invitationId
  • string

邀请的唯一 ID。

properties.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

创建资源的用户的名称

type
  • string

Azure 资源的类型

ConsumerInvitationList

获取 InvitationList 的列表响应

Name Type Description
nextLink
  • string

下一个结果页的 URL。

value

DataTransferObjects 类型的项的集合。

DataShareError

数据共享错误模型。

Name Type Description
error

数据共享错误正文

DataShareErrorInfo

数据共享错误正文模型。

Name Type Description
code
  • string

错误代码

details

错误模型的嵌套详细信息

message
  • string

错误消息

target
  • string

错误的目标

invitationStatus

邀请的状态。

Name Type Description
Accepted
  • string
Pending
  • string
Rejected
  • string
Withdrawn
  • string