Invitations - Create

Mengirim undangan baru ke penerima untuk mengakses berbagi.
Membuat undangan

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

Parameter URI

Name In Required Type Description
accountName
path True
  • string

Nama akun berbagi.

invitationName
path True
  • string

Nama undangan.

resourceGroupName
path True
  • string

Nama grup sumber daya.

shareName
path True
  • string

Nama berbagi yang akan dikirimi undangan.

subscriptionId
path True
  • string

Pengidentifikasi langganan

api-version
query True
  • string

Versi api yang akan digunakan.

Isi Permintaan

Name Type Description
properties.expirationDate
  • string

Tanggal kedaluwarsa untuk undangan dan langganan berbagi.

properties.targetActiveDirectoryId
  • string

Id Azure AD target. Tidak dapat digabungkan dengan email.

properties.targetEmail
  • string

Email tempat undangan diarahkan.

properties.targetObjectId
  • string

Id pengguna atau aplikasi target tempat undangan dikirim. Harus ditentukan di sepanjang TargetActiveDirectoryId. Ini memungkinkan pengiriman undangan ke pengguna atau aplikasi tertentu dalam penyewa AD.

Respons

Name Type Description
200 OK

Berhasil

201 Created

Berhasil

Other Status Codes

Respons kesalahan yang diterima dari penyedia sumber daya Microsoft.DataShare.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

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

Definisi

createdByType

Jenis identitas yang membuat sumber daya.

DataShareError

Model kesalahan berbagi data.

DataShareErrorInfo

Model isi kesalahan berbagi data.

Invitation

Objek transfer data Undangan.

invitationStatus

Status undangan.

lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.

SystemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

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

DataShareError

Model kesalahan berbagi data.

Name Type Description
error

Isi kesalahan berbagi data

DataShareErrorInfo

Model isi kesalahan berbagi data.

Name Type Description
code
  • string

Kode kesalahan

details

Detail berlapis dari model kesalahan

message
  • string

Pesan kesalahan

target
  • string

Target kesalahan

Invitation

Objek transfer data Undangan.

Name Type Description
id
  • string

Id sumber daya sumber daya azure

name
  • string

Nama sumber daya azure

properties.expirationDate
  • string

Tanggal kedaluwarsa untuk undangan dan langganan berbagi.

properties.invitationId
  • string

id undangan unik

properties.invitationStatus

Status undangan.

properties.respondedAt
  • string

Waktu penerima merespons undangan.

properties.sentAt
  • string

Mendapatkan waktu saat undangan dikirim.

properties.targetActiveDirectoryId
  • string

Id Azure AD target. Tidak dapat digabungkan dengan email.

properties.targetEmail
  • string

Email tempat undangan diarahkan.

properties.targetObjectId
  • string

Id pengguna atau aplikasi target tempat undangan dikirim. Harus ditentukan di sepanjang TargetActiveDirectoryId. Ini memungkinkan pengiriman undangan ke pengguna atau aplikasi tertentu dalam penyewa AD.

properties.userEmail
  • string

Email pengguna yang membuat sumber daya

properties.userName
  • string

Nama pengguna yang membuat sumber daya

systemData

Data Sistem sumber daya Azure.

type
  • string

Jenis sumber daya azure

invitationStatus

Status undangan.

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

lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.

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

SystemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Name Type Description
createdAt
  • string

Tanda waktu pembuatan sumber daya (UTC).

createdBy
  • string

Identitas yang membuat sumber daya.

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt
  • string

Jenis identitas yang terakhir mengubah sumber daya.

lastModifiedBy
  • string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.