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	Success
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	ユーザーアカウントの借用

例

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	リソースを作成した ID の種類。
DataShareError	データ共有エラーモデル。
DataShareErrorInfo	データ共有エラー本文モデル。
Invitation	Invitation データ転送オブジェクト。
invitationStatus	招待の状態。
lastModifiedByType	リソースを最後に変更した ID の種類。
SystemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

DataShareError

データ共有エラーモデル。

名前	型	説明
error	DataShareErrorInfo	データ共有エラー本文

DataShareErrorInfo

データ共有エラー本文モデル。

名前	型	説明
code	string	エラーのコード
details	DataShareErrorInfo[]	エラーモデルの入れ子になった詳細
message	string	エラーのメッセージ
target	string	エラーのターゲット

Invitation

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

リソースを最後に変更した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースを最後に変更した ID の種類。
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	lastModifiedByType	リソースを最後に変更した ID の種類。