Dela via

Sent Shares - Create Or Replace

Tjänst:
Purview
API-version:
2023-02-15-preview

Skapa eller ersätta en skickad resurs

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

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string

Delningsslutpunkten för ditt purview-konto. Exempel: 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 för den skickade resursen
api-version
 query True

string

Api-versionen som ska användas

Begärandetext

InPlaceSentShare

En InPlace-resurstyp.

Name Obligatorisk Typ Description
properties True

InPlaceSentShareProperties

Egenskaper för InPlace-skickad resurs.
shareKind True string:

InPlace

Definierar de typer som stöds för resursen.

Svar

Name Typ Description
200 OK SentShare:

InPlaceSentShare

Framgång

Sidhuvuden

Operation-Location: string
201 Created SentShare:

InPlaceSentShare

Framgång

Sidhuvuden

Operation-Location: string
Other Status Codes

PurviewShareError

Standardfelsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

azureAuth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
https://purview.azure.net/.default Purview-tjänstomfång

Exempel

SentShares_CreateOrReplace
SentShares_CreateOrReplaceAdlsGen2Account
SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AdlsGen2Artifact

En Adls Gen2-lagringskontoartefakt.
AdlsGen2ArtifactProperties

Egenskaper för Adls Gen2-lagringskonto.
BlobStorageArtifact

Blob Storage-kontoartefakt.
BlobStorageArtifactProperties

Egenskaper för bloblagringskonto.
InPlaceSentShare

En InPlace-resurstyp.
InPlaceSentShareProperties

Egenskaper för InPlace-skickad resurs.
PurviewShareError

Felmodellen för purview-resurs.
PurviewShareErrorInfo

Purview-resursens feltextmodell.
ReferenceNameType

Definierar vilken typ av resurs som delas
ShareKind

Definierar de typer som stöds för resursen.
State

Resursens tillstånd
StorageAccountPath

Definierar en enda StorageAccountPath-sökväg
StoreKind

Typerna av tillgång.
StoreReference

En lagringsreferens för en artefakt eller mottagare.

AdlsGen2Artifact

Objekt

En Adls Gen2-lagringskontoartefakt.

Name Typ Description
properties

AdlsGen2ArtifactProperties

Egenskaper för Adls Gen2-lagringskonto.
storeKind string:

AdlsGen2Account

Typerna av tillgång.
storeReference

StoreReference

En lagringsreferens för en artefakt eller mottagare.

AdlsGen2ArtifactProperties

Objekt

Egenskaper för Adls Gen2-lagringskonto.

Name Typ Description
location

string

Lagringskontots plats.
paths

StorageAccountPath[]

En lista över Adls Gen2-lagringskontosökvägar.

BlobStorageArtifact

Objekt

Blob Storage-kontoartefakt.

Name Typ Description
properties

BlobStorageArtifactProperties

Egenskaper för bloblagringskonto.
storeKind string:

BlobAccount

Typerna av tillgång.
storeReference

StoreReference

En lagringsreferens för en artefakt eller mottagare.

BlobStorageArtifactProperties

Objekt

Egenskaper för bloblagringskonto.

Name Typ Description
location

string

Lagringskontots plats.
paths

StorageAccountPath[]

En lista över sökvägar för bloblagringskonto.

InPlaceSentShare

Objekt

En InPlace-resurstyp.

Name Typ Description
id

string

Resursens unika ID.
properties

InPlaceSentShareProperties

Egenskaper för InPlace-skickad resurs.
shareKind string:

InPlace

Definierar de typer som stöds för resursen.
type

string

Typ av resurs.

InPlaceSentShareProperties

Objekt

Egenskaper för InPlace-skickad resurs.

Name Typ Description
artifact Artifact:

En klass för skickad resursartefakt.
createdAt

string (date-time)

Tidpunkt då den skickade resursen skapades. Representeras i standardformatet för datum och tid enligt definitionen i RFC 3339
dependsOn

string[] (uuid)

Lista över resurser som den skickade resursen är beroende av.
description

string

Beskrivning av skickad resurs.
displayName

string

Namnet på den skickade resursen
senderEmail

string

E-post för avsändaren som skapade den skickade resursen.
senderName

string

Namnet på avsändaren som skapade den skickade resursen.
senderTenantName

string

Klientorganisationens namn på avsändaren som skapade den skickade resursen.
state

State

Resursens tillstånd

PurviewShareError

Objekt

Felmodellen för purview-resurs.

Name Typ Description
error

PurviewShareErrorInfo

Purview-resursens feltextmodell.

PurviewShareErrorInfo

Objekt

Purview-resursens feltextmodell.

Name Typ Description
code

string

Kod för felet
details

PurviewShareErrorInfo[]

Kapslad information om felmodellen
message

string

Meddelande om felet
target

string

Målet för felet

ReferenceNameType

Uppräkning

Definierar vilken typ av resurs som delas

Värde Description
ArmResourceReference

Referenstypen är en ARM-resurs

ShareKind

Uppräkning

Definierar de typer som stöds för resursen.

Värde Description
InPlace

Typen av resurs är delning på plats

State

Uppräkning

Resursens tillstånd

Värde Description
Unknown

Resursens tillstånd är "Okänt"
Succeeded

Tillståndet för resursen är "Lyckades"
Creating

Tillståndet för resursen är "Skapa"
Deleting

Tillståndet för resursen är "Ta bort"
Moving

Tillståndet för resursen är "Moving" (Flytta)
Failed

Resursens tillstånd är "Misslyckades"

StorageAccountPath

Objekt

Definierar en enda StorageAccountPath-sökväg

Name Typ Description
containerName

string

Hämtar eller anger containernamnet
receiverPath

string

Hämtar eller anger sökvägen på mottagarsidan där artefakten ska mappas
senderPath

string

Hämtar eller anger sökvägen till fil/mapp i containern som ska delas

StoreKind

Uppräkning

Typerna av tillgång.

Värde Description
AdlsGen2Account

Butikstyp är ett Adls Gen 2-lagringskonto
BlobAccount

Butikstyp är ett Blob Storage-konto

StoreReference

Objekt

En lagringsreferens för en artefakt eller mottagare.

Name Typ Description
referenceName

string

Referensnamn för resursen som är associerad med mottagaren eller artefakten.
type

ReferenceNameType

Definierar vilken typ av resurs som delas