Partager via

Sent Shares - Create Or Replace

Service:
Purview
Version d'API:
2023-02-15-preview

Créer ou remplacer un partage envoyé

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

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
 path True

string

Point de terminaison de partage de votre compte Purview. Exemple : 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 du partage envoyé
api-version
 query True

string

Version de l’API à utiliser

Corps de la demande

InPlaceSentShare

Un type de partage InPlace.

Nom Obligatoire Type Description
properties True

InPlaceSentShareProperties

Propriétés du partage envoyé InPlace.
shareKind True string:

InPlace

Définit les types pris en charge pour le partage.

Réponses

Nom Type Description
200 OK SentShare:

InPlaceSentShare

Succès

En-têtes

Operation-Location: string
201 Created SentShare:

InPlaceSentShare

Succès

En-têtes

Operation-Location: string
Other Status Codes

PurviewShareError

Réponse d’erreur par défaut.

En-têtes

x-ms-error-code: string

Sécurité

azureAuth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
https://purview.azure.net/.default Étendue du service Purview

Exemples

SentShares_CreateOrReplace
SentShares_CreateOrReplaceAdlsGen2Account
SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
}
Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
}
Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
}
Code d’état:
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"
}

Définitions

Nom Description
AdlsGen2Artifact

Artefact de compte de stockage Adls Gen2.
AdlsGen2ArtifactProperties

Propriétés du compte de stockage Adls Gen2.
BlobStorageArtifact

Artefact du compte de stockage d’objets blob.
BlobStorageArtifactProperties

Propriétés du compte de stockage d’objets blob.
InPlaceSentShare

Un type de partage InPlace.
InPlaceSentShareProperties

Propriétés du partage envoyé InPlace.
PurviewShareError

Modèle d’erreur de partage purview.
PurviewShareErrorInfo

Modèle de corps d’erreur de partage purview.
ReferenceNameType

Définit le type de ressource partagé
ShareKind

Définit les types pris en charge pour le partage.
State

État de la ressource
StorageAccountPath

Définit un chemin d’accès StorageAccountPath unique
StoreKind

Types de ressources.
StoreReference

Référence de magasin pour un artefact ou un récepteur.

AdlsGen2Artifact

Object

Artefact de compte de stockage Adls Gen2.

Nom Type Description
properties

AdlsGen2ArtifactProperties

Propriétés du compte de stockage Adls Gen2.
storeKind string:

AdlsGen2Account

Types de ressources.
storeReference

StoreReference

Référence de magasin pour un artefact ou un récepteur.

AdlsGen2ArtifactProperties

Object

Propriétés du compte de stockage Adls Gen2.

Nom Type Description
location

string

Emplacement du compte de stockage.
paths

StorageAccountPath[]

Liste des chemins d’accès au compte de stockage Adls Gen2.

BlobStorageArtifact

Object

Artefact du compte de stockage d’objets blob.

Nom Type Description
properties

BlobStorageArtifactProperties

Propriétés du compte de stockage d’objets blob.
storeKind string:

BlobAccount

Types de ressources.
storeReference

StoreReference

Référence de magasin pour un artefact ou un récepteur.

BlobStorageArtifactProperties

Object

Propriétés du compte de stockage d’objets blob.

Nom Type Description
location

string

Emplacement du compte de stockage.
paths

StorageAccountPath[]

Liste des chemins d’accès du compte de stockage d’objets blob.

InPlaceSentShare

Object

Un type de partage InPlace.

Nom Type Description
id

string

ID unique de la ressource.
properties

InPlaceSentShareProperties

Propriétés du partage envoyé InPlace.
shareKind string:

InPlace

Définit les types pris en charge pour le partage.
type

string

Type de la ressource.

InPlaceSentShareProperties

Object

Propriétés du partage envoyé InPlace.

Nom Type Description
artifact Artifact:

Classe pour l’artefact de partage envoyé.
createdAt

string (date-time)

Heure à laquelle le partage envoyé a été créé. Représenté au format date/heure standard tel que défini par RFC 3339
dependsOn

string[] (uuid)

Liste des partages sur lesquels dépend le partage envoyé.
description

string

Description du partage envoyé.
displayName

string

Nom du partage envoyé
senderEmail

string

E-mail de l’expéditeur qui a créé le partage envoyé.
senderName

string

Nom de l’expéditeur qui a créé le partage envoyé.
senderTenantName

string

Nom du locataire de l’expéditeur qui a créé le partage envoyé.
state

State

État de la ressource

PurviewShareError

Object

Modèle d’erreur de partage purview.

Nom Type Description
error

PurviewShareErrorInfo

Modèle de corps d’erreur de partage purview.

PurviewShareErrorInfo

Object

Modèle de corps d’erreur de partage purview.

Nom Type Description
code

string

Code de l’erreur
details

PurviewShareErrorInfo[]

Détails imbriqués du modèle d’erreur
message

string

Message de l’erreur
target

string

Cible de l’erreur

ReferenceNameType

Énumération

Définit le type de ressource partagé

Valeur Description
ArmResourceReference

Le type de référence est une ressource ARM

ShareKind

Énumération

Définit les types pris en charge pour le partage.

Valeur Description
InPlace

Le type de partage est un partage sur place

State

Énumération

État de la ressource

Valeur Description
Unknown

L’état de la ressource est « Inconnu »
Succeeded

L’état de la ressource est « Réussi »
Creating

L’état de la ressource est « Création »
Deleting

L’état de la ressource est « Suppression »
Moving

L’état de la ressource est « Déplacement »
Failed

L’état de la ressource est « Échec »

StorageAccountPath

Object

Définit un chemin d’accès StorageAccountPath unique

Nom Type Description
containerName

string

Obtient ou définit le nom du conteneur
receiverPath

string

Obtient ou définit le chemin d’accès côté récepteur où l’artefact doit être mappé
senderPath

string

Obtient ou définit le chemin d’accès au fichier/dossier dans le conteneur à partager

StoreKind

Énumération

Types de ressources.

Valeur Description
AdlsGen2Account

Le type de magasin est un compte de stockage Adls Gen2
BlobAccount

Le type de magasin est un compte de stockage d’objets blob

StoreReference

Object

Référence de magasin pour un artefact ou un récepteur.

Nom Type Description
referenceName

string

Nom de référence pour la ressource associée au récepteur ou à l’artefact.
type

ReferenceNameType

Définit le type de ressource partagé