你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure-rest/purview-sharing package

接口

AdlsGen2AccountSink

AdlsGen2 接收器

AdlsGen2AccountSinkOutput

AdlsGen2 接收器

AdlsGen2AccountSinkProperties

AdlsGen2 存储帐户的属性

AdlsGen2AccountSinkPropertiesOutput

AdlsGen2 存储帐户的属性

AdlsGen2Artifact

Adls Gen2 存储帐户项目。

AdlsGen2ArtifactOutput

Adls Gen2 存储帐户项目。

AdlsGen2ArtifactProperties

Adls Gen2 存储帐户的属性。

AdlsGen2ArtifactPropertiesOutput

Adls Gen2 存储帐户的属性。

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

用于推断响应类型中分页元素的帮助程序类型。此类型基于特定于 itemName 属性的 x-ms-pageable 的 swagger 信息生成,该属性指示在其中找到页面项的响应的属性。 默认值为 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

包含 nextLink 和元素当前页的初始响应

options

PagingOptions<TResponse>

返回

  • PagedAsyncIterableIterator 循环访问元素