Udostępnij za pośrednictwem

Sent Shares - Create Or Replace

Usługa:
Purview
Wersja interfejsu API:
2023-02-15-preview

Tworzenie lub zastępowanie wysłanego udziału

PUT {endpoint}/sentShares/{sentShareId}?api-version=2023-02-15-preview

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
 path True

string

Punkt końcowy udostępniania konta usługi purview. Przykład: 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})$

Identyfikator wysłanego udziału
api-version
 query True

string

Wersja interfejsu API do użycia

Treść żądania

InPlaceSentShare

Rodzaj udziału w miejscu.

Nazwa Wymagane Typ Opis
properties True

InPlaceSentShareProperties

Właściwości dla wysłanego udziału InPlace.
shareKind True string:

InPlace

Definiuje obsługiwane typy dla udziału.

Odpowiedzi

Nazwa Typ Opis
200 OK SentShare:

InPlaceSentShare

Powodzenie

Nagłówki

Operation-Location: string
201 Created SentShare:

InPlaceSentShare

Powodzenie

Nagłówki

Operation-Location: string
Other Status Codes

PurviewShareError

Domyślna odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

azureAuth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
https://purview.azure.net/.default Zakres usługi Purview

Przykłady

SentShares_CreateOrReplace
SentShares_CreateOrReplaceAdlsGen2Account
SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Przykładowe żądanie

PUT accountName.purview.azure.com/share/sentShares/FF4A2AAE-8755-47BB-9C00-A774B5A7006E?api-version=2023-02-15-preview

{
  "properties": {
    "artifact": {
      "storeKind": "AdlsGen2Account",
      "storeReference": {
        "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage",
        "type": "ArmResourceReference"
      },
      "properties": {
        "paths": [
          {
            "containerName": "container1",
            "senderPath": "directory/file.txt",
            "receiverPath": "SharedFile.txt"
          }
        ]
      }
    },
    "displayName": "sentShare1",
    "description": "description"
  },
  "shareKind": "InPlace"
}

Przykładowa odpowiedź

Kod stanu:
201 
Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
x-ms-long-running-operation: True
Operation-Location: https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview
Operation-Id: dad6baec-3a39-41df-a469-843a9ee94213
{
  "properties": {
    "artifact": {
      "storeKind": "AdlsGen2Account",
      "storeReference": {
        "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage",
        "type": "ArmResourceReference"
      },
      "properties": {
        "paths": [
          {
            "containerName": "container1",
            "senderPath": "directory/file.txt",
            "receiverPath": "ShareFile.txt"
          }
        ]
      }
    },
    "createdAt": "2021-07-21T23:45:35.3708674Z",
    "displayName": "sentShare1",
    "description": "description",
    "dependsOn": [],
    "state": "Succeeded",
    "senderName": "John Smith",
    "senderEmail": "johnsmith@contoso.com",
    "senderTenantName": "Contoso"
  },
  "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E",
  "type": "SentShare",
  "shareKind": "InPlace"
}
Kod stanu:
200 
Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
x-ms-long-running-operation: True
Operation-Location: https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview
Operation-Id: dad6baec-3a39-41df-a469-843a9ee94213
{
  "properties": {
    "artifact": {
      "storeKind": "AdlsGen2Account",
      "storeReference": {
        "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage",
        "type": "ArmResourceReference"
      },
      "properties": {
        "paths": [
          {
            "containerName": "container1",
            "senderPath": "directory/file.txt",
            "receiverPath": "ShareFile.txt"
          }
        ]
      }
    },
    "createdAt": "2021-07-21T23:45:35.3708674Z",
    "displayName": "sentShare1",
    "description": "description",
    "dependsOn": [],
    "state": "Succeeded",
    "senderName": "John Smith",
    "senderEmail": "johnsmith@contoso.com",
    "senderTenantName": "Contoso"
  },
  "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E",
  "type": "SentShare",
  "shareKind": "InPlace"
}

SentShares_CreateOrReplaceAdlsGen2Account

Przykładowe żądanie

PUT accountName.purview.azure.com/share/sentShares/FF4A2AAE-8755-47BB-9C00-A774B5A7006E?api-version=2023-02-15-preview

{
  "properties": {
    "artifact": {
      "storeKind": "AdlsGen2Account",
      "storeReference": {
        "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage",
        "type": "ArmResourceReference"
      },
      "properties": {
        "paths": [
          {
            "containerName": "container1",
            "senderPath": "directory/file.txt",
            "receiverPath": "SharedFile.txt"
          }
        ]
      }
    },
    "displayName": "sentShare1",
    "description": "description"
  },
  "shareKind": "InPlace"
}

Przykładowa odpowiedź

Kod stanu:
201 
Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
x-ms-long-running-operation: True
Operation-Location: https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview
Operation-Id: dad6baec-3a39-41df-a469-843a9ee94213
{
  "properties": {
    "artifact": {
      "storeKind": "AdlsGen2Account",
      "storeReference": {
        "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage",
        "type": "ArmResourceReference"
      },
      "properties": {
        "paths": [
          {
            "containerName": "container1",
            "senderPath": "directory/file.txt",
            "receiverPath": "ShareFile.txt"
          }
        ]
      }
    },
    "createdAt": "2021-07-21T23:45:35.3708674Z",
    "displayName": "sentShare1",
    "description": "description",
    "dependsOn": [],
    "state": "Succeeded",
    "senderName": "John Smith",
    "senderEmail": "johnsmith@contoso.com",
    "senderTenantName": "Contoso"
  },
  "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E",
  "type": "SentShare",
  "shareKind": "InPlace"
}
Kod stanu:
200 
Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
x-ms-long-running-operation: True
Operation-Location: https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview
Operation-Id: dad6baec-3a39-41df-a469-843a9ee94213
{
  "properties": {
    "artifact": {
      "storeKind": "AdlsGen2Account",
      "storeReference": {
        "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage",
        "type": "ArmResourceReference"
      },
      "properties": {
        "paths": [
          {
            "containerName": "container1",
            "senderPath": "directory/file.txt",
            "receiverPath": "ShareFile.txt"
          }
        ]
      }
    },
    "createdAt": "2021-07-21T23:45:35.3708674Z",
    "displayName": "sentShare1",
    "description": "description",
    "dependsOn": [],
    "state": "Succeeded",
    "senderName": "John Smith",
    "senderEmail": "johnsmith@contoso.com",
    "senderTenantName": "Contoso"
  },
  "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E",
  "type": "SentShare",
  "shareKind": "InPlace"
}

SentShares_CreateOrReplaceBlobAccount

Przykładowe żądanie

PUT accountName.purview.azure.com/share/sentShares/FF4A2AAE-8755-47BB-9C00-A774B5A7006E?api-version=2023-02-15-preview

{
  "properties": {
    "artifact": {
      "storeKind": "BlobAccount",
      "storeReference": {
        "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage",
        "type": "ArmResourceReference"
      },
      "properties": {
        "paths": [
          {
            "containerName": "container1",
            "senderPath": "directory/file.txt",
            "receiverPath": "SharedFile.txt"
          }
        ]
      }
    },
    "displayName": "sentShare1",
    "description": "description"
  },
  "shareKind": "InPlace"
}

Przykładowa odpowiedź

Kod stanu:
201 
Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
x-ms-long-running-operation: True
Operation-Location: https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview
Operation-Id: dad6baec-3a39-41df-a469-843a9ee94213
{
  "properties": {
    "artifact": {
      "storeKind": "BlobAccount",
      "storeReference": {
        "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage",
        "type": "ArmResourceReference"
      },
      "properties": {
        "paths": [
          {
            "containerName": "container1",
            "senderPath": "directory/file.txt",
            "receiverPath": "ShareFile.txt"
          }
        ]
      }
    },
    "createdAt": "2021-07-21T23:45:35.3708674Z",
    "displayName": "sentShare1",
    "description": "description",
    "dependsOn": [],
    "state": "Succeeded",
    "senderName": "John Smith",
    "senderEmail": "johnsmith@contoso.com",
    "senderTenantName": "Contoso"
  },
  "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E",
  "type": "SentShare",
  "shareKind": "InPlace"
}
Kod stanu:
200 
Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
x-ms-long-running-operation: True
Operation-Location: https://accountName.purview.azure.com/share/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2023-02-15-preview
Operation-Id: dad6baec-3a39-41df-a469-843a9ee94213
{
  "properties": {
    "artifact": {
      "storeKind": "BlobAccount",
      "storeReference": {
        "referenceName": "/subscriptions/de06c3a0-4610-4ca0-8cbb-bbdac204bd65/resourceGroups/sender-storage-rg/providers/Microsoft.Storage/storageAccounts/providerstorage",
        "type": "ArmResourceReference"
      },
      "properties": {
        "paths": [
          {
            "containerName": "container1",
            "senderPath": "directory/file.txt",
            "receiverPath": "ShareFile.txt"
          }
        ]
      }
    },
    "createdAt": "2021-07-21T23:45:35.3708674Z",
    "displayName": "sentShare1",
    "description": "description",
    "dependsOn": [],
    "state": "Succeeded",
    "senderName": "John Smith",
    "senderEmail": "johnsmith@contoso.com",
    "senderTenantName": "Contoso"
  },
  "id": "FF4A2AAE-8755-47BB-9C00-A774B5A7006E",
  "type": "SentShare",
  "shareKind": "InPlace"
}

Definicje

Nazwa Opis
AdlsGen2Artifact

Artefakt konta magazynu usługi Adls Gen2.
AdlsGen2ArtifactProperties

Właściwości konta magazynu usługi Adls Gen2.
BlobStorageArtifact

Artefakt konta usługi Blob Storage.
BlobStorageArtifactProperties

Właściwości konta usługi Blob Storage.
InPlaceSentShare

Rodzaj udziału w miejscu.
InPlaceSentShareProperties

Właściwości dla wysłanego udziału InPlace.
PurviewShareError

Model błędu udziału usługi purview.
PurviewShareErrorInfo

Model treści błędu udziału usługi purview.
ReferenceNameType

Definiuje typ współużytkowanego zasobu
ShareKind

Definiuje obsługiwane typy dla udziału.
State

Stan zasobu
StorageAccountPath

Definiuje pojedynczą ścieżkę StorageAccountPath
StoreKind

Typy elementów zawartości.
StoreReference

Odwołanie do magazynu dla artefaktu lub ujścia.

AdlsGen2Artifact

Objekt

Artefakt konta magazynu usługi Adls Gen2.

Nazwa Typ Opis
properties

AdlsGen2ArtifactProperties

Właściwości konta magazynu usługi Adls Gen2.
storeKind string:

AdlsGen2Account

Typy elementów zawartości.
storeReference

StoreReference

Odwołanie do magazynu dla artefaktu lub ujścia.

AdlsGen2ArtifactProperties

Objekt

Właściwości konta magazynu usługi Adls Gen2.

Nazwa Typ Opis
location

string

Lokalizacja konta magazynu.
paths

StorageAccountPath[]

Lista ścieżek konta magazynu usługi Adls Gen2.

BlobStorageArtifact

Objekt

Artefakt konta usługi Blob Storage.

Nazwa Typ Opis
properties

BlobStorageArtifactProperties

Właściwości konta usługi Blob Storage.
storeKind string:

BlobAccount

Typy elementów zawartości.
storeReference

StoreReference

Odwołanie do magazynu dla artefaktu lub ujścia.

BlobStorageArtifactProperties

Objekt

Właściwości konta usługi Blob Storage.

Nazwa Typ Opis
location

string

Lokalizacja konta magazynu.
paths

StorageAccountPath[]

Lista ścieżek konta magazynu obiektów blob.

InPlaceSentShare

Objekt

Rodzaj udziału w miejscu.

Nazwa Typ Opis
id

string

Unikatowy identyfikator zasobu.
properties

InPlaceSentShareProperties

Właściwości dla wysłanego udziału InPlace.
shareKind string:

InPlace

Definiuje obsługiwane typy dla udziału.
type

string

Typ zasobu.

InPlaceSentShareProperties

Objekt

Właściwości dla wysłanego udziału InPlace.

Nazwa Typ Opis
artifact Artifact:

Klasa dla wysłanego artefaktu udziału.
createdAt

string (date-time)

Godzina utworzenia wysłanego udziału. Reprezentowane w standardowym formacie daty i godziny zdefiniowanej przez RFC 3339
dependsOn

string[] (uuid)

Lista udziałów, od których zależy wysłany udział.
description

string

Opis wysłanego udziału.
displayName

string

Nazwa wysłanego udziału
senderEmail

string

Adres e-mail nadawcy, który utworzył wysłany udział.
senderName

string

Nazwa nadawcy, który utworzył wysłany udział.
senderTenantName

string

Nazwa dzierżawy nadawcy, który utworzył wysłany udział.
state

State

Stan zasobu

PurviewShareError

Objekt

Model błędu udziału usługi purview.

Nazwa Typ Opis
error

PurviewShareErrorInfo

Model treści błędu udziału usługi purview.

PurviewShareErrorInfo

Objekt

Model treści błędu udziału usługi purview.

Nazwa Typ Opis
code

string

Kod błędu
details

PurviewShareErrorInfo[]

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

string

Komunikat o błędzie
target

string

Element docelowy błędu

ReferenceNameType

Wyliczanie

Definiuje typ współużytkowanego zasobu

Wartość Opis
ArmResourceReference

Typ odwołania to zasób usługi ARM

ShareKind

Wyliczanie

Definiuje obsługiwane typy dla udziału.

Wartość Opis
InPlace

Typ udziału to udostępnianie w miejscu

State

Wyliczanie

Stan zasobu

Wartość Opis
Unknown

Stan zasobu to "Nieznany"
Succeeded

Stan zasobu to "Powodzenie"
Creating

Stan zasobu to "Tworzenie"
Deleting

Stan zasobu to "Usuwanie"
Moving

Stan zasobu to "Przenoszenie"
Failed

Stan zasobu to "Niepowodzenie"

StorageAccountPath

Objekt

Definiuje pojedynczą ścieżkę StorageAccountPath

Nazwa Typ Opis
containerName

string

Pobiera lub ustawia nazwę kontenera
receiverPath

string

Pobiera lub ustawia ścieżkę po stronie odbiorcy, gdzie artefakt ma zostać zamapowany
senderPath

string

Pobiera lub ustawia ścieżkę do pliku/folderu w kontenerze do udostępnienia

StoreKind

Wyliczanie

Typy elementów zawartości.

Wartość Opis
AdlsGen2Account

Rodzaj magazynu to konto magazynu usługi Adls Gen 2
BlobAccount

Rodzaj magazynu to konto usługi Blob Storage

StoreReference

Objekt

Odwołanie do magazynu dla artefaktu lub ujścia.

Nazwa Typ Opis
referenceName

string

Nazwa odwołania dla zasobu skojarzonego z ujściem lub artefaktem.
type

ReferenceNameType

Definiuje typ współużytkowanego zasobu