Bagikan melalui

Sent Shares - Create Or Replace

Layanan:
Purview
Versi API:
2023-02-15-preview

Membuat atau mengganti berbagi terkirim

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
endpoint
 path True

string

Titik akhir berbagi akun purview Anda. Contoh: 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 berbagi yang dikirim
api-version
 query True

string

Versi api yang akan digunakan

Isi Permintaan

InPlaceSentShare

Jenis berbagi InPlace.

Nama Diperlukan Jenis Deskripsi
properties True

InPlaceSentShareProperties

Properti untuk berbagi terkirim InPlace.
shareKind True string:

InPlace

Menentukan jenis yang didukung untuk berbagi.

Respons

Nama Jenis Deskripsi
200 OK SentShare:

InPlaceSentShare

Keberhasilan

Header

Operation-Location: string
201 Created SentShare:

InPlaceSentShare

Keberhasilan

Header

Operation-Location: string
Other Status Codes

PurviewShareError

Respons kesalahan default.

Header

x-ms-error-code: string

Keamanan

azureAuth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
https://purview.azure.net/.default Cakupan layanan Purview

Contoh

SentShares_CreateOrReplace
SentShares_CreateOrReplaceAdlsGen2Account
SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
AdlsGen2Artifact

Artefak akun penyimpanan Adls Gen2.
AdlsGen2ArtifactProperties

Properti untuk akun penyimpanan Adls Gen2.
BlobStorageArtifact

Artefak akun penyimpanan blob.
BlobStorageArtifactProperties

Properti untuk akun penyimpanan blob.
InPlaceSentShare

Jenis berbagi InPlace.
InPlaceSentShareProperties

Properti untuk berbagi terkirim InPlace.
PurviewShareError

Model kesalahan berbagi purview.
PurviewShareErrorInfo

Model isi kesalahan berbagi purview.
ReferenceNameType

Menentukan jenis sumber daya yang dibagikan
ShareKind

Menentukan jenis yang didukung untuk berbagi.
State

Status sumber daya
StorageAccountPath

Menentukan satu jalur StorageAccountPath
StoreKind

Jenis aset.
StoreReference

Referensi Penyimpanan untuk artefak atau sink.

AdlsGen2Artifact

Objek

Artefak akun penyimpanan Adls Gen2.

Nama Jenis Deskripsi
properties

AdlsGen2ArtifactProperties

Properti untuk akun penyimpanan Adls Gen2.
storeKind string:

AdlsGen2Account

Jenis aset.
storeReference

StoreReference

Referensi Penyimpanan untuk artefak atau sink.

AdlsGen2ArtifactProperties

Objek

Properti untuk akun penyimpanan Adls Gen2.

Nama Jenis Deskripsi
location

string

Lokasi akun penyimpanan.
paths

StorageAccountPath[]

Daftar jalur akun penyimpanan Adls Gen2.

BlobStorageArtifact

Objek

Artefak akun penyimpanan blob.

Nama Jenis Deskripsi
properties

BlobStorageArtifactProperties

Properti untuk akun penyimpanan blob.
storeKind string:

BlobAccount

Jenis aset.
storeReference

StoreReference

Referensi Penyimpanan untuk artefak atau sink.

BlobStorageArtifactProperties

Objek

Properti untuk akun penyimpanan blob.

Nama Jenis Deskripsi
location

string

Lokasi akun penyimpanan.
paths

StorageAccountPath[]

Daftar jalur akun penyimpanan blob.

InPlaceSentShare

Objek

Jenis berbagi InPlace.

Nama Jenis Deskripsi
id

string

Id unik sumber daya.
properties

InPlaceSentShareProperties

Properti untuk berbagi terkirim InPlace.
shareKind string:

InPlace

Menentukan jenis yang didukung untuk berbagi.
type

string

Jenis sumber daya.

InPlaceSentShareProperties

Objek

Properti untuk berbagi terkirim InPlace.

Nama Jenis Deskripsi
artifact Artifact:

Kelas untuk artefak berbagi yang dikirim.
createdAt

string (date-time)

Waktu pembuatan berbagi terkirim. Diwakili dalam format tanggal-waktu standar seperti yang didefinisikan oleh RFC 3339
dependsOn

string[] (uuid)

Daftar berbagi yang bergantung pada berbagi terkirim.
description

string

Deskripsi berbagi terkirim.
displayName

string

Nama berbagi yang dikirim
senderEmail

string

Email pengirim yang membuat berbagi terkirim.
senderName

string

Nama pengirim yang membuat berbagi terkirim.
senderTenantName

string

Nama penyewa pengirim yang membuat berbagi terkirim.
state

State

Status sumber daya

PurviewShareError

Objek

Model kesalahan berbagi purview.

Nama Jenis Deskripsi
error

PurviewShareErrorInfo

Model isi kesalahan berbagi purview.

PurviewShareErrorInfo

Objek

Model isi kesalahan berbagi purview.

Nama Jenis Deskripsi
code

string

Kode kesalahan
details

PurviewShareErrorInfo[]

Detail berlapis dari model kesalahan
message

string

Pesan kesalahan
target

string

Target kesalahan

ReferenceNameType

Enumeration

Menentukan jenis sumber daya yang dibagikan

Nilai Deskripsi
ArmResourceReference

Jenis referensi adalah sumber daya ARM

ShareKind

Enumeration

Menentukan jenis yang didukung untuk berbagi.

Nilai Deskripsi
InPlace

Jenis berbagi adalah berbagi di tempat

State

Enumeration

Status sumber daya

Nilai Deskripsi
Unknown

Status sumber daya adalah 'Tidak Diketahui'
Succeeded

Status sumber daya adalah 'Berhasil'
Creating

Status sumber daya adalah 'Membuat'
Deleting

Status sumber daya adalah 'Menghapus'
Moving

Status sumber daya adalah 'Bergerak'
Failed

Status sumber daya adalah 'Gagal'

StorageAccountPath

Objek

Menentukan satu jalur StorageAccountPath

Nama Jenis Deskripsi
containerName

string

Mendapatkan atau mengatur nama kontainer
receiverPath

string

Mendapatkan atau mengatur jalur di sisi penerima tempat artefak akan dipetakan
senderPath

string

Mendapatkan atau mengatur jalur ke file/folder dalam kontainer yang akan dibagikan

StoreKind

Enumeration

Jenis aset.

Nilai Deskripsi
AdlsGen2Account

Jenis toko adalah akun penyimpanan Adls Gen 2
BlobAccount

Jenis penyimpanan adalah akun penyimpanan Blob

StoreReference

Objek

Referensi Penyimpanan untuk artefak atau sink.

Nama Jenis Deskripsi
referenceName

string

Nama referensi untuk sumber daya yang terkait dengan sink atau artefak.
type

ReferenceNameType

Menentukan jenis sumber daya yang dibagikan