Compartilhar via

Sent Shares - Create Or Replace

  • Referência
Serviço:
Purview
Versão da API:
2023-02-15-preview

Criar ou substituir um compartilhamento enviado

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string

O ponto de extremidade de compartilhamento da sua conta do Purview. Exemplo: 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 do compartilhamento enviado
api-version
 query True

string

A versão da API a ser usada

Corpo da solicitação

InPlaceSentShare

Um tipo de compartilhamento InPlace.

Nome Obrigatório Tipo Description
properties True

InPlaceSentShareProperties

Propriedades do compartilhamento enviado do InPlace.
shareKind True string:

InPlace

Define os tipos com suporte para compartilhamento.

Respostas

Nome Tipo Description
200 OK SentShare:

InPlaceSentShare

Êxito

Cabeçalhos

Operation-Location: string
201 Created SentShare:

InPlaceSentShare

Êxito

Cabeçalhos

Operation-Location: string
Other Status Codes

PurviewShareError

Resposta de erro padrão.

Cabeçalhos

x-ms-error-code: string

Segurança

azureAuth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
https://purview.azure.net/.default Escopo do serviço purview

Exemplos

SentShares_CreateOrReplace
SentShares_CreateOrReplaceAdlsGen2Account
SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
}
Código de status:
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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
}
Código de status:
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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
}
Código de status:
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"
}

Definições

Nome Description
AdlsGen2Artifact

Um artefato de conta de armazenamento do Adls Gen2.
AdlsGen2ArtifactProperties

Propriedades da conta de armazenamento do Adls Gen2.
BlobStorageArtifact

Artefato da conta de armazenamento de blobs.
BlobStorageArtifactProperties

Propriedades da conta de armazenamento de blobs.
InPlaceSentShare

Um tipo de compartilhamento InPlace.
InPlaceSentShareProperties

Propriedades do compartilhamento enviado do InPlace.
PurviewShareError

O modelo de erro de compartilhamento do Purview.
PurviewShareErrorInfo

O modelo do corpo do erro do compartilhamento purview.
ReferenceNameType

Define o tipo de recurso que está sendo compartilhado
ShareKind

Define os tipos com suporte para compartilhamento.
State

Estado do recurso
StorageAccountPath

Define um único caminho StorageAccountPath
StoreKind

Os tipos de ativo.
StoreReference

Uma referência de repositório para um artefato ou coletor.

AdlsGen2Artifact

Objeto

Um artefato de conta de armazenamento do Adls Gen2.

Nome Tipo Description
properties

AdlsGen2ArtifactProperties

Propriedades da conta de armazenamento do Adls Gen2.
storeKind string:

AdlsGen2Account

Os tipos de ativo.
storeReference

StoreReference

Uma referência de repositório para um artefato ou coletor.

AdlsGen2ArtifactProperties

Objeto

Propriedades da conta de armazenamento do Adls Gen2.

Nome Tipo Description
location

string

Local da conta de armazenamento.
paths

StorageAccountPath[]

Uma lista de caminhos de conta de armazenamento do Adls Gen2.

BlobStorageArtifact

Objeto

Artefato da conta de armazenamento de blobs.

Nome Tipo Description
properties

BlobStorageArtifactProperties

Propriedades da conta de armazenamento de blobs.
storeKind string:

BlobAccount

Os tipos de ativo.
storeReference

StoreReference

Uma referência de repositório para um artefato ou coletor.

BlobStorageArtifactProperties

Objeto

Propriedades da conta de armazenamento de blobs.

Nome Tipo Description
location

string

Local da conta de armazenamento.
paths

StorageAccountPath[]

Uma lista de caminhos da conta de armazenamento de blobs.

InPlaceSentShare

Objeto

Um tipo de compartilhamento InPlace.

Nome Tipo Description
id

string

A ID exclusiva do recurso.
properties

InPlaceSentShareProperties

Propriedades do compartilhamento enviado do InPlace.
shareKind string:

InPlace

Define os tipos com suporte para compartilhamento.
type

string

Tipo do recurso.

InPlaceSentShareProperties

Objeto

Propriedades do compartilhamento enviado do InPlace.

Nome Tipo Description
artifact Artifact:

Uma classe para o artefato de compartilhamento enviado.
createdAt

string (date-time)

Hora em que o compartilhamento enviado foi criado. Representado no formato de data e hora padrão, conforme definido pelo RFC 3339
dependsOn

string[] (uuid)

Lista de compartilhamentos dos quais o compartilhamento enviado depende.
description

string

Descrição do compartilhamento enviado.
displayName

string

O nome do compartilhamento enviado
senderEmail

string

Email do remetente que criou o compartilhamento enviado.
senderName

string

Nome do remetente que criou o compartilhamento enviado.
senderTenantName

string

Nome do locatário do remetente que criou o compartilhamento enviado.
state

State

Estado do recurso

PurviewShareError

Objeto

O modelo de erro de compartilhamento do Purview.

Nome Tipo Description
error

PurviewShareErrorInfo

O modelo do corpo do erro do compartilhamento purview.

PurviewShareErrorInfo

Objeto

O modelo do corpo do erro do compartilhamento purview.

Nome Tipo Description
code

string

Código do erro
details

PurviewShareErrorInfo[]

Detalhes aninhados do modelo de erro
message

string

Mensagem do erro
target

string

Destino do erro

ReferenceNameType

Enumeração

Define o tipo de recurso que está sendo compartilhado

Valor Description
ArmResourceReference

O tipo de referência é um recurso do ARM

ShareKind

Enumeração

Define os tipos com suporte para compartilhamento.

Valor Description
InPlace

O tipo de compartilhamento é o compartilhamento in-loco

State

Enumeração

Estado do recurso

Valor Description
Creating

O estado do recurso é "Criando"
Deleting

O estado do recurso é 'Excluir'
Failed

O estado do recurso é 'Falha'
Moving

O estado do recurso é "Movendo"
Succeeded

O estado do recurso é 'Bem-sucedido'
Unknown

O estado do recurso é 'Desconhecido'

StorageAccountPath

Objeto

Define um único caminho StorageAccountPath

Nome Tipo Description
containerName

string

Obtém ou define o nome do contêiner
receiverPath

string

Obtém ou define o caminho no lado do receptor onde o artefato deve ser mapeado
senderPath

string

Obtém ou define o caminho para arquivo/pasta dentro do contêiner a ser compartilhado

StoreKind

Enumeração

Os tipos de ativo.

Valor Description
AdlsGen2Account

O tipo de repositório é uma conta de armazenamento do Adls Gen 2
BlobAccount

O tipo de repositório é uma conta de armazenamento de Blobs

StoreReference

Objeto

Uma referência de repositório para um artefato ou coletor.

Nome Tipo Description
referenceName

string

Nome de referência para o recurso associado ao coletor ou artefato.
type

ReferenceNameType

Define o tipo de recurso que está sendo compartilhado