@azure-rest/purview-sharing package

Interfaces

AdlsGen2AccountSink	AdlsGen2 Sink
AdlsGen2AccountSinkOutput	AdlsGen2 Sink
AdlsGen2AccountSinkProperties	Properties for AdlsGen2 storage account
AdlsGen2AccountSinkPropertiesOutput	Properties for AdlsGen2 storage account
AdlsGen2Artifact	An Adls Gen2 storage account artifact.
AdlsGen2ArtifactOutput	An Adls Gen2 storage account artifact.
AdlsGen2ArtifactProperties	Properties for Adls Gen2 storage account.
AdlsGen2ArtifactPropertiesOutput	Properties for Adls Gen2 storage account.
ArtifactOutputParent	A class for sent share artifact.
ArtifactParent	A class for sent share artifact.
BlobAccountSink	Blob Sink
BlobAccountSinkOutput	Blob Sink
BlobAccountSinkProperties	Properties for blob storage account
BlobAccountSinkPropertiesOutput	Properties for blob storage account
BlobStorageArtifact	Blob storage account artifact.
BlobStorageArtifactOutput	Blob storage account artifact.
BlobStorageArtifactProperties	Properties for blob storage account.
BlobStorageArtifactPropertiesOutput	Properties for blob storage account.
InPlaceReceivedShare	An InPlace received share kind.
InPlaceReceivedShareOutput	An InPlace received share kind.
InPlaceReceivedShareProperties	Properties of in place received share.
InPlaceReceivedSharePropertiesOutput	Properties of in place received share.
InPlaceSentShare	An InPlace share kind.
InPlaceSentShareOutput	An InPlace share kind.
InPlaceSentShareProperties	Properties for InPlace sent share.
InPlaceSentSharePropertiesOutput	Properties for InPlace sent share.
OperationResponseOutput	Response for long running operation.
PagingOptions	Options for the paging helper
ProxyResource	Base data transfer object implementation for proxy resources.
ProxyResourceOutput	Base data transfer object implementation for proxy resources.
PurviewShareErrorInfoOutput	The purview share error body model.
PurviewShareErrorOutput	The purview share error model.
ReceivedShareListOutput	List of received shares.
ReceivedShareOutputParent	A received share data transfer object.
ReceivedShareParent	A received share data transfer object.
ReceivedSharesActivateTenantEmailRegistration
ReceivedSharesActivateTenantEmailRegistration200Response	Activates the email registration for current tenant
ReceivedSharesActivateTenantEmailRegistrationBodyParam
ReceivedSharesActivateTenantEmailRegistrationDefaultHeaders
ReceivedSharesActivateTenantEmailRegistrationDefaultResponse	Activates the email registration for current tenant
ReceivedSharesActivateTenantEmailRegistrationHeaderParam
ReceivedSharesActivateTenantEmailRegistrationHeaders
ReceivedSharesActivateTenantEmailRegistrationMediaTypesParam
ReceivedSharesCreateOrReplace200Headers
ReceivedSharesCreateOrReplace200Response	Update changes to a received share
ReceivedSharesCreateOrReplace201Headers
ReceivedSharesCreateOrReplace201Response	Update changes to a received share
ReceivedSharesCreateOrReplaceBodyParam
ReceivedSharesCreateOrReplaceDefaultHeaders
ReceivedSharesCreateOrReplaceDefaultResponse	Update changes to a received share
ReceivedSharesCreateOrReplaceMediaTypesParam
ReceivedSharesDeleteReceivedShare202Headers
ReceivedSharesDeleteReceivedShare202Response	Delete a received share
ReceivedSharesDeleteReceivedShareDefaultHeaders
ReceivedSharesDeleteReceivedShareDefaultResponse	Delete a received share
ReceivedSharesGetAllAttachedReceivedShares
ReceivedSharesGetAllAttachedReceivedShares200Response	List attached received shares
ReceivedSharesGetAllAttachedReceivedSharesDefaultHeaders
ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse	List attached received shares
ReceivedSharesGetAllAttachedReceivedSharesQueryParam
ReceivedSharesGetAllAttachedReceivedSharesQueryParamProperties
ReceivedSharesGetAllDetachedReceivedShares
ReceivedSharesGetAllDetachedReceivedShares200Response	List detached received shares
ReceivedSharesGetAllDetachedReceivedSharesDefaultHeaders
ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse	List detached received shares
ReceivedSharesGetAllDetachedReceivedSharesQueryParam
ReceivedSharesGetAllDetachedReceivedSharesQueryParamProperties
ReceivedSharesGetReceivedShare
ReceivedSharesGetReceivedShare200Response	Get a received share
ReceivedSharesGetReceivedShareDefaultHeaders
ReceivedSharesGetReceivedShareDefaultResponse	Get a received share
ReceivedSharesRegisterTenantEmailRegistration
ReceivedSharesRegisterTenantEmailRegistration200Response	Register an email for the current tenant
ReceivedSharesRegisterTenantEmailRegistrationDefaultHeaders
ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse	Register an email for the current tenant
ReceivedSharesRegisterTenantEmailRegistrationHeaderParam
ReceivedSharesRegisterTenantEmailRegistrationHeaders
Routes
SentShareInvitationListOutput	List of the sent share invitations
SentShareInvitationOutputParent	A sent share invitation data transfer object.
SentShareInvitationParent	A sent share invitation data transfer object.
SentShareListOutput	List of sent shares.
SentShareOutputParent	A sent share data transfer object.
SentShareParent	A sent share data transfer object.
SentSharesCreateOrReplace200Headers
SentSharesCreateOrReplace200Response	Create or replace a sent share
SentSharesCreateOrReplace201Headers
SentSharesCreateOrReplace201Response	Create or replace a sent share
SentSharesCreateOrReplaceBodyParam
SentSharesCreateOrReplaceDefaultHeaders
SentSharesCreateOrReplaceDefaultResponse	Create or replace a sent share
SentSharesCreateOrReplaceMediaTypesParam
SentSharesCreateSentShareInvitation201Response	Create a recipient for a given sent share
SentSharesCreateSentShareInvitationBodyParam
SentSharesCreateSentShareInvitationDefaultHeaders
SentSharesCreateSentShareInvitationDefaultResponse	Create a recipient for a given sent share
SentSharesCreateSentShareInvitationMediaTypesParam
SentSharesDeleteSentShare202Headers
SentSharesDeleteSentShare202Response	Delete a sent share
SentSharesDeleteSentShareDefaultHeaders
SentSharesDeleteSentShareDefaultResponse	Delete a sent share
SentSharesDeleteSentShareInvitation202Headers
SentSharesDeleteSentShareInvitation202Response	Delete a sent share invitation
SentSharesDeleteSentShareInvitationDefaultHeaders
SentSharesDeleteSentShareInvitationDefaultResponse	Delete a sent share invitation
SentSharesGetAllSentShareInvitations
SentSharesGetAllSentShareInvitations200Response	List sent share recipients
SentSharesGetAllSentShareInvitationsDefaultHeaders
SentSharesGetAllSentShareInvitationsDefaultResponse	List sent share recipients
SentSharesGetAllSentShareInvitationsQueryParam
SentSharesGetAllSentShareInvitationsQueryParamProperties
SentSharesGetAllSentShares
SentSharesGetAllSentShares200Response	List sent shares
SentSharesGetAllSentSharesDefaultHeaders
SentSharesGetAllSentSharesDefaultResponse	List sent shares
SentSharesGetAllSentSharesQueryParam
SentSharesGetAllSentSharesQueryParamProperties
SentSharesGetSentShare
SentSharesGetSentShare200Response	Get a sent share
SentSharesGetSentShareDefaultHeaders
SentSharesGetSentShareDefaultResponse	Get a sent share
SentSharesGetSentShareInvitation
SentSharesGetSentShareInvitation200Response	Get recipient for a given sent share
SentSharesGetSentShareInvitationDefaultHeaders
SentSharesGetSentShareInvitationDefaultResponse	Get recipient for a given sent share
SentSharesNotifyUserSentShareInvitation
SentSharesNotifyUserSentShareInvitation200Response	Notifies the user recipient of the sent share invitation, does not apply to service invitations.
SentSharesNotifyUserSentShareInvitationDefaultHeaders
SentSharesNotifyUserSentShareInvitationDefaultResponse	Notifies the user recipient of the sent share invitation, does not apply to service invitations.
SentSharesNotifyUserSentShareInvitationHeaderParam
SentSharesNotifyUserSentShareInvitationHeaders
ServiceInvitation	An service invitation kind.
ServiceInvitationOutput	An service invitation kind.
ServiceInvitationProperties	Properties of the service invitation type.
ServiceInvitationPropertiesOutput	Properties of the service invitation type.
SinkOutputParent	Holds details on the destination of the mapped artifact
SinkParent	Holds details on the destination of the mapped artifact
StorageAccountPath	Defines a single StorageAccountPath path
StorageAccountPathOutput	Defines a single StorageAccountPath path
StoreReference	A Store Reference for an artifact or sink.
StoreReferenceOutput	A Store Reference for an artifact or sink.
TenantEmailRegistration	A tenant email registration data transfer object.
TenantEmailRegistrationOutput	A tenant email registration data transfer object.
TenantEmailRegistrationProperties	Tenant email registration property bag.
TenantEmailRegistrationPropertiesOutput	Tenant email registration property bag.
UserInvitation	A user invitation kind.
UserInvitationOutput	A user invitation kind.
UserInvitationProperties	Properties of the user invitation type.
UserInvitationPropertiesOutput	Properties of the user invitation type.

Type Aliases

Artifact	A class for sent share artifact.
ArtifactOutput	A class for sent share artifact.
GetArrayType	Helper type to extract the type of an array
GetPage	The type of a custom function that defines how to get a page and a link to the next one if any.
PaginateReturn	Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
PurviewSharingClient
ReceivedShare	A received share data transfer object.
ReceivedShareOutput	A received share data transfer object.
ReceivedSharesActivateTenantEmailRegistrationParameters
ReceivedSharesCreateOrReplaceParameters
ReceivedSharesDeleteReceivedShareParameters
ReceivedSharesGetAllAttachedReceivedSharesParameters
ReceivedSharesGetAllDetachedReceivedSharesParameters
ReceivedSharesGetReceivedShareParameters
ReceivedSharesRegisterTenantEmailRegistrationParameters
SentShare	A sent share data transfer object.
SentShareInvitation	A sent share invitation data transfer object.
SentShareInvitationOutput	A sent share invitation data transfer object.
SentShareOutput	A sent share data transfer object.
SentSharesCreateOrReplaceParameters
SentSharesCreateSentShareInvitationParameters
SentSharesDeleteSentShareInvitationParameters
SentSharesDeleteSentShareParameters
SentSharesGetAllSentShareInvitationsParameters
SentSharesGetAllSentSharesParameters
SentSharesGetSentShareInvitationParameters
SentSharesGetSentShareParameters
SentSharesNotifyUserSentShareInvitationParameters
Sink	Holds details on the destination of the mapped artifact
SinkOutput	Holds details on the destination of the mapped artifact

Functions

default(string, TokenCredential, ClientOptions)	Initialize a new instance of PurviewSharingClient
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)	Helper function that builds a Poller object to help polling a long running operation.
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)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(string, TokenCredential, ClientOptions)

Initialize a new instance of PurviewSharingClient

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

Parameters

endpoint

string

type: string, The sharing endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share

credentials

TokenCredential

type: TokenCredential, uniquely identify client credential

options

ClientOptions

type: ClientOptions, the parameter for all optional parameters

Returns

PurviewSharingClient

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

Helper function that builds a Poller object to help polling a long running operation.

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

Parameters

client

Client

Client to use for sending the request to get additional pages.

initialResponse

TResult

The initial response.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Options to set a resume state or custom polling interval.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>

• A poller object to poll for operation state updates and eventually get the final response.

isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)

function isUnexpected(response: ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse): response

Parameters

response

ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse

Returns

response

isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)

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

Parameters

response

ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse

Returns

response

isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)

function isUnexpected(response: ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse): response

Parameters

response

ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse

Returns

response

isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)

function isUnexpected(response: ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse): response

Parameters

response

ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse

Returns

response

isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)

function isUnexpected(response: ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse): response

Parameters

response

ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse

Returns

response

isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)

function isUnexpected(response: ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse): response

Parameters

response

ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse

Returns

response

isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)

function isUnexpected(response: ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse): response

Parameters

response

ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse

Returns

response

isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)

function isUnexpected(response: SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse): response

Parameters

response

SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse

Returns

response

isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)

function isUnexpected(response: SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse): response

Parameters

response

SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse

Returns

response

isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)

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

Parameters

response

SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse

Returns

response

isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)

function isUnexpected(response: SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse): response

Parameters

response

SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse

Returns

response

isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)

function isUnexpected(response: SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse): response

Parameters

response

SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse

Returns

response

isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse): response

Parameters

response

SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse

Returns

response

isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse): response

Parameters

response

SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse

Returns

response

isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse): response

Parameters

response

SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse

Returns

response

isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse): response

Parameters

response

SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse

Returns

response

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

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

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

Parameters

client

Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator to iterate the elements