Invitations - Create

Referensi

Service:: Data Share

API Version:: 2021-08-01

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

Nama	Dalam	Diperlukan	Jenis	Deskripsi
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

Nama	Jenis	Deskripsi
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

Nama	Jenis	Deskripsi
200 OK	Invitation	Berhasil
201 Created	Invitation	Berhasil
Other Status Codes	DataShareError	Respons kesalahan yang diterima dari penyedia sumber daya Microsoft.DataShare.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
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.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

DataShareError

Model kesalahan berbagi data.

Nama	Jenis	Deskripsi
error	DataShareErrorInfo	Isi kesalahan berbagi data

DataShareErrorInfo

Model isi kesalahan berbagi data.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan
details	DataShareErrorInfo[]	Detail berlapis dari model kesalahan
message	string	Pesan kesalahan
target	string	Target kesalahan

Invitation

Objek transfer data Undangan.

Nama	Jenis	Deskripsi
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	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	SystemData	Data Sistem sumber daya Azure.
type	string	Jenis sumber daya azure

invitationStatus

Status undangan.

Nama	Jenis	Deskripsi
Accepted	string
Pending	string
Rejected	string
Withdrawn	string

lastModifiedByType

Jenis identitas yang terakhir mengubah sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	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	lastModifiedByType	Jenis identitas yang terakhir mengubah sumber daya.