Invitations - Create

共有にアクセスするための新しい招待を受信者に送信します。
招待を作成する

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

URI パラメーター

Name In Required Type Description
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 のバージョン。

要求本文

Name Type Description
properties.expirationDate
  • string

招待と共有のサブスクリプションの有効期限。

properties.targetActiveDirectoryId
  • string

ターゲットの Azure AD ID。メールと組み合わせることはできません。

properties.targetEmail
  • string

招待の送信先の電子メール。

properties.targetObjectId
  • string

招待の送信先となるターゲット ユーザーまたはアプリケーション ID。 TargetActiveDirectoryId に沿って指定する必要があります。 これにより、AD テナント内の特定のユーザーまたはアプリケーションに招待を送信できます。

応答

Name Type Description
200 OK

成功

201 Created

成功

Other Status Codes

Microsoft.DataShare リソース プロバイダーから受信したエラー応答。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryします。

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

Invitations_Create

Sample Request

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

Sample Response

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": {
    "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"
}
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": {
    "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

招待データ転送オブジェクト。

invitationStatus

招待の状態。

lastModifiedByType

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

SystemData

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

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DataShareError

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

Name Type Description
error

データ共有エラー本文

DataShareErrorInfo

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

Name Type Description
code
  • string

エラーのコード

details

エラー モデルの入れ子になった詳細

message
  • string

エラーのメッセージ

target
  • string

エラーのターゲット

Invitation

招待データ転送オブジェクト。

Name Type Description
id
  • string

Azure リソースのリソース ID

name
  • string

Azure リソースの名前

properties.expirationDate
  • string

招待と共有のサブスクリプションの有効期限。

properties.invitationId
  • string

一意の招待 ID

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

リソースを作成したユーザーの電子メール

properties.userName
  • string

リソースを作成したユーザーの名前

systemData

Azure リソースのシステム データ。

type
  • string

Azure リソースの種類

invitationStatus

招待の状態。

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

lastModifiedByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

SystemData

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

Name Type Description
createdAt
  • string

リソース作成のタイムスタンプ (UTC)。

createdBy
  • string

リソースを作成した ID。

createdByType

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

lastModifiedAt
  • string

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

lastModifiedBy
  • string

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

lastModifiedByType

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