Partilhar via

Sent Shares - Create Or Replace

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 do URI

Name Em Necessário Tipo Description
endpoint
 path True

string

O ponto de extremidade de compartilhamento da sua conta 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 da partilha enviada
api-version
 query True

string

A versão da api a ser usada

Corpo do Pedido

InPlaceSentShare

Um tipo de compartilhamento InPlace.

Name Necessário Tipo Description
properties True

InPlaceSentShareProperties

Propriedades do compartilhamento enviado pelo InPlace.
shareKind True string:

InPlace

Define os tipos suportados para compartilhamento.

Respostas

Name Tipo Description
200 OK SentShare:

InPlaceSentShare

Sucesso

Cabeçalhos

Operation-Location: string
201 Created SentShare:

InPlaceSentShare

Sucesso

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 Ative Directory.

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

Âmbitos

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

Exemplos

SentShares_CreateOrReplace
SentShares_CreateOrReplaceAdlsGen2Account
SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Pedido de amostra

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 da amostra

Código de estado:
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 estado:
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

Pedido de amostra

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 da amostra

Código de estado:
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 estado:
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

Pedido de amostra

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 da amostra

Código de estado:
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 estado:
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

Name Description
AdlsGen2Artifact

Um artefato de conta de armazenamento Adls Gen2.
AdlsGen2ArtifactProperties

Propriedades da conta de armazenamento Adls Gen2.
BlobStorageArtifact

Artefato de conta de armazenamento de Blob.
BlobStorageArtifactProperties

Propriedades da conta de armazenamento de blob.
InPlaceSentShare

Um tipo de compartilhamento InPlace.
InPlaceSentShareProperties

Propriedades do compartilhamento enviado pelo InPlace.
PurviewShareError

O modelo de erro de compartilhamento de purview.
PurviewShareErrorInfo

O modelo de corpo de erro de compartilhamento de purview.
ReferenceNameType

Define o tipo de recurso que está sendo compartilhado
ShareKind

Define os tipos suportados para compartilhamento.
State

Estado do recurso
StorageAccountPath

Define um único caminho StorageAccountPath
StoreKind

Os tipos de ativos.
StoreReference

Uma referência de loja para um artefato ou pia.

AdlsGen2Artifact

Object

Um artefato de conta de armazenamento Adls Gen2.

Name Tipo Description
properties

AdlsGen2ArtifactProperties

Propriedades da conta de armazenamento Adls Gen2.
storeKind string:

AdlsGen2Account

Os tipos de ativos.
storeReference

StoreReference

Uma referência de loja para um artefato ou pia.

AdlsGen2ArtifactProperties

Object

Propriedades da conta de armazenamento Adls Gen2.

Name Tipo Description
location

string

Localização da conta de armazenamento.
paths

StorageAccountPath[]

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

BlobStorageArtifact

Object

Artefato de conta de armazenamento de Blob.

Name Tipo Description
properties

BlobStorageArtifactProperties

Propriedades da conta de armazenamento de blob.
storeKind string:

BlobAccount

Os tipos de ativos.
storeReference

StoreReference

Uma referência de loja para um artefato ou pia.

BlobStorageArtifactProperties

Object

Propriedades da conta de armazenamento de blob.

Name Tipo Description
location

string

Localização da conta de armazenamento.
paths

StorageAccountPath[]

Uma lista de caminhos de conta de armazenamento de blob.

InPlaceSentShare

Object

Um tipo de compartilhamento InPlace.

Name Tipo Description
id

string

A id exclusiva do recurso.
properties

InPlaceSentShareProperties

Propriedades do compartilhamento enviado pelo InPlace.
shareKind string:

InPlace

Define os tipos suportados para compartilhamento.
type

string

Tipo de recurso.

InPlaceSentShareProperties

Object

Propriedades do compartilhamento enviado pelo InPlace.

Name Tipo Description
artifact Artifact:

Uma classe para artefato de compartilhamento enviado.
createdAt

string (date-time)

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

string[] (uuid)

Lista de ações das quais depende a parte enviada.
description

string

Descrição do compartilhamento enviado.
displayName

string

O nome do compartilhamento enviado
senderEmail

string

E-mail 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

Object

O modelo de erro de compartilhamento de purview.

Name Tipo Description
error

PurviewShareErrorInfo

O modelo de corpo de erro de compartilhamento de purview.

PurviewShareErrorInfo

Object

O modelo de corpo de erro de compartilhamento de purview.

Name Tipo Description
code

string

Código do erro
details

PurviewShareErrorInfo[]

Detalhes aninhados do modelo de erro
message

string

Mensagem do erro
target

string

Alvo do erro

ReferenceNameType

Enumeração

Define o tipo de recurso que está sendo compartilhado

Valor Description
ArmResourceReference

O tipo de referência é um recurso ARM

ShareKind

Enumeração

Define os tipos suportados para compartilhamento.

Valor Description
InPlace

O tipo de compartilhamento é o compartilhamento in-loco

State

Enumeração

Estado do recurso

Valor Description
Unknown

O estado do recurso é 'Desconhecido'
Succeeded

O estado do recurso é 'Bem-sucedido'
Creating

O estado do recurso é "Criar"
Deleting

O estado do recurso é 'Excluindo'
Moving

O estado do recurso é 'Moving'
Failed

O estado do recurso é 'Falha'

StorageAccountPath

Object

Define um único caminho StorageAccountPath

Name Tipo Description
containerName

string

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

string

Obtém ou define o caminho no lado do recetor 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 ativos.

Valor Description
AdlsGen2Account

O tipo de loja é uma conta de armazenamento Adls Gen 2
BlobAccount

O tipo de loja é uma conta de armazenamento de Blob

StoreReference

Object

Uma referência de loja para um artefato ou pia.

Name 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