Invitations - Create

Envia um novo convite para um destinatário acessar um compartilhamento.
Criar um convite

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

Parâmetros de URI

Name In Required Type Description
accountName
path True
  • string

O nome da conta de compartilhamento.

invitationName
path True
  • string

O nome do convite.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

shareName
path True
  • string

O nome do compartilhamento para o qual enviar o convite.

subscriptionId
path True
  • string

O identificador de assinatura

api-version
query True
  • string

A versão da API a ser usada.

Corpo da solicitação

Name Type Description
properties.expirationDate
  • string

A data de validade do convite e da assinatura de compartilhamento.

properties.targetActiveDirectoryId
  • string

O destino Azure AD ID. Não pode ser combinado com email.

properties.targetEmail
  • string

O email para o qual o convite é direcionado.

properties.targetObjectId
  • string

O usuário de destino ou a ID do aplicativo para o qual o convite está sendo enviado. Deve ser especificado ao longo de TargetActiveDirectoryId. Isso permite o envio de convites para usuários ou aplicativos específicos em um locatário do AD.

Respostas

Name Type Description
200 OK

Êxito

201 Created

Êxito

Other Status Codes

Uma resposta de erro recebida do provedor de recursos Microsoft.DataShare.

Segurança

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 representar sua conta de usuário

Exemplos

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

Definições

createdByType

O tipo de identidade que criou o recurso.

DataShareError

O modelo de erro de compartilhamento de dados.

DataShareErrorInfo

O modelo do corpo do erro do compartilhamento de dados.

Invitation

Um objeto de transferência de dados de convite.

invitationStatus

O status do convite.

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.

SystemData

Metadados relativos à criação e última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

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

DataShareError

O modelo de erro de compartilhamento de dados.

Name Type Description
error

O corpo do erro do compartilhamento de dados

DataShareErrorInfo

O modelo do corpo do erro do compartilhamento de dados.

Name Type Description
code
  • string

Código do erro

details

Detalhes aninhados do modelo de erro

message
  • string

Mensagem do erro

target
  • string

Destino do erro

Invitation

Um objeto de transferência de dados de convite.

Name Type Description
id
  • string

A ID do recurso do azure

name
  • string

Nome do recurso do azure

properties.expirationDate
  • string

A data de validade do convite e da assinatura de compartilhamento.

properties.invitationId
  • string

ID de convite exclusivo

properties.invitationStatus

O status do convite.

properties.respondedAt
  • string

A hora em que o destinatário respondeu ao convite.

properties.sentAt
  • string

Obtém a hora em que o convite foi enviado.

properties.targetActiveDirectoryId
  • string

O destino Azure AD ID. Não pode ser combinado com email.

properties.targetEmail
  • string

O email para o qual o convite é direcionado.

properties.targetObjectId
  • string

O usuário de destino ou a ID do aplicativo para o qual o convite está sendo enviado. Deve ser especificado ao longo de TargetActiveDirectoryId. Isso permite o envio de convites para usuários ou aplicativos específicos em um locatário do AD.

properties.userEmail
  • string

Email do usuário que criou o recurso

properties.userName
  • string

Nome do usuário que criou o recurso

systemData

Dados do sistema do recurso do Azure.

type
  • string

Tipo do recurso do azure

invitationStatus

O status do convite.

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

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.

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

SystemData

Metadados relativos à criação e última modificação do recurso.

Name Type Description
createdAt
  • string

O carimbo de data/hora da criação de recursos (UTC).

createdBy
  • string

A identidade que criou o recurso.

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt
  • string

O tipo de identidade que modificou o recurso pela última vez.

lastModifiedBy
  • string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.