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

Invitations - Create

参考

Service:: Data Share

API Version:: 2021-08-01

向收件人发送访问共享的新邀请。
创建邀请

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}?api-version=2021-08-01

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	共享帐户的名称。
invitationName	path	True	string	邀请的名称。
resourceGroupName	path	True	string	资源组名称。
shareName	path	True	string	要为其发送邀请的共享的名称。
subscriptionId	path	True	string	订阅标识符
api-version	query	True	string	要使用的 API 版本。

请求正文

名称	类型	说明
properties.expirationDate	string	邀请和共享订阅的到期日期。
properties.targetActiveDirectoryId	string	目标 Azure AD ID。无法与电子邮件结合使用。
properties.targetEmail	string	邀请定向到的电子邮件。
properties.targetObjectId	string	发送邀请的目标用户或应用程序 ID。必须沿 TargetActiveDirectoryId 指定。这样，就可以向 AD 租户中的特定用户或应用程序发送邀请。

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Invitations_Create

PUT https://management.azure.com/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/invitations/Invitation1?api-version=2021-08-01

{
  "properties": {
    "targetEmail": "receiver@microsoft.com",
    "expirationDate": "2020-08-26T22:33:24.5785265Z"
  }
}

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/Invitations_Create.json
// this example is just showing the usage of "Invitations_Create" 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 DataShareInvitationResource created on azure
// for more information of creating DataShareInvitationResource, please refer to the document of DataShareInvitationResource
string subscriptionId = "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a";
string resourceGroupName = "SampleResourceGroup";
string accountName = "Account1";
string shareName = "Share1";
string invitationName = "Invitation1";
ResourceIdentifier dataShareInvitationResourceId = DataShareInvitationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, shareName, invitationName);
DataShareInvitationResource dataShareInvitation = client.GetDataShareInvitationResource(dataShareInvitationResourceId);

// invoke the operation
DataShareInvitationData data = new DataShareInvitationData()
{
    ExpireOn = DateTimeOffset.Parse("2020-08-26T22:33:24.5785265Z"),
    TargetEmail = "receiver@microsoft.com",
};
ArmOperation<DataShareInvitationResource> lro = await dataShareInvitation.UpdateAsync(WaitUntil.Completed, data);
DataShareInvitationResource result = lro.Value;

// 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
DataShareInvitationData 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

Sample Response

Status code:: 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

Response Body

{
  "properties": {
    "userName": "John Smith",
    "sentAt": "2018-11-26T22:33:24.5785265Z",
    "targetEmail": "receiver@microsoft.com",
    "respondedAt": null,
    "invitationStatus": "Pending",
    "userEmail": "johnsmith@microsoft.com",
    "expirationDate": "2020-08-26T22:33:24.5785265Z"
  },
  "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/invitations/Invitation1",
  "name": "Invitation1",
  "type": "Microsoft.DataShare/accounts/shares/invitations"
}

Status code:: 201

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

Response Body

{
  "properties": {
    "userName": "John Smith",
    "sentAt": "2018-11-26T22:33:24.5785265Z",
    "targetEmail": "receiver@microsoft.com",
    "respondedAt": null,
    "invitationStatus": "Pending",
    "userEmail": "johnsmith@microsoft.com",
    "expirationDate": "2020-08-26T22:33:24.5785265Z"
  },
  "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/invitations/Invitation1",
  "name": "Invitation1",
  "type": "Microsoft.DataShare/accounts/shares/invitations"
}

定义

名称	说明
createdByType	创建资源的标识类型。
DataShareError	数据共享错误模型。
DataShareErrorInfo	数据共享错误主体模型。
Invitation	邀请数据传输对象。
invitationStatus	邀请的状态。
lastModifiedByType	上次修改资源的标识类型。
SystemData	与资源的创建和上次修改相关的元数据。

createdByType

创建资源的标识类型。

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

DataShareError

数据共享错误模型。

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

DataShareErrorInfo

数据共享错误主体模型。

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

Invitation

邀请数据传输对象。

名称	类型	说明
id	string	Azure 资源的资源 ID
name	string	Azure 资源的名称
properties.expirationDate	string	邀请和共享订阅的到期日期。
properties.invitationId	string	唯一邀请 ID
properties.invitationStatus	invitationStatus	邀请的状态。
properties.respondedAt	string	收件人响应邀请的时间。
properties.sentAt	string	获取发送邀请的时间。
properties.targetActiveDirectoryId	string	目标 Azure AD ID。无法与电子邮件结合使用。
properties.targetEmail	string	邀请定向到的电子邮件。
properties.targetObjectId	string	发送邀请的目标用户或应用程序 ID。必须沿 TargetActiveDirectoryId 指定。这样，就可以向 AD 租户中的特定用户或应用程序发送邀请。
properties.userEmail	string	Email创建资源的用户
properties.userName	string	创建资源的用户的名称
systemData	SystemData	Azure 资源的系统数据。
type	string	Azure 资源的类型

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	上次修改资源的标识类型。