Condividi tramite

Sent Shares - Create Or Replace

Servizio:
Purview
Versione API:
2023-02-15-preview

Creare o sostituire una condivisione inviata

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

Endpoint di condivisione dell'account purview. Esempio: 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 della condivisione inviata
api-version
 query True

string

Versione dell'API da usare

Corpo della richiesta

InPlaceSentShare

Tipo di condivisione InPlace.

Nome Necessario Tipo Descrizione
properties True

InPlaceSentShareProperties

Proprietà per la condivisione inviata in InPlace.
shareKind True string:

InPlace

Definisce i tipi supportati per la condivisione.

Risposte

Nome Tipo Descrizione
200 OK SentShare:

InPlaceSentShare

Successo

Intestazioni

Operation-Location: string
201 Created SentShare:

InPlaceSentShare

Successo

Intestazioni

Operation-Location: string
Other Status Codes

PurviewShareError

Risposta di errore predefinita.

Intestazioni

x-ms-error-code: string

Sicurezza

azureAuth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
https://purview.azure.net/.default Ambito del servizio Purview

Esempio

SentShares_CreateOrReplace
SentShares_CreateOrReplaceAdlsGen2Account
SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}
Codice di stato:
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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}
Codice di stato:
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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}
Codice di stato:
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"
}

Definizioni

Nome Descrizione
AdlsGen2Artifact

Artefatto dell'account di archiviazione di Adls Gen2.
AdlsGen2ArtifactProperties

Proprietà per l'account di archiviazione di Adls Gen2.
BlobStorageArtifact

Artefatto dell'account di archiviazione BLOB.
BlobStorageArtifactProperties

Proprietà per l'account di archiviazione BLOB.
InPlaceSentShare

Tipo di condivisione InPlace.
InPlaceSentShareProperties

Proprietà per la condivisione inviata in InPlace.
PurviewShareError

Modello di errore di condivisione purview.
PurviewShareErrorInfo

Modello di corpo dell'errore di condivisione purview.
ReferenceNameType

Definisce il tipo di risorsa condivisa
ShareKind

Definisce i tipi supportati per la condivisione.
State

Stato della risorsa
StorageAccountPath

Definisce un singolo percorso StorageAccountPath
StoreKind

Tipi di asset.
StoreReference

Riferimento all'archivio per un artefatto o un sink.

AdlsGen2Artifact

Object

Artefatto dell'account di archiviazione di Adls Gen2.

Nome Tipo Descrizione
properties

AdlsGen2ArtifactProperties

Proprietà per l'account di archiviazione di Adls Gen2.
storeKind string:

AdlsGen2Account

Tipi di asset.
storeReference

StoreReference

Riferimento all'archivio per un artefatto o un sink.

AdlsGen2ArtifactProperties

Object

Proprietà per l'account di archiviazione di Adls Gen2.

Nome Tipo Descrizione
location

string

Posizione dell'account di archiviazione.
paths

StorageAccountPath[]

Elenco dei percorsi degli account di archiviazione di Adls Gen2.

BlobStorageArtifact

Object

Artefatto dell'account di archiviazione BLOB.

Nome Tipo Descrizione
properties

BlobStorageArtifactProperties

Proprietà per l'account di archiviazione BLOB.
storeKind string:

BlobAccount

Tipi di asset.
storeReference

StoreReference

Riferimento all'archivio per un artefatto o un sink.

BlobStorageArtifactProperties

Object

Proprietà per l'account di archiviazione BLOB.

Nome Tipo Descrizione
location

string

Posizione dell'account di archiviazione.
paths

StorageAccountPath[]

Elenco dei percorsi dell'account di archiviazione BLOB.

InPlaceSentShare

Object

Tipo di condivisione InPlace.

Nome Tipo Descrizione
id

string

ID univoco della risorsa.
properties

InPlaceSentShareProperties

Proprietà per la condivisione inviata in InPlace.
shareKind string:

InPlace

Definisce i tipi supportati per la condivisione.
type

string

Tipo della risorsa.

InPlaceSentShareProperties

Object

Proprietà per la condivisione inviata in InPlace.

Nome Tipo Descrizione
artifact Artifact:

Classe per l'artefatto di condivisione inviato.
createdAt

string (date-time)

Ora di creazione della condivisione inviata. Rappresentato nel formato di data e ora standard definito da RFC 3339
dependsOn

string[] (uuid)

Elenco di condivisioni da cui dipende la condivisione inviata.
description

string

Descrizione della condivisione inviata.
displayName

string

Nome della condivisione inviata
senderEmail

string

Indirizzo di posta elettronica del mittente che ha creato la condivisione inviata.
senderName

string

Nome del mittente che ha creato la condivisione inviata.
senderTenantName

string

Nome del tenant del mittente che ha creato la condivisione inviata.
state

State

Stato della risorsa

PurviewShareError

Object

Modello di errore di condivisione purview.

Nome Tipo Descrizione
error

PurviewShareErrorInfo

Modello di corpo dell'errore di condivisione purview.

PurviewShareErrorInfo

Object

Modello di corpo dell'errore di condivisione purview.

Nome Tipo Descrizione
code

string

Codice dell'errore
details

PurviewShareErrorInfo[]

Dettagli annidati del modello di errore
message

string

Messaggio dell'errore
target

string

Destinazione dell'errore

ReferenceNameType

Enumerazione

Definisce il tipo di risorsa condivisa

Valore Descrizione
ArmResourceReference

Il tipo di riferimento è una risorsa arm

ShareKind

Enumerazione

Definisce i tipi supportati per la condivisione.

Valore Descrizione
InPlace

Il tipo di condivisione è la condivisione sul posto

State

Enumerazione

Stato della risorsa

Valore Descrizione
Unknown

Lo stato della risorsa è "Sconosciuto"
Succeeded

Lo stato della risorsa è "Succeeded"
Creating

Lo stato della risorsa è "Creazione"
Deleting

Lo stato della risorsa è "Eliminazione"
Moving

Lo stato della risorsa è "Spostamento"
Failed

Lo stato della risorsa è 'Failed'

StorageAccountPath

Object

Definisce un singolo percorso StorageAccountPath

Nome Tipo Descrizione
containerName

string

Ottiene o imposta il nome del contenitore
receiverPath

string

Ottiene o imposta il percorso sul lato ricevitore in cui eseguire il mapping dell'artefatto
senderPath

string

Ottiene o imposta il percorso del file/cartella all'interno del contenitore da condividere

StoreKind

Enumerazione

Tipi di asset.

Valore Descrizione
AdlsGen2Account

Il tipo di archivio è un account di archiviazione di Adls Gen 2
BlobAccount

Il tipo di archivio è un account di archiviazione BLOB

StoreReference

Object

Riferimento all'archivio per un artefatto o un sink.

Nome Tipo Descrizione
referenceName

string

Nome di riferimento per la risorsa associata al sink o all'artefatto.
type

ReferenceNameType

Definisce il tipo di risorsa condivisa