Compartir a través de

Sent Shares - Create Or Replace

Servicio:
Purview
Versión de la API:
2023-02-15-preview

Crear o reemplazar un recurso compartido enviado

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string

Punto de conexión de uso compartido de la cuenta de purview. Ejemplo: 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})$

Identificador del recurso compartido enviado
api-version
 query True

string

La versión de api que se va a usar

Cuerpo de la solicitud

InPlaceSentShare

Tipo de recurso compartido InPlace.

Nombre Requerido Tipo Description
properties True

InPlaceSentShareProperties

Propiedades del recurso compartido enviado de InPlace.
shareKind True string:

InPlace

Define los tipos admitidos para el recurso compartido.

Respuestas

Nombre Tipo Description
200 OK SentShare:

InPlaceSentShare

Éxito

Encabezados

Operation-Location: string
201 Created SentShare:

InPlaceSentShare

Éxito

Encabezados

Operation-Location: string
Other Status Codes

PurviewShareError

Respuesta de error predeterminada.

Encabezados

x-ms-error-code: string

Seguridad

azureAuth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
https://purview.azure.net/.default Ámbito del servicio Purview

Ejemplos

SentShares_CreateOrReplace
SentShares_CreateOrReplaceAdlsGen2Account
SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
}
status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
}
status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
}
status code:
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"
}

Definiciones

Nombre Description
AdlsGen2Artifact

Un artefacto de cuenta de almacenamiento de Adls Gen2.
AdlsGen2ArtifactProperties

Propiedades de la cuenta de almacenamiento de Adls Gen2.
BlobStorageArtifact

Artefacto de la cuenta de Blob Storage.
BlobStorageArtifactProperties

Propiedades de la cuenta de Blob Storage.
InPlaceSentShare

Tipo de recurso compartido InPlace.
InPlaceSentShareProperties

Propiedades del recurso compartido enviado de InPlace.
PurviewShareError

Modelo de error de recurso compartido de purview.
PurviewShareErrorInfo

El modelo de cuerpo del error compartido de purview.
ReferenceNameType

Define el tipo de recurso que se comparte.
ShareKind

Define los tipos admitidos para el recurso compartido.
State

Estado del recurso
StorageAccountPath

Define una única ruta de acceso StorageAccountPath.
StoreKind

Los tipos de recurso.
StoreReference

Referencia de la Tienda para un artefacto o receptor.

AdlsGen2Artifact

Object

Un artefacto de cuenta de almacenamiento de Adls Gen2.

Nombre Tipo Description
properties

AdlsGen2ArtifactProperties

Propiedades de la cuenta de almacenamiento de Adls Gen2.
storeKind string:

AdlsGen2Account

Los tipos de recurso.
storeReference

StoreReference

Referencia de la Tienda para un artefacto o receptor.

AdlsGen2ArtifactProperties

Object

Propiedades de la cuenta de almacenamiento de Adls Gen2.

Nombre Tipo Description
location

string

Ubicación de la cuenta de almacenamiento.
paths

StorageAccountPath[]

Lista de rutas de acceso de la cuenta de almacenamiento de Adls Gen2.

BlobStorageArtifact

Object

Artefacto de la cuenta de Blob Storage.

Nombre Tipo Description
properties

BlobStorageArtifactProperties

Propiedades de la cuenta de Blob Storage.
storeKind string:

BlobAccount

Los tipos de recurso.
storeReference

StoreReference

Referencia de la Tienda para un artefacto o receptor.

BlobStorageArtifactProperties

Object

Propiedades de la cuenta de Blob Storage.

Nombre Tipo Description
location

string

Ubicación de la cuenta de almacenamiento.
paths

StorageAccountPath[]

Lista de rutas de acceso de la cuenta de Blob Storage.

InPlaceSentShare

Object

Tipo de recurso compartido InPlace.

Nombre Tipo Description
id

string

Identificador único del recurso.
properties

InPlaceSentShareProperties

Propiedades del recurso compartido enviado de InPlace.
shareKind string:

InPlace

Define los tipos admitidos para el recurso compartido.
type

string

Tipo del recurso.

InPlaceSentShareProperties

Object

Propiedades del recurso compartido enviado de InPlace.

Nombre Tipo Description
artifact Artifact:

Clase para el artefacto de recurso compartido enviado.
createdAt

string (date-time)

Hora en la que se creó el recurso compartido enviado. Representado en el formato de fecha y hora estándar tal y como se define en RFC 3339
dependsOn

string[] (uuid)

Lista de recursos compartidos en los que depende el recurso compartido enviado.
description

string

Descripción del recurso compartido enviado.
displayName

string

Nombre del recurso compartido enviado
senderEmail

string

Correo electrónico del remitente que creó el recurso compartido enviado.
senderName

string

Nombre del remitente que creó el recurso compartido enviado.
senderTenantName

string

Nombre de inquilino del remitente que creó el recurso compartido enviado.
state

State

Estado del recurso

PurviewShareError

Object

Modelo de error de recurso compartido de purview.

Nombre Tipo Description
error

PurviewShareErrorInfo

El modelo de cuerpo del error compartido de purview.

PurviewShareErrorInfo

Object

El modelo de cuerpo del error compartido de purview.

Nombre Tipo Description
code

string

Código del error
details

PurviewShareErrorInfo[]

Detalles anidados del modelo de error
message

string

Mensaje del error
target

string

Destino del error

ReferenceNameType

Enumeración

Define el tipo de recurso que se comparte.

Valor Description
ArmResourceReference

El tipo de referencia es un recurso arm.

ShareKind

Enumeración

Define los tipos admitidos para el recurso compartido.

Valor Description
InPlace

El tipo de recurso compartido es el uso compartido local.

State

Enumeración

Estado del recurso

Valor Description
Unknown

El estado del recurso es "Desconocido".
Succeeded

El estado del recurso es "Succeeded"
Creating

El estado del recurso es "Creating"
Deleting

El estado del recurso es "Eliminar"
Moving

El estado del recurso es "Mover"
Failed

El estado del recurso es "Failed"

StorageAccountPath

Object

Define una única ruta de acceso StorageAccountPath.

Nombre Tipo Description
containerName

string

Obtiene o establece el nombre del contenedor.
receiverPath

string

Obtiene o establece la ruta de acceso en el lado receptor donde se va a asignar el artefacto.
senderPath

string

Obtiene o establece la ruta de acceso al archivo o carpeta dentro del contenedor que se va a compartir.

StoreKind

Enumeración

Los tipos de recurso.

Valor Description
AdlsGen2Account

El tipo de almacén es una cuenta de almacenamiento de Adls Gen 2.
BlobAccount

El tipo de almacén es una cuenta de Blob Storage.

StoreReference

Object

Referencia de la Tienda para un artefacto o receptor.

Nombre Tipo Description
referenceName

string

Nombre de referencia del recurso asociado al receptor o artefacto.
type

ReferenceNameType

Define el tipo de recurso que se comparte.