Sent Shares - Get Invitation

Layanan:

Purview

Versi API:

2023-02-15-preview

Mendapatkan undangan berbagi terkirim untuk berbagi terkirim yang diberikan
Mendapatkan penerima untuk berbagi terkirim yang diberikan

GET {endpoint}/sentShares/{sentShareId}/sentShareInvitations/{sentShareInvitationId}?api-version=2023-02-15-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir berbagi akun purview Anda. Contoh: https://{accountName}.purview.azure.com/share
sentShareId	path	True	string maxLength: 36 pattern: ^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$	Id berbagi yang dikirim
sentShareInvitationId	path	True	string maxLength: 36 pattern: ^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$|^(?:[0-9a-fA-F]+)$	Id undangan berbagi yang dikirim
api-version	query	True	string	Versi api yang akan digunakan

Respons

Nama	Jenis	Deskripsi
200 OK	SentShareInvitation: ServiceInvitation UserInvitation	Keberhasilan
Other Status Codes	PurviewShareError	Respons kesalahan default. Header x-ms-error-code: string

Keamanan

azureAuth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://purview.azure.net/.default	Cakupan layanan Purview

Contoh

SentShares_GetInvitation

SentShares_GetServiceInvitation

SentShares_GetUserInvitation

SentShares_GetInvitation

Permintaan sampel

HTTP

GET accountName.purview.azure.com/share/sentShares/FF4A2AAE-8755-47BB-9C00-A774B5A7006E/sentShareInvitations/9F154FA4-93D1-426B-A908-A9CAC7192B21?api-version=2023-02-15-preview

Respon sampel

Kode status:

200

Date: Fri, 12 Aug 2022 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

{
  "properties": {
    "targetEmail": "testReceiver@microsoft.com",
    "notify": true,
    "expirationDate": null,
    "sentAt": "2022-08-04T13:04:32.8172128Z",
    "shareStatus": "Detached",
    "senderName": "Test Sender",
    "senderTenantName": "Test Tenant",
    "senderEmail": "testSender@microsoft.com",
    "state": "Succeeded"
  },
  "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21",
  "type": "sentShares/sentShareInvitations",
  "invitationKind": "User"
}

SentShares_GetServiceInvitation

Permintaan sampel

HTTP

GET accountName.purview.azure.com/share/sentShares/FF4A2AAE-8755-47BB-9C00-A774B5A7006E/sentShareInvitations/9F154FA4-93D1-426B-A908-A9CAC7192B21?api-version=2023-02-15-preview

Respon sampel

Kode status:

200

Date: Fri, 12 Aug 2022 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

{
  "properties": {
    "targetActiveDirectoryId": "5DAE1226-9FAA-4D71-B8D4-87B81DFF672E",
    "targetObjectId": "EFA02830-BB7A-4586-B615-A6DFF19FEBBF",
    "expirationDate": "2022-08-11T13:04:32.8172128Z",
    "shareStatus": "Detached",
    "senderName": "Test Sender",
    "sentAt": "2022-08-04T13:04:32.8172128Z",
    "senderTenantName": "Test Tenant",
    "senderEmail": "testSender@microsoft.com",
    "state": "Succeeded"
  },
  "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21",
  "type": "sentShares/sentShareInvitations",
  "invitationKind": "Service"
}

SentShares_GetUserInvitation

Permintaan sampel

HTTP

GET accountName.purview.azure.com/share/sentShares/FF4A2AAE-8755-47BB-9C00-A774B5A7006E/sentShareInvitations/9F154FA4-93D1-426B-A908-A9CAC7192B21?api-version=2023-02-15-preview

Respon sampel

Kode status:

200

Date: Fri, 12 Aug 2022 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

{
  "properties": {
    "targetEmail": "testReceiver@microsoft.com",
    "notify": true,
    "expirationDate": null,
    "sentAt": "2022-08-04T13:04:32.8172128Z",
    "shareStatus": "Detached",
    "senderName": "Test Sender",
    "senderTenantName": "Test Tenant",
    "senderEmail": "testSender@microsoft.com",
    "state": "Succeeded"
  },
  "id": "9F154FA4-93D1-426B-A908-A9CAC7192B21",
  "type": "sentShares/sentShareInvitations",
  "invitationKind": "User"
}

Definisi

Nama	Deskripsi
InvitationKind	Jenis undangan.
PurviewShareError	Model kesalahan berbagi purview.
PurviewShareErrorInfo	Model isi kesalahan berbagi purview.
ServiceInvitation	Jenis undangan layanan.
ServiceInvitationProperties	Properti jenis undangan layanan.
ShareStatus	Bagikan status.
State	Status sumber daya
UserInvitation	Jenis undangan pengguna.
UserInvitationProperties	Properti jenis undangan pengguna.

InvitationKind

Enumeration

Jenis undangan.

Nilai	Deskripsi
User	Undangan dikirim ke pengguna
Service	Undangan dikirim ke layanan

PurviewShareError

Objek

Model kesalahan berbagi purview.

Nama	Jenis	Deskripsi
error	PurviewShareErrorInfo	Model isi kesalahan berbagi purview.

PurviewShareErrorInfo

Objek

Model isi kesalahan berbagi purview.

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

ServiceInvitation

Objek

Jenis undangan layanan.

Nama	Jenis	Deskripsi
id	string	Id unik sumber daya.
invitationKind	string: Service	Jenis undangan.
properties	ServiceInvitationProperties	Properti jenis undangan layanan.
type	string	Jenis sumber daya.

ServiceInvitationProperties

Objek

Properti jenis undangan layanan.

Nama	Jenis	Deskripsi
expirationDate	string (date-time)	Waktu di mana undangan akan kedaluwarsa. Diwakili dalam format tanggal-waktu standar seperti yang didefinisikan oleh RFC 3339
senderEmail	string	Alamat email pengirim.
senderName	string	Nama pengirim
senderTenantName	string	Nama penyewa pengirim
sentAt	string (date-time)	Mendapatkan waktu saat undangan dikirim. Diwakili dalam format tanggal-waktu standar seperti yang didefinisikan oleh RFC 3339
shareStatus	ShareStatus	Bagikan status.
state	State	Status sumber daya
targetActiveDirectoryId	string (uuid)	Id direktori aktif azure target tempat undangan dikirim.
targetObjectId	string (uuid)	Id objek target di direktori aktif azure tempat undangan dikirim.

ShareStatus

Enumeration

Bagikan status.

Nilai	Deskripsi
Detached	Berbagi belum diterima
Attached	Berbagi telah diterima oleh penerima

State

Enumeration

Status sumber daya

Nilai	Deskripsi
Unknown	Status sumber daya adalah 'Tidak Diketahui'
Succeeded	Status sumber daya adalah 'Berhasil'
Creating	Status sumber daya adalah 'Membuat'
Deleting	Status sumber daya adalah 'Menghapus'
Moving	Status sumber daya adalah 'Bergerak'
Failed	Status sumber daya adalah 'Gagal'

UserInvitation

Objek

Jenis undangan pengguna.

Nama	Jenis	Deskripsi
id	string	Id unik sumber daya.
invitationKind	string: User	Jenis undangan.
properties	UserInvitationProperties	Properti jenis undangan pengguna.
type	string	Jenis sumber daya.

UserInvitationProperties

Objek

Properti jenis undangan pengguna.

Nama	Jenis	Deskripsi
expirationDate	string (date-time)	Waktu di mana undangan akan kedaluwarsa. Diwakili dalam format tanggal-waktu standar seperti yang didefinisikan oleh RFC 3339
notify	boolean	Apakah penerima diberi tahu melalui email atau tidak.
senderEmail	string	Alamat email pengirim.
senderName	string	Nama pengirim
senderTenantName	string	Nama penyewa pengirim
sentAt	string (date-time)	Mendapatkan waktu saat undangan dikirim. Diwakili dalam format tanggal-waktu standar seperti yang didefinisikan oleh RFC 3339
shareStatus	ShareStatus	Bagikan status.
state	State	Status sumber daya
targetEmail	string	Email penerima untuk undangan sedang dikirim.