Sdílet prostřednictvím

Sent Shares - Create Or Replace

Služba:
Purview
Verze rozhraní API:
2023-02-15-preview

Vytvoření nebo nahrazení odeslané sdílené složky

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
 path True

string

Koncový bod sdílení vašeho účtu Purview. Příklad: 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 odeslané sdílené složky
api-version
 query True

string

Verze rozhraní API, která se má použít

Text požadavku

InPlaceSentShare

Druh sdílené složky InPlace.

Name Vyžadováno Typ Description
properties True

InPlaceSentShareProperties

Vlastnosti odeslané sdílené složky InPlace
shareKind True string:

InPlace

Definuje podporované typy pro sdílenou složku.

Odpovědi

Name Typ Description
200 OK SentShare:

InPlaceSentShare

Úspěch

Hlavičky

Operation-Location: string
201 Created SentShare:

InPlaceSentShare

Úspěch

Hlavičky

Operation-Location: string
Other Status Codes

PurviewShareError

Výchozí chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

azureAuth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
https://purview.azure.net/.default Rozsah služby Purview

Příklady

SentShares_CreateOrReplace
SentShares_CreateOrReplaceAdlsGen2Account
SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
}
Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
}
Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
}
Stavový kód:
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"
}

Definice

Name Description
AdlsGen2Artifact

Artefakt účtu úložiště Adls Gen2
AdlsGen2ArtifactProperties

Vlastnosti účtu úložiště Adls Gen2
BlobStorageArtifact

Artefakt účtu úložiště objektů blob
BlobStorageArtifactProperties

Vlastnosti účtu úložiště objektů blob
InPlaceSentShare

Druh sdílené složky InPlace.
InPlaceSentShareProperties

Vlastnosti odeslané sdílené složky InPlace
PurviewShareError

Model chyb sdílené složky Purview.
PurviewShareErrorInfo

Model těla chyby sdílení purview.
ReferenceNameType

Definuje typ sdíleného prostředku.
ShareKind

Definuje podporované typy pro sdílenou složku.
State

Stav prostředku
StorageAccountPath

Definuje jednu cestu StorageAccountPath.
StoreKind

Typy aktiv.
StoreReference

Referenční informace k úložišti artefaktu nebo jímky

AdlsGen2Artifact

Objekt

Artefakt účtu úložiště Adls Gen2

Name Typ Description
properties

AdlsGen2ArtifactProperties

Vlastnosti účtu úložiště Adls Gen2
storeKind string:

AdlsGen2Account

Typy aktiv.
storeReference

StoreReference

Referenční informace k úložišti artefaktu nebo jímky

AdlsGen2ArtifactProperties

Objekt

Vlastnosti účtu úložiště Adls Gen2

Name Typ Description
location

string

Umístění účtu úložiště.
paths

StorageAccountPath[]

Seznam cest k účtu úložiště Adls Gen2

BlobStorageArtifact

Objekt

Artefakt účtu úložiště objektů blob

Name Typ Description
properties

BlobStorageArtifactProperties

Vlastnosti účtu úložiště objektů blob
storeKind string:

BlobAccount

Typy aktiv.
storeReference

StoreReference

Referenční informace k úložišti artefaktu nebo jímky

BlobStorageArtifactProperties

Objekt

Vlastnosti účtu úložiště objektů blob

Name Typ Description
location

string

Umístění účtu úložiště.
paths

StorageAccountPath[]

Seznam cest k účtu úložiště objektů blob

InPlaceSentShare

Objekt

Druh sdílené složky InPlace.

Name Typ Description
id

string

Jedinečné ID prostředku.
properties

InPlaceSentShareProperties

Vlastnosti odeslané sdílené složky InPlace
shareKind string:

InPlace

Definuje podporované typy pro sdílenou složku.
type

string

Typ prostředku

InPlaceSentShareProperties

Objekt

Vlastnosti odeslané sdílené složky InPlace

Name Typ Description
artifact Artifact:

Třída pro odeslaný artefakt sdílené složky.
createdAt

string (date-time)

Čas vytvoření odeslané sdílené složky Znázorněno ve standardním formátu data a času definovaném RFC 3339
dependsOn

string[] (uuid)

Seznam sdílených složek, na kterých závisí odeslaná sdílená složka
description

string

Popis odeslané sdílené složky
displayName

string

Název odeslané sdílené složky
senderEmail

string

E-mail odesílatele, který vytvořil odeslanou sdílenou složku.
senderName

string

Jméno odesílatele, který vytvořil odeslanou sdílenou složku.
senderTenantName

string

Název tenanta odesílatele, který vytvořil odeslanou sdílenou složku.
state

State

Stav prostředku

PurviewShareError

Objekt

Model chyb sdílené složky Purview.

Name Typ Description
error

PurviewShareErrorInfo

Model těla chyby sdílení purview.

PurviewShareErrorInfo

Objekt

Model těla chyby sdílení purview.

Name Typ Description
code

string

Kód chyby
details

PurviewShareErrorInfo[]

Vnořené podrobnosti o modelu chyb
message

string

Zpráva o chybě
target

string

Cíl chyby

ReferenceNameType

Výčet

Definuje typ sdíleného prostředku.

Hodnota Description
ArmResourceReference

Typ odkazu je prostředek ARM.

ShareKind

Výčet

Definuje podporované typy pro sdílenou složku.

Hodnota Description
InPlace

Typ sdílené složky je místní sdílení.

State

Výčet

Stav prostředku

Hodnota Description
Unknown

Stav prostředku je Neznámý.
Succeeded

Stav prostředku je Úspěch.
Creating

Stav prostředku je Vytvoření.
Deleting

Stav prostředku je Odstranění.
Moving

Stav prostředku je Přesun.
Failed

Stav prostředku je neúspěšný.

StorageAccountPath

Objekt

Definuje jednu cestu StorageAccountPath.

Name Typ Description
containerName

string

Získá nebo nastaví název kontejneru.
receiverPath

string

Získá nebo nastaví cestu na straně příjemce, kde je artefakt mapován.
senderPath

string

Získá nebo nastaví cestu k souboru nebo složce v kontejneru, který se má sdílet.

StoreKind

Výčet

Typy aktiv.

Hodnota Description
AdlsGen2Account

Druh úložiště je účet úložiště Adls Gen2.
BlobAccount

Druh úložiště je účet úložiště objektů blob.

StoreReference

Objekt

Referenční informace k úložišti artefaktu nebo jímky

Name Typ Description
referenceName

string

Referenční název prostředku přidruženého k jímce nebo artefaktu
type

ReferenceNameType

Definuje typ sdíleného prostředku.