Поделиться через

Sent Shares - Create Or Replace

Служба:
Purview
Версия API:
2023-02-15-preview

Создание или замена отправленной общей папки

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

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string

Конечная точка общего доступа учетной записи purview. Пример: 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})$

Идентификатор отправленной общей папки
api-version
 query True

string

Версия API для использования

Текст запроса

InPlaceSentShare

Тип общего ресурса InPlace.

Имя Обязательно Тип Описание
properties True

InPlaceSentShareProperties

Свойства для отправленной общей папки InPlace.
shareKind True string:

InPlace

Определяет поддерживаемые типы для общего доступа.

Ответы

Имя Тип Описание
200 OK SentShare:

InPlaceSentShare

Успех

Заголовки

Operation-Location: string
201 Created SentShare:

InPlaceSentShare

Успех

Заголовки

Operation-Location: string
Other Status Codes

PurviewShareError

Ответ об ошибке по умолчанию.

Заголовки

x-ms-error-code: string

Безопасность

azureAuth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
https://purview.azure.net/.default Область службы Purview

Примеры

SentShares_CreateOrReplace
SentShares_CreateOrReplaceAdlsGen2Account
SentShares_CreateOrReplaceBlobAccount

SentShares_CreateOrReplace

Образец запроса

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

Пример ответа

Код состояния:
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"
}
Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
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"
}
Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
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"
}
Код состояния:
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"
}

Определения

Имя Описание
AdlsGen2Artifact

Артефакт учетной записи хранения Adls 2-го поколения.
AdlsGen2ArtifactProperties

Свойства учетной записи хранения Adls 2-го поколения.
BlobStorageArtifact

Артефакт учетной записи хранения BLOB-объектов.
BlobStorageArtifactProperties

Свойства учетной записи хранения BLOB-объектов.
InPlaceSentShare

Тип общего ресурса InPlace.
InPlaceSentShareProperties

Свойства для отправленной общей папки InPlace.
PurviewShareError

Модель ошибки общего доступа purview.
PurviewShareErrorInfo

Модель тела ошибки purview.
ReferenceNameType

Определяет тип общего ресурса
ShareKind

Определяет поддерживаемые типы для общего доступа.
State

Состояние ресурса
StorageAccountPath

Определяет один путь StorageAccountPath
StoreKind

Типы активов.
StoreReference

Справочник по магазину для артефакта или приемника.

AdlsGen2Artifact

Object

Артефакт учетной записи хранения Adls 2-го поколения.

Имя Тип Описание
properties

AdlsGen2ArtifactProperties

Свойства учетной записи хранения Adls 2-го поколения.
storeKind string:

AdlsGen2Account

Типы активов.
storeReference

StoreReference

Справочник по магазину для артефакта или приемника.

AdlsGen2ArtifactProperties

Object

Свойства учетной записи хранения Adls 2-го поколения.

Имя Тип Описание
location

string

Расположение учетной записи хранения.
paths

StorageAccountPath[]

Список путей учетной записи хранения Adls 2-го поколения.

BlobStorageArtifact

Object

Артефакт учетной записи хранения BLOB-объектов.

Имя Тип Описание
properties

BlobStorageArtifactProperties

Свойства учетной записи хранения BLOB-объектов.
storeKind string:

BlobAccount

Типы активов.
storeReference

StoreReference

Справочник по магазину для артефакта или приемника.

BlobStorageArtifactProperties

Object

Свойства учетной записи хранения BLOB-объектов.

Имя Тип Описание
location

string

Расположение учетной записи хранения.
paths

StorageAccountPath[]

Список путей учетной записи хранения BLOB-объектов.

InPlaceSentShare

Object

Тип общего ресурса InPlace.

Имя Тип Описание
id

string

Уникальный идентификатор ресурса.
properties

InPlaceSentShareProperties

Свойства для отправленной общей папки InPlace.
shareKind string:

InPlace

Определяет поддерживаемые типы для общего доступа.
type

string

Тип ресурса.

InPlaceSentShareProperties

Object

Свойства для отправленной общей папки InPlace.

Имя Тип Описание
artifact Artifact:

Класс для артефакта отправки общего ресурса.
createdAt

string (date-time)

Время создания отправленной общей папки. Представлен в стандартном формате даты и времени, как определено RFC 3339
dependsOn

string[] (uuid)

Список общих папок, от которых зависит отправленный общий ресурс.
description

string

Отправлено описание общей папки.
displayName

string

Имя отправленной общей папки
senderEmail

string

Сообщение электронной почты отправителя, создавшего отправленную общую папку.
senderName

string

Имя отправителя, создавшего отправленную общую папку.
senderTenantName

string

Имя клиента отправителя, создавшего отправленную общую папку.
state

State

Состояние ресурса

PurviewShareError

Object

Модель ошибки общего доступа purview.

Имя Тип Описание
error

PurviewShareErrorInfo

Модель тела ошибки purview.

PurviewShareErrorInfo

Object

Модель тела ошибки purview.

Имя Тип Описание
code

string

Код ошибки
details

PurviewShareErrorInfo[]

Вложенные сведения о модели ошибок
message

string

Сообщение об ошибке
target

string

Целевой объект ошибки

ReferenceNameType

Перечисление

Определяет тип общего ресурса

Значение Описание
ArmResourceReference

Тип ссылки — это ресурс ARM

ShareKind

Перечисление

Определяет поддерживаемые типы для общего доступа.

Значение Описание
InPlace

Тип общей папки — общий доступ на месте

State

Перечисление

Состояние ресурса

Значение Описание
Unknown

Состояние ресурса — "Неизвестно"
Succeeded

Состояние ресурса — "Успешно"
Creating

Состояние ресурса — "Создание"
Deleting

Состояние ресурса — "Удаление"
Moving

Состояние ресурса — "Перемещение"
Failed

Состояние ресурса — "Сбой"

StorageAccountPath

Object

Определяет один путь StorageAccountPath

Имя Тип Описание
containerName

string

Возвращает или задает имя контейнера
receiverPath

string

Возвращает или задает путь на стороне приемника, в которой должен быть сопоставлен артефакт.
senderPath

string

Возвращает или задает путь к файлу или папке в контейнере для общего доступа

StoreKind

Перечисление

Типы активов.

Значение Описание
AdlsGen2Account

Тип хранилища — это учетная запись хранения Adls 2-го поколения
BlobAccount

Тип хранилища — это учетная запись хранения BLOB-объектов

StoreReference

Object

Справочник по магазину для артефакта или приемника.

Имя Тип Описание
referenceName

string

Имя ссылки на ресурс, связанный с приемником или артефактом.
type

ReferenceNameType

Определяет тип общего ресурса