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 매개 변수

Name	In(다음 안에)	필수	형식	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	형식	Description
properties.expirationDate	string	초대 및 공유 구독의 만료 날짜입니다.
properties.targetActiveDirectoryId	string	대상 Azure AD ID입니다. 전자 메일과 결합할 수 없습니다.
properties.targetEmail	string	초대가 전달되는 전자 메일입니다.
properties.targetObjectId	string	초대를 보낼 대상 사용자 또는 애플리케이션 ID입니다. TargetActiveDirectoryId를 따라 지정해야 합니다. 이렇게 하면 AD 테넌트에서 특정 사용자 또는 애플리케이션에 초대를 보낼 수 있습니다.

응답

Name	형식	Description
200 OK	Invitation	성공
201 Created	Invitation	Success
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

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

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
DataShareError	데이터 공유 오류 모델입니다.
DataShareErrorInfo	데이터 공유 오류 본문 모델입니다.
Invitation	초대 데이터 전송 개체입니다.
invitationStatus	초대의 상태.
lastModifiedByType	리소스를 마지막으로 수정한 ID 유형입니다.
SystemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataShareError

데이터 공유 오류 모델입니다.

Name	형식	Description
error	DataShareErrorInfo	데이터 공유 오류 본문

DataShareErrorInfo

데이터 공유 오류 본문 모델입니다.

Name	형식	Description
code	string	오류 코드
details	DataShareErrorInfo[]	오류 모델의 중첩된 세부 정보
message	string	오류 메시지
target	string	오류 대상

Invitation

초대 데이터 전송 개체입니다.

Name	형식	Description
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

초대의 상태.

Name	형식	Description
Accepted	string
Pending	string
Rejected	string
Withdrawn	string

lastModifiedByType

리소스를 마지막으로 수정한 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

SystemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스를 마지막으로 수정한 ID 유형입니다.
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	lastModifiedByType	리소스를 마지막으로 수정한 ID 유형입니다.