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


@azure-rest/purview-sharing package

Интерфейсы

AdlsGen2AccountSink

Приемник AdlsGen2

AdlsGen2AccountSinkOutput

Приемник AdlsGen2

AdlsGen2AccountSinkProperties

Свойства учетной записи хранения AdlsGen2

AdlsGen2AccountSinkPropertiesOutput

Свойства учетной записи хранения AdlsGen2

AdlsGen2Artifact

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

AdlsGen2ArtifactOutput

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

AdlsGen2ArtifactProperties

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

AdlsGen2ArtifactPropertiesOutput

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

ArtifactOutputParent

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

ArtifactParent

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

BlobAccountSink

Приемник BLOB-объектов

BlobAccountSinkOutput

Приемник BLOB-объектов

BlobAccountSinkProperties

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

BlobAccountSinkPropertiesOutput

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

BlobStorageArtifact

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

BlobStorageArtifactOutput

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

BlobStorageArtifactProperties

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

BlobStorageArtifactPropertiesOutput

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

InPlaceReceivedShare

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

InPlaceReceivedShareOutput

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

InPlaceReceivedShareProperties

Свойства полученной общей папки.

InPlaceReceivedSharePropertiesOutput

Свойства полученной общей папки.

InPlaceSentShare

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

InPlaceSentShareOutput

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

InPlaceSentShareProperties

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

InPlaceSentSharePropertiesOutput

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

OperationResponseOutput

Ответ для длительной операции.

PageSettings

Интерфейс, отслеживающий параметры для итерации страниц

PagedAsyncIterableIterator

Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.

PagingOptions

Параметры вспомогательного помощника по страницам

ProxyResource

Реализация объекта передачи базовых данных для прокси-ресурсов.

ProxyResourceOutput

Реализация объекта передачи базовых данных для прокси-ресурсов.

PurviewShareErrorInfoOutput

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

PurviewShareErrorOutput

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

PurviewSharingClientOptions

Необязательные параметры для клиента

ReceivedShareListOutput

Список полученных общих папок.

ReceivedShareOutputParent

Полученный объект передачи данных общего ресурса.

ReceivedShareParent

Полученный объект передачи данных общего ресурса.

ReceivedSharesActivateTenantEmailRegistration
ReceivedSharesActivateTenantEmailRegistration200Response

Активация регистрации электронной почты для текущего клиента

ReceivedSharesActivateTenantEmailRegistrationBodyParam
ReceivedSharesActivateTenantEmailRegistrationDefaultHeaders
ReceivedSharesActivateTenantEmailRegistrationDefaultResponse

Активация регистрации электронной почты для текущего клиента

ReceivedSharesActivateTenantEmailRegistrationHeaderParam
ReceivedSharesActivateTenantEmailRegistrationHeaders
ReceivedSharesActivateTenantEmailRegistrationMediaTypesParam
ReceivedSharesCreateOrReplace200Headers
ReceivedSharesCreateOrReplace200Response

Обновление изменений в полученной общей папке

ReceivedSharesCreateOrReplace201Headers
ReceivedSharesCreateOrReplace201Response

Обновление изменений в полученной общей папке

ReceivedSharesCreateOrReplaceBodyParam
ReceivedSharesCreateOrReplaceDefaultHeaders
ReceivedSharesCreateOrReplaceDefaultResponse

Обновление изменений в полученной общей папке

ReceivedSharesCreateOrReplaceMediaTypesParam
ReceivedSharesDeleteReceivedShare202Headers
ReceivedSharesDeleteReceivedShare202Response

Удаление полученной общей папки

ReceivedSharesDeleteReceivedShareDefaultHeaders
ReceivedSharesDeleteReceivedShareDefaultResponse

Удаление полученной общей папки

ReceivedSharesGetAllAttachedReceivedShares
ReceivedSharesGetAllAttachedReceivedShares200Response

Список присоединенных общих папок

ReceivedSharesGetAllAttachedReceivedSharesDefaultHeaders
ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse

Список присоединенных общих папок

ReceivedSharesGetAllAttachedReceivedSharesQueryParam
ReceivedSharesGetAllAttachedReceivedSharesQueryParamProperties
ReceivedSharesGetAllDetachedReceivedShares
ReceivedSharesGetAllDetachedReceivedShares200Response

Перечисление отсоединяемых полученных общих папок

ReceivedSharesGetAllDetachedReceivedSharesDefaultHeaders
ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse

Перечисление отсоединяемых полученных общих папок

ReceivedSharesGetAllDetachedReceivedSharesQueryParam
ReceivedSharesGetAllDetachedReceivedSharesQueryParamProperties
ReceivedSharesGetReceivedShare
ReceivedSharesGetReceivedShare200Response

Получение полученной общей папки

ReceivedSharesGetReceivedShareDefaultHeaders
ReceivedSharesGetReceivedShareDefaultResponse

Получение полученной общей папки

ReceivedSharesRegisterTenantEmailRegistration
ReceivedSharesRegisterTenantEmailRegistration200Response

Регистрация электронной почты для текущего клиента

ReceivedSharesRegisterTenantEmailRegistrationDefaultHeaders
ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse

Регистрация электронной почты для текущего клиента

ReceivedSharesRegisterTenantEmailRegistrationHeaderParam
ReceivedSharesRegisterTenantEmailRegistrationHeaders
Routes
SentShareInvitationListOutput

Список отправленных приглашений на общий доступ

SentShareInvitationOutputParent

Объект передачи приглашений для отправки приглашений на общий доступ.

SentShareInvitationParent

Объект передачи приглашений для отправки приглашений на общий доступ.

SentShareListOutput

Список отправленных общих папок.

SentShareOutputParent

Отправленный объект передачи данных.

SentShareParent

Отправленный объект передачи данных.

SentSharesCreateOrReplace200Headers
SentSharesCreateOrReplace200Response

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

SentSharesCreateOrReplace201Headers
SentSharesCreateOrReplace201Response

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

SentSharesCreateOrReplaceBodyParam
SentSharesCreateOrReplaceDefaultHeaders
SentSharesCreateOrReplaceDefaultResponse

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

SentSharesCreateOrReplaceMediaTypesParam
SentSharesCreateSentShareInvitation201Response

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

SentSharesCreateSentShareInvitationBodyParam
SentSharesCreateSentShareInvitationDefaultHeaders
SentSharesCreateSentShareInvitationDefaultResponse

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

SentSharesCreateSentShareInvitationMediaTypesParam
SentSharesDeleteSentShare202Headers
SentSharesDeleteSentShare202Response

Удаление отправленной общей папки

SentSharesDeleteSentShareDefaultHeaders
SentSharesDeleteSentShareDefaultResponse

Удаление отправленной общей папки

SentSharesDeleteSentShareInvitation202Headers
SentSharesDeleteSentShareInvitation202Response

Удаление приглашений на отправку общего ресурса

SentSharesDeleteSentShareInvitationDefaultHeaders
SentSharesDeleteSentShareInvitationDefaultResponse

Удаление приглашений на отправку общего ресурса

SentSharesGetAllSentShareInvitations
SentSharesGetAllSentShareInvitations200Response

Список отправленных получателей общего ресурса

SentSharesGetAllSentShareInvitationsDefaultHeaders
SentSharesGetAllSentShareInvitationsDefaultResponse

Список отправленных получателей общего ресурса

SentSharesGetAllSentShareInvitationsQueryParam
SentSharesGetAllSentShareInvitationsQueryParamProperties
SentSharesGetAllSentShares
SentSharesGetAllSentShares200Response

Список отправленных общих папок

SentSharesGetAllSentSharesDefaultHeaders
SentSharesGetAllSentSharesDefaultResponse

Список отправленных общих папок

SentSharesGetAllSentSharesQueryParam
SentSharesGetAllSentSharesQueryParamProperties
SentSharesGetSentShare
SentSharesGetSentShare200Response

Получение отправленной общей папки

SentSharesGetSentShareDefaultHeaders
SentSharesGetSentShareDefaultResponse

Получение отправленной общей папки

SentSharesGetSentShareInvitation
SentSharesGetSentShareInvitation200Response

Получение получателя для указанной отправленной общей папки

SentSharesGetSentShareInvitationDefaultHeaders
SentSharesGetSentShareInvitationDefaultResponse

Получение получателя для указанной отправленной общей папки

SentSharesNotifyUserSentShareInvitation
SentSharesNotifyUserSentShareInvitation200Response

Уведомляет пользователя о приглашении отправленной общей папки, не применяется к приглашениям на обслуживание.

SentSharesNotifyUserSentShareInvitationDefaultHeaders
SentSharesNotifyUserSentShareInvitationDefaultResponse

Уведомляет пользователя о приглашении отправленной общей папки, не применяется к приглашениям на обслуживание.

SentSharesNotifyUserSentShareInvitationHeaderParam
SentSharesNotifyUserSentShareInvitationHeaders
ServiceInvitation

Тип приглашения на обслуживание.

ServiceInvitationOutput

Тип приглашения на обслуживание.

ServiceInvitationProperties

Свойства типа приглашения службы.

ServiceInvitationPropertiesOutput

Свойства типа приглашения службы.

ShareResource

Ресурс общего доступа.

ShareResourceListOutput

Страница результатов ShareResource.

ShareResourceOutput

Ресурс общего доступа.

ShareResourcesGetAllShareResources
ShareResourcesGetAllShareResources200Response

Перечисление ресурсов общего ресурса

ShareResourcesGetAllShareResourcesDefaultHeaders
ShareResourcesGetAllShareResourcesDefaultResponse

Перечисление ресурсов общего ресурса

ShareResourcesGetAllShareResourcesQueryParam
ShareResourcesGetAllShareResourcesQueryParamProperties
SimplePollerLike

Простой опросщик, который можно использовать для опроса длительной операции.

SinkOutputParent

Содержит сведения о назначении сопоставленного артефакта

SinkParent

Содержит сведения о назначении сопоставленного артефакта

StorageAccountPath

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

StorageAccountPathOutput

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

StoreReference

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

StoreReferenceOutput

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

TenantEmailRegistration

Объект передачи данных регистрации электронной почты клиента.

TenantEmailRegistrationOutput

Объект передачи данных регистрации электронной почты клиента.

TenantEmailRegistrationProperties

Контейнер свойств регистрации электронной почты клиента.

TenantEmailRegistrationPropertiesOutput

Контейнер свойств регистрации электронной почты клиента.

UserInvitation

Тип приглашения пользователя.

UserInvitationOutput

Тип приглашения пользователя.

UserInvitationProperties

Свойства типа приглашения пользователя.

UserInvitationPropertiesOutput

Свойства типа приглашения пользователя.

Псевдонимы типа

Artifact

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

ArtifactOutput

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

GetArrayType

Вспомогательный тип для извлечения типа массива

GetPage

Тип настраиваемой функции, которая определяет, как получить страницу и ссылку на следующую.

PaginateReturn

Вспомогательный тип для вывода типа страничных элементов из типа ответа этот тип создается на основе сведений swagger для x-ms-pageable специально в свойстве itemName, которое указывает свойство ответа, в котором находятся элементы страницы. Значение по умолчанию — value. Этот тип позволяет предоставлять строго типизированный итератор на основе ответа, который мы получаем в качестве второго параметра.

PurviewSharingClient
ReceivedShare

Полученный объект передачи данных общего ресурса.

ReceivedShareOutput

Полученный объект передачи данных общего ресурса.

ReceivedSharesActivateTenantEmailRegistrationParameters
ReceivedSharesCreateOrReplaceParameters
ReceivedSharesDeleteReceivedShareParameters
ReceivedSharesGetAllAttachedReceivedSharesParameters
ReceivedSharesGetAllDetachedReceivedSharesParameters
ReceivedSharesGetReceivedShareParameters
ReceivedSharesRegisterTenantEmailRegistrationParameters
SentShare

Отправленный объект передачи данных.

SentShareInvitation

Объект передачи приглашений для отправки приглашений на общий доступ.

SentShareInvitationOutput

Объект передачи приглашений для отправки приглашений на общий доступ.

SentShareOutput

Отправленный объект передачи данных.

SentSharesCreateOrReplaceParameters
SentSharesCreateSentShareInvitationParameters
SentSharesDeleteSentShareInvitationParameters
SentSharesDeleteSentShareParameters
SentSharesGetAllSentShareInvitationsParameters
SentSharesGetAllSentSharesParameters
SentSharesGetSentShareInvitationParameters
SentSharesGetSentShareParameters
SentSharesNotifyUserSentShareInvitationParameters
ShareResourcesGetAllShareResourcesParameters
Sink

Содержит сведения о назначении сопоставленного артефакта

SinkOutput

Содержит сведения о назначении сопоставленного артефакта

Функции

default(string, TokenCredential, PurviewSharingClientOptions)

Инициализация нового экземпляра PurviewSharingClient

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Вспомогающая функция, которая создает объект Poller, чтобы помочь провести опрос длительной операции.

isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)
isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)
isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)
isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)
isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)
isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)
isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)
isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)
isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)
isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)
isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)
isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)
isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)
isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)
isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)
isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)
isUnexpected(ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Вспомогательный элемент для разбивки результатов из первоначального ответа, который соответствует спецификации расширения autorest x-ms-pageable

Сведения о функции

default(string, TokenCredential, PurviewSharingClientOptions)

Инициализация нового экземпляра PurviewSharingClient

function default(endpoint: string, credentials: TokenCredential, options?: PurviewSharingClientOptions): PurviewSharingClient

Параметры

endpoint

string

Конечная точка общего доступа учетной записи purview. Пример: https://{accountName}.purview.azure.com/share

credentials
TokenCredential

уникально идентификация учетных данных клиента

options
PurviewSharingClientOptions

параметр для всех необязательных параметров

Возвращаемое значение

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Вспомогающая функция, которая создает объект Poller, чтобы помочь провести опрос длительной операции.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Параметры

client
Client

Клиент, используемый для отправки запроса, чтобы получить дополнительные страницы.

initialResponse

TResult

Начальный ответ.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Параметры для задания состояния возобновления или настраиваемого интервала опроса.

Возвращаемое значение

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • Объект опроса для проверки обновлений состояния операции и в конечном итоге получает окончательный ответ.

isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)

function isUnexpected(response: ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)

function isUnexpected(response: ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)

function isUnexpected(response: ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)

function isUnexpected(response: ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)

function isUnexpected(response: ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)

function isUnexpected(response: ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)

function isUnexpected(response: ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)

function isUnexpected(response: SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)

function isUnexpected(response: SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)

function isUnexpected(response: SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)

function isUnexpected(response: SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)

function isUnexpected(response: SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse): response

Параметры

Возвращаемое значение

response

isUnexpected(ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse)

function isUnexpected(response: ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse): response

Параметры

Возвращаемое значение

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Вспомогательный элемент для разбивки результатов из первоначального ответа, который соответствует спецификации расширения autorest x-ms-pageable

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Параметры

client
Client

Клиент, используемый для отправки запросов на следующую страницу

initialResponse

TResponse

Начальный ответ, содержащий следующую ссылку и текущую страницу элементов

options

PagingOptions<TResponse>

Возвращаемое значение

  • PagedAsyncIterableIterator для итерации элементов