Sent Shares - Create Or Replace

Service:: Purview

API-versie:: 2023-02-15-preview

Een verzonden share maken of vervangen

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Het eindpunt voor delen van uw purview-account. Voorbeeld: 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 van de verzonden share
api-version	query	True	string	De API-versie die moet worden gebruikt

Aanvraagbody

InPlaceSentShare

Een InPlace-deeltype.

Name	Vereist	Type	Description
properties	True	InPlaceSentShareProperties	Eigenschappen voor verzonden InPlace-share.
shareKind	True	string: InPlace	Definieert de ondersteunde typen voor share.

Antwoorden

Name	Type	Description
200 OK	SentShare: InPlaceSentShare	Geslaagd Kopteksten Operation-Location: string
201 Created	SentShare: InPlaceSentShare	Geslaagd Kopteksten Operation-Location: string
Other Status Codes	PurviewShareError	Standaardfoutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

SentShare:

InPlaceSentShare

Geslaagd

Kopteksten

Operation-Location: string

201 Created

SentShare:

InPlaceSentShare

Geslaagd

Kopteksten

Operation-Location: string

Other Status Codes

PurviewShareError

Standaardfoutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

azureAuth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://purview.azure.net/.default	Purview-servicebereik

Voorbeelden

SentShares_CreateOrReplace

SentShares_CreateOrReplaceAdlsGen2Account

SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Statuscode:: 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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Statuscode:: 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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

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

Definities

Name	Description
AdlsGen2Artifact	Een adls Gen2-opslagaccountartefact.
AdlsGen2ArtifactProperties	Eigenschappen voor Adls Gen2-opslagaccount.
BlobStorageArtifact	Blob Storage-accountartefact.
BlobStorageArtifactProperties	Eigenschappen voor blob-opslagaccount.
InPlaceSentShare	Een InPlace-deeltype.
InPlaceSentShareProperties	Eigenschappen voor verzonden InPlace-share.
PurviewShareError	Het purview-foutmodel voor delen.
PurviewShareErrorInfo	Het hoofdtekstmodel van de purview-sharefout.
ReferenceNameType	Definieert het type resource dat wordt gedeeld
ShareKind	Definieert de ondersteunde typen voor share.
State	Status van de resource
StorageAccountPath	Hiermee definieert u één StorageAccountPath-pad
StoreKind	De typen activa.
StoreReference	Een archiefreferentie voor een artefact of sink.

AdlsGen2Artifact

Object

Een adls Gen2-opslagaccountartefact.

Name	Type	Description
properties	AdlsGen2ArtifactProperties	Eigenschappen voor Adls Gen2-opslagaccount.
storeKind	string: AdlsGen2Account	De typen activa.
storeReference	StoreReference	Een archiefreferentie voor een artefact of sink.

AdlsGen2ArtifactProperties

Object

Eigenschappen voor Adls Gen2-opslagaccount.

Name	Type	Description
location	string	Locatie van het opslagaccount.
paths	StorageAccountPath[]	Een lijst met Adls Gen2-opslagaccountpaden.

BlobStorageArtifact

Object

Blob Storage-accountartefact.

Name	Type	Description
properties	BlobStorageArtifactProperties	Eigenschappen voor blob-opslagaccount.
storeKind	string: BlobAccount	De typen activa.
storeReference	StoreReference	Een archiefreferentie voor een artefact of sink.

BlobStorageArtifactProperties

Object

Eigenschappen voor blob-opslagaccount.

Name	Type	Description
location	string	Locatie van het opslagaccount.
paths	StorageAccountPath[]	Een lijst met blob-opslagaccountpaden.

InPlaceSentShare

Object

Een InPlace-deeltype.

Name	Type	Description
id	string	De unieke id van de resource.
properties	InPlaceSentShareProperties	Eigenschappen voor verzonden InPlace-share.
shareKind	string: InPlace	Definieert de ondersteunde typen voor share.
type	string	Type resource.

InPlaceSentShareProperties

Object

Eigenschappen voor verzonden InPlace-share.

Name	Type	Description
artifact	Artifact: AdlsGen2Artifact BlobStorageArtifact	Een klasse voor verzonden shareartefacten.
createdAt	string (date-time)	Tijdstip waarop de verzonden share is gemaakt. Weergegeven in de standaardnotatie voor datum/tijd zoals gedefinieerd door RFC 3339-
dependsOn	string[] (uuid)	Lijst met shares waarvan de verzonden share afhankelijk is.
description	string	Beschrijving van verzonden share.
displayName	string	De naam van de verzonden share
senderEmail	string	E-mail van de afzender die de verzonden share heeft gemaakt.
senderName	string	Naam van de afzender die de verzonden share heeft gemaakt.
senderTenantName	string	Tenantnaam van de afzender die de verzonden share heeft gemaakt.
state	State	Status van de resource

PurviewShareError

Object

Het purview-foutmodel voor delen.

Name	Type	Description
error	PurviewShareErrorInfo	Het hoofdtekstmodel van de purview-sharefout.

PurviewShareErrorInfo

Object

Het hoofdtekstmodel van de purview-sharefout.

Name	Type	Description
code	string	Code van de fout
details	PurviewShareErrorInfo[]	Geneste details van het foutmodel
message	string	Bericht van de fout
target	string	Doel van de fout

ReferenceNameType

Inventarisatie

Definieert het type resource dat wordt gedeeld

Waarde	Description
ArmResourceReference	Het type verwijzing is een ARM-resource

ShareKind

Inventarisatie

Definieert de ondersteunde typen voor share.

Waarde	Description
InPlace	Het type share is in-place delen

State

Inventarisatie

Status van de resource

Waarde	Description
Unknown	De status van de resource is Onbekend
Succeeded	De status van de resource is Geslaagd
Creating	De status van de resource is 'Maken'
Deleting	De status van de resource is 'Verwijderen'
Moving	De status van de resource is 'Verplaatsen'
Failed	De status van de resource is Mislukt

StorageAccountPath

Object

Hiermee definieert u één StorageAccountPath-pad

Name	Type	Description
containerName	string	Hiermee haalt u de containernaam op of stelt u deze in
receiverPath	string	Hiermee haalt of stelt u het pad aan de ontvangerzijde op waar het artefact moet worden toegewezen
senderPath	string	Hiermee wordt het pad naar het bestand/de map in de container opgehaald of ingesteld om te worden gedeeld

StoreKind

Inventarisatie

De typen activa.

Waarde	Description
AdlsGen2Account	Het type winkel is een Adls Gen 2-opslagaccount
BlobAccount	Het type winkel is een Blob Storage-account

StoreReference

Object

Een archiefreferentie voor een artefact of sink.

Name	Type	Description
referenceName	string	Referentienaam voor de resource die is gekoppeld aan de sink of het artefact.
type	ReferenceNameType	Definieert het type resource dat wordt gedeeld

Delen via

Sent Shares - Create Or Replace

URI-parameters

Aanvraagbody

InPlaceSentShare

Antwoorden

Beveiliging

azureAuth

Bereiken

Voorbeelden

SentShares_CreateOrReplace

Voorbeeldaanvraag

Voorbeeldrespons

SentShares_CreateOrReplaceAdlsGen2Account

Voorbeeldaanvraag

Voorbeeldrespons

SentShares_CreateOrReplaceBlobAccount

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AdlsGen2Artifact

AdlsGen2ArtifactProperties

BlobStorageArtifact

BlobStorageArtifactProperties

InPlaceSentShare

InPlaceSentShareProperties

PurviewShareError

PurviewShareErrorInfo

ReferenceNameType

ShareKind

State

StorageAccountPath

StoreKind

StoreReference