Received Shares - Create

Utwórz odebrany udział na danym koncie.

PUT {endpoint}/receivedShares/{receivedShareName}?api-version=2021-09-01-preview

Parametry identyfikatora URI

Name In Required Type Description
endpoint
path True
  • string

Punkt końcowy skanowania konta purview. Przykład: https://{accountName}.purview.azure.com/share

receivedShareName
path True
  • string

Nazwa odebranego udziału

api-version
query True
  • string

Wersja interfejsu API do użycia.

Treść żądania

InPlaceReceivedShare

Rodzaj udziału otrzymany za pomocą elementu InPlace.

Name Required Type Description
properties.collection True

Odwołanie do kolekcji.

properties.invitationId True
  • string

Identyfikator zaproszenia.

properties.sentShareLocation True
  • string

Wysłano lokalizację udziału.

shareKind True string:
  • InPlace

Definiuje obsługiwane typy dla udziału.

properties.expirationDate
  • string

Data wygaśnięcia odebranego udziału.

properties.sentShareDescription
  • string

Opis udziału.

Odpowiedzi

Name Type Description
201 Created ReceivedShare:

Powodzenie

Other Status Codes

Domyślna odpowiedź na błąd.

Przykłady

ReceivedShares_Create

Sample Request

PUT accountName.purview.azure.com/share/receivedShares/receivedShareName1?api-version=2021-09-01-preview

{
  "properties": {
    "sentShareLocation": "eastus2",
    "invitationId": "47d1b6ae-3186-414c-8067-fdd9aba49b0f",
    "collection": {
      "referenceName": "accountName",
      "type": "CollectionReference"
    }
  },
  "shareKind": "InPlace"
}

Sample Response

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
{
  "properties": {
    "createdAt": "2021-07-21T18:18:50.7095202Z",
    "sharedAt": "2021-07-21T18:17:56.1065304Z",
    "invitationId": "47d1b6ae-3186-414c-8067-fdd9aba49b0f",
    "provisioningState": "Succeeded",
    "receivedShareStatus": "Active",
    "sentShareDescription": "description",
    "sentShareLocation": "eastus2",
    "shareName": "share1",
    "receiverName": "Jane Doe",
    "receiverEmail": "janedoe@fabrikam.com",
    "receiverTenantName": "Fabrikam",
    "senderName": "John Smith",
    "senderEmail": "john.smith@microsoft.com",
    "senderTenantName": "Contoso",
    "collection": {
      "referenceName": "accountName",
      "type": "CollectionReference"
    }
  },
  "id": "/receivedShares/receivedShareName1",
  "name": "receivedShareName1",
  "type": "receivedShares",
  "shareKind": "InPlace"
}

Definicje

Collection

Odwołanie do kolekcji.

InPlaceReceivedShare

Rodzaj udziału otrzymany za pomocą elementu InPlace.

ProvisioningState

Stan aprowizacji zasobu

PurviewShareError

Model błędu udziału purview.

PurviewShareErrorInfo

Model treści udziału usługi purview.

ReceivedShareStatus

stan odebranych udziałów

ShareKind

Definiuje obsługiwane typy dla udziału.

Collection

Odwołanie do kolekcji.

Name Type Description
referenceName
  • string

Pobiera lub ustawia nazwę odwołania.

type
  • string

Pobiera lub ustawia właściwość typu odwołania.

InPlaceReceivedShare

Rodzaj udziału otrzymany za pomocą elementu InPlace.

Name Type Description
id
  • string

Identyfikator zasobu.

name
  • string

Nazwa zasobu.

properties.collection

Odwołanie do kolekcji.

properties.createdAt
  • string

Godzina utworzenia odebranych udziałów.

properties.expirationDate
  • string

Data wygaśnięcia odebranego udziału.

properties.invitationId
  • string

Identyfikator zaproszenia.

properties.provisioningState

Stan aprowizacji zasobu

properties.receivedShareStatus

stan odebranych udziałów

properties.receiverEmail
  • string

Email użytkownika/odbiorcy, który otrzymał wysłane zaproszenie do udziału

properties.receiverName
  • string

Nazwa użytkownika/odbiorcy, który otrzymał wysłane zaproszenie do udziału

properties.receiverTenantName
  • string

Nazwa dzierżawy użytkownika/odbiorcy, który otrzymał wysłane zaproszenie do udziału

properties.senderEmail
  • string

Email nadawcy, który utworzył wysłane zaproszenie do udziału

properties.senderName
  • string

Nazwa nadawcy, który utworzył wysłane zaproszenie do udziału

properties.senderTenantName
  • string

Nazwa dzierżawy nadawcy, który utworzył wysłane zaproszenie do udziału

properties.sentShareDescription
  • string

Opis udziału.

properties.sentShareLocation
  • string

Wysłano lokalizację udziału.

properties.shareName
  • string

Nazwa udziału

properties.sharedAt
  • string

Czas udostępniania wysłanego udziału.

shareKind string:
  • InPlace

Definiuje obsługiwane typy dla udziału.

type
  • string

Typ zasobu.

ProvisioningState

Stan aprowizacji zasobu

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Moving
  • string
SoftDeleted
  • string
SoftDeleting
  • string
SourceDeleted
  • string
SourceMoved
  • string
Succeeded
  • string
TargetDeleted
  • string
TargetMoved
  • string
Unknown
  • string

PurviewShareError

Model błędu udziału purview.

Name Type Description
error

Model treści udziału usługi purview.

PurviewShareErrorInfo

Model treści udziału usługi purview.

Name Type Description
code
  • string

Kod błędu

details

Zagnieżdżone szczegóły modelu błędów

message
  • string

Komunikat o błędzie

target
  • string

Element docelowy błędu

ReceivedShareStatus

stan odebranych udziałów

Name Type Description
Active
  • string
ReinstateFailed
  • string
Reinstating
  • string
RevokeFailed
  • string
Revoked
  • string
Revoking
  • string
SourceDeleted
  • string

ShareKind

Definiuje obsługiwane typy dla udziału.

Name Type Description
InPlace
  • string