Consumer Invitations - Reject Invitation

服务:

Data Share

API 版本:

2021-08-01

拒绝由 invitationId 标识的邀请
拒绝邀请

POST https://management.azure.com/providers/Microsoft.DataShare/locations/{location}/rejectInvitation?api-version=2021-08-01

URI 参数

名称	在	必需	类型	说明
location	path	True	string	邀请的位置
api-version	query	True	string	要使用的 API 版本。

请求正文

名称	必需	类型	说明
properties.invitationId	True	string	邀请的唯一 ID。

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ConsumerInvitations_RejectInvitation

示例请求

HTTP

POST https://management.azure.com/providers/Microsoft.DataShare/locations/East US 2/rejectInvitation?api-version=2021-08-01

{
  "properties": {
    "invitationId": "dfbbc788-19eb-4607-a5a1-c74181bfff03"
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataShare.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.DataShare;

// Generated from example definition: specification/datashare/resource-manager/Microsoft.DataShare/stable/2021-08-01/examples/ConsumerInvitations_RejectInvitation.json
// this example is just showing the usage of "ConsumerInvitations_RejectInvitation" 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);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation
AzureLocation location = new AzureLocation("East US 2");
DataShareConsumerInvitationData data = new DataShareConsumerInvitationData(Guid.Parse("dfbbc788-19eb-4607-a5a1-c74181bfff03"));
DataShareConsumerInvitationResource result = await tenantResource.RejectConsumerInvitationAsync(location, data);

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

{
  "properties": {
    "location": "eastus2",
    "invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
    "providerName": "John Smith",
    "providerEmail": "john.smith@microsoft.com",
    "providerTenantName": "microsoft",
    "sentAt": "2019-01-15T01:45:25.6226946Z",
    "respondedAt": "2019-01-15T02:01:51.8953054Z",
    "invitationStatus": "Rejected",
    "description": "Some share",
    "termsOfUse": "Confidential",
    "dataSetCount": 1,
    "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	使用者邀请数据传输对象。
createdByType	创建资源的标识的类型。
DataShareError	数据共享错误模型。
DataShareErrorInfo	数据共享错误正文模型。
invitationStatus	邀请的状态。
lastModifiedByType	上次修改资源的标识的类型。
SystemData	与创建和上次修改资源相关的元数据。

ConsumerInvitation

Object

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

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

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DataShareError

Object

数据共享错误模型。

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

DataShareErrorInfo

Object

数据共享错误正文模型。

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

invitationStatus

枚举

邀请的状态。

值	说明
Accepted
Pending
Rejected
Withdrawn

lastModifiedByType

枚举

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

值	说明
Application
Key
ManagedIdentity
User

SystemData

Object

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

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