Invitations - Create

Sendet eine neue Einladung an einen Empfänger, um auf eine Freigabe zuzugreifen.
Erstellen einer Einladung

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

URI-Parameter

Name In Required Type Description
accountName
path True
  • string

Der Name des Freigabekontos.

invitationName
path True
  • string

Der Name der Einladung.

resourceGroupName
path True
  • string

Der Name der Ressourcengruppe.

shareName
path True
  • string

Der Name der Freigabe, um die Einladung zu senden.

subscriptionId
path True
  • string

Der Abonnementbezeichner

api-version
query True
  • string

Die zu verwendende API-Version.

Anforderungstext

Name Type Description
properties.expirationDate
  • string

Das Ablaufdatum für das Einladungs- und Freigabeabonnement.

properties.targetActiveDirectoryId
  • string

Die Ziel-Azure AD-ID. Kann nicht mit E-Mails kombiniert werden.

properties.targetEmail
  • string

Die Einladung wird an die E-Mail weitergeleitet.

properties.targetObjectId
  • string

Der Zielbenutzer oder die Anwendungs-ID, an die die Einladung gesendet wird. Muss entlang der TargetActiveDirectoryId angegeben werden. Dadurch können Einladungen an bestimmte Benutzer oder Anwendungen in einem AD-Mandanten gesendet werden.

Antworten

Name Type Description
200 OK

Erfolgreich

201 Created

Erfolgreich

Other Status Codes

Eine Fehlermeldung, die vom Microsoft.DataShare-Ressourcenanbieter empfangen wurde.

Sicherheit

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 Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

DataShareError

Das Fehlermodell für die Datenfreigabe.

DataShareErrorInfo

Das Fehlertextmodell der Datenfreigabe.

Invitation

Ein Einladungsdatenübertragungsobjekt.

invitationStatus

Der Status der Einladung.

lastModifiedByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

SystemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

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

DataShareError

Das Fehlermodell für die Datenfreigabe.

Name Type Description
error

Der Fehlertext der Datenfreigabe

DataShareErrorInfo

Das Fehlertextmodell der Datenfreigabe.

Name Type Description
code
  • string

Code des Fehlers

details

Geschachtelte Details des Fehlermodells

message
  • string

Meldung des Fehlers

target
  • string

Ziel des Fehlers

Invitation

Ein Einladungsdatenübertragungsobjekt.

Name Type Description
id
  • string

Die Ressourcen-ID der Azure-Ressource

name
  • string

Name der Azure-Ressource

properties.expirationDate
  • string

Das Ablaufdatum für das Einladungs- und Freigabeabonnement.

properties.invitationId
  • string

eindeutige Einladungs-ID

properties.invitationStatus

Der Status der Einladung.

properties.respondedAt
  • string

Der Zeitpunkt, an dem der Empfänger auf die Einladung reagiert hat.

properties.sentAt
  • string

Ruft die Uhrzeit ab, zu der die Einladung gesendet wurde.

properties.targetActiveDirectoryId
  • string

Die Ziel-Azure AD-ID. Kann nicht mit E-Mails kombiniert werden.

properties.targetEmail
  • string

Die Einladung wird an die E-Mail weitergeleitet.

properties.targetObjectId
  • string

Der Zielbenutzer oder die Anwendungs-ID, an die die Einladung gesendet wird. Muss entlang der TargetActiveDirectoryId angegeben werden. Dadurch können Einladungen an bestimmte Benutzer oder Anwendungen in einem AD-Mandanten gesendet werden.

properties.userEmail
  • string

E-Mail des Benutzers, der die Ressource erstellt hat

properties.userName
  • string

Name des Benutzers, der die Ressource erstellt hat

systemData

Systemdaten der Azure-Ressource.

type
  • string

Typ der Azure-Ressource

invitationStatus

Der Status der Einladung.

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

lastModifiedByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

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

SystemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Type Description
createdAt
  • string

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy
  • string

Die Identität, die die Ressource erstellt hat.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt
  • string

Der Identitätstyp, der die Ressource zuletzt geändert hat.

lastModifiedBy
  • string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.