Dela via


@azure-rest/purview-sharing package

Gränssnitt

AdlsGen2AccountSink

AdlsGen2-mottagare

AdlsGen2AccountSinkOutput

AdlsGen2-mottagare

AdlsGen2AccountSinkProperties

Egenskaper för AdlsGen2-lagringskonto

AdlsGen2AccountSinkPropertiesOutput

Egenskaper för AdlsGen2-lagringskonto

AdlsGen2Artifact

En Adls Gen2-lagringskontoartefakt.

AdlsGen2ArtifactOutput

En Adls Gen2-lagringskontoartefakt.

AdlsGen2ArtifactProperties

Egenskaper för Adls Gen2-lagringskonto.

AdlsGen2ArtifactPropertiesOutput

Egenskaper för Adls Gen2-lagringskonto.

ArtifactOutputParent

En klass för skickad resursartefakt.

ArtifactParent

En klass för skickad resursartefakt.

BlobAccountSink

Blob-mottagare

BlobAccountSinkOutput

Blob-mottagare

BlobAccountSinkProperties

Egenskaper för bloblagringskonto

BlobAccountSinkPropertiesOutput

Egenskaper för bloblagringskonto

BlobStorageArtifact

Blob Storage-kontoartefakt.

BlobStorageArtifactOutput

Blob Storage-kontoartefakt.

BlobStorageArtifactProperties

Egenskaper för bloblagringskonto.

BlobStorageArtifactPropertiesOutput

Egenskaper för bloblagringskonto.

InPlaceReceivedShare

En InPlace-mottagen resurstyp.

InPlaceReceivedShareOutput

En InPlace-mottagen resurstyp.

InPlaceReceivedShareProperties

Egenskaper för på plats mottagen resurs.

InPlaceReceivedSharePropertiesOutput

Egenskaper för på plats mottagen resurs.

InPlaceSentShare

En InPlace-resurstyp.

InPlaceSentShareOutput

En InPlace-resurstyp.

InPlaceSentShareProperties

Egenskaper för InPlace-skickad resurs.

InPlaceSentSharePropertiesOutput

Egenskaper för InPlace-skickad resurs.

OperationResponseOutput

Svar för tidskrävande åtgärd.

PageSettings

Ett gränssnitt som spårar inställningarna för sidsidig iteration

PagedAsyncIterableIterator

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.

PagingOptions

Alternativ för växlingshjälpen

ProxyResource

Grundläggande implementering av dataöverföringsobjekt för proxyresurser.

ProxyResourceOutput

Grundläggande implementering av dataöverföringsobjekt för proxyresurser.

PurviewShareErrorInfoOutput

Purview-resursens feltextmodell.

PurviewShareErrorOutput

Felmodellen för purview-resurs.

PurviewSharingClientOptions

Valfria parametrar för klienten

ReceivedShareListOutput

Lista över mottagna resurser.

ReceivedShareOutputParent

Ett mottaget resursdataöverföringsobjekt.

ReceivedShareParent

Ett mottaget resursdataöverföringsobjekt.

ReceivedSharesActivateTenantEmailRegistration
ReceivedSharesActivateTenantEmailRegistration200Response

Aktiverar e-postregistreringen för den aktuella klientorganisationen

ReceivedSharesActivateTenantEmailRegistrationBodyParam
ReceivedSharesActivateTenantEmailRegistrationDefaultHeaders
ReceivedSharesActivateTenantEmailRegistrationDefaultResponse

Aktiverar e-postregistreringen för den aktuella klientorganisationen

ReceivedSharesActivateTenantEmailRegistrationHeaderParam
ReceivedSharesActivateTenantEmailRegistrationHeaders
ReceivedSharesActivateTenantEmailRegistrationMediaTypesParam
ReceivedSharesCreateOrReplace200Headers
ReceivedSharesCreateOrReplace200Response

Uppdatera ändringar i en mottagen resurs

ReceivedSharesCreateOrReplace201Headers
ReceivedSharesCreateOrReplace201Response

Uppdatera ändringar i en mottagen resurs

ReceivedSharesCreateOrReplaceBodyParam
ReceivedSharesCreateOrReplaceDefaultHeaders
ReceivedSharesCreateOrReplaceDefaultResponse

Uppdatera ändringar i en mottagen resurs

ReceivedSharesCreateOrReplaceMediaTypesParam
ReceivedSharesDeleteReceivedShare202Headers
ReceivedSharesDeleteReceivedShare202Response

Ta bort en mottagen resurs

ReceivedSharesDeleteReceivedShareDefaultHeaders
ReceivedSharesDeleteReceivedShareDefaultResponse

Ta bort en mottagen resurs

ReceivedSharesGetAllAttachedReceivedShares
ReceivedSharesGetAllAttachedReceivedShares200Response

Lista över bifogade mottagna resurser

ReceivedSharesGetAllAttachedReceivedSharesDefaultHeaders
ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse

Lista över bifogade mottagna resurser

ReceivedSharesGetAllAttachedReceivedSharesQueryParam
ReceivedSharesGetAllAttachedReceivedSharesQueryParamProperties
ReceivedSharesGetAllDetachedReceivedShares
ReceivedSharesGetAllDetachedReceivedShares200Response

Lista frånkopplade mottagna resurser

ReceivedSharesGetAllDetachedReceivedSharesDefaultHeaders
ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse

Lista frånkopplade mottagna resurser

ReceivedSharesGetAllDetachedReceivedSharesQueryParam
ReceivedSharesGetAllDetachedReceivedSharesQueryParamProperties
ReceivedSharesGetReceivedShare
ReceivedSharesGetReceivedShare200Response

Hämta en mottagen resurs

ReceivedSharesGetReceivedShareDefaultHeaders
ReceivedSharesGetReceivedShareDefaultResponse

Hämta en mottagen resurs

ReceivedSharesRegisterTenantEmailRegistration
ReceivedSharesRegisterTenantEmailRegistration200Response

Registrera ett e-postmeddelande för den aktuella klientorganisationen

ReceivedSharesRegisterTenantEmailRegistrationDefaultHeaders
ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse

Registrera ett e-postmeddelande för den aktuella klientorganisationen

ReceivedSharesRegisterTenantEmailRegistrationHeaderParam
ReceivedSharesRegisterTenantEmailRegistrationHeaders
Routes
SentShareInvitationListOutput

Lista över skickade resursinbjudningar

SentShareInvitationOutputParent

Ett dataöverföringsobjekt för skickad delningsinbjudan.

SentShareInvitationParent

Ett dataöverföringsobjekt för skickad delningsinbjudan.

SentShareListOutput

Lista över skickade resurser.

SentShareOutputParent

Ett skickat resursdataöverföringsobjekt.

SentShareParent

Ett skickat resursdataöverföringsobjekt.

SentSharesCreateOrReplace200Headers
SentSharesCreateOrReplace200Response

Skapa eller ersätta en skickad resurs

SentSharesCreateOrReplace201Headers
SentSharesCreateOrReplace201Response

Skapa eller ersätta en skickad resurs

SentSharesCreateOrReplaceBodyParam
SentSharesCreateOrReplaceDefaultHeaders
SentSharesCreateOrReplaceDefaultResponse

Skapa eller ersätta en skickad resurs

SentSharesCreateOrReplaceMediaTypesParam
SentSharesCreateSentShareInvitation201Response

Skapa en mottagare för en viss skickad resurs

SentSharesCreateSentShareInvitationBodyParam
SentSharesCreateSentShareInvitationDefaultHeaders
SentSharesCreateSentShareInvitationDefaultResponse

Skapa en mottagare för en viss skickad resurs

SentSharesCreateSentShareInvitationMediaTypesParam
SentSharesDeleteSentShare202Headers
SentSharesDeleteSentShare202Response

Ta bort en skickad resurs

SentSharesDeleteSentShareDefaultHeaders
SentSharesDeleteSentShareDefaultResponse

Ta bort en skickad resurs

SentSharesDeleteSentShareInvitation202Headers
SentSharesDeleteSentShareInvitation202Response

Ta bort en skickad resursinbjudan

SentSharesDeleteSentShareInvitationDefaultHeaders
SentSharesDeleteSentShareInvitationDefaultResponse

Ta bort en skickad resursinbjudan

SentSharesGetAllSentShareInvitations
SentSharesGetAllSentShareInvitations200Response

Lista över skickade resursmottagare

SentSharesGetAllSentShareInvitationsDefaultHeaders
SentSharesGetAllSentShareInvitationsDefaultResponse

Lista över skickade resursmottagare

SentSharesGetAllSentShareInvitationsQueryParam
SentSharesGetAllSentShareInvitationsQueryParamProperties
SentSharesGetAllSentShares
SentSharesGetAllSentShares200Response

Lista över skickade resurser

SentSharesGetAllSentSharesDefaultHeaders
SentSharesGetAllSentSharesDefaultResponse

Lista över skickade resurser

SentSharesGetAllSentSharesQueryParam
SentSharesGetAllSentSharesQueryParamProperties
SentSharesGetSentShare
SentSharesGetSentShare200Response

Hämta en skickad resurs

SentSharesGetSentShareDefaultHeaders
SentSharesGetSentShareDefaultResponse

Hämta en skickad resurs

SentSharesGetSentShareInvitation
SentSharesGetSentShareInvitation200Response

Hämta mottagare för en viss skickad resurs

SentSharesGetSentShareInvitationDefaultHeaders
SentSharesGetSentShareInvitationDefaultResponse

Hämta mottagare för en viss skickad resurs

SentSharesNotifyUserSentShareInvitation
SentSharesNotifyUserSentShareInvitation200Response

Meddelar användarens mottagare av den skickade resursinbjudan, gäller inte för tjänstinbjudningar.

SentSharesNotifyUserSentShareInvitationDefaultHeaders
SentSharesNotifyUserSentShareInvitationDefaultResponse

Meddelar användarens mottagare av den skickade resursinbjudan, gäller inte för tjänstinbjudningar.

SentSharesNotifyUserSentShareInvitationHeaderParam
SentSharesNotifyUserSentShareInvitationHeaders
ServiceInvitation

En typ av tjänstinbjudan.

ServiceInvitationOutput

En typ av tjänstinbjudan.

ServiceInvitationProperties

Egenskaper för tjänstinbjudan.

ServiceInvitationPropertiesOutput

Egenskaper för tjänstinbjudan.

ShareResource

En resursresurs.

ShareResourceListOutput

En sida med ShareResource-resultat.

ShareResourceOutput

En resursresurs.

ShareResourcesGetAllShareResources
ShareResourcesGetAllShareResources200Response

Visa en lista över resursresurser

ShareResourcesGetAllShareResourcesDefaultHeaders
ShareResourcesGetAllShareResourcesDefaultResponse

Visa en lista över resursresurser

ShareResourcesGetAllShareResourcesQueryParam
ShareResourcesGetAllShareResourcesQueryParamProperties
SimplePollerLike

En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd.

SinkOutputParent

Innehåller information om målet för den mappade artefakten

SinkParent

Innehåller information om målet för den mappade artefakten

StorageAccountPath

Definierar en enda StorageAccountPath-sökväg

StorageAccountPathOutput

Definierar en enda StorageAccountPath-sökväg

StoreReference

En lagringsreferens för en artefakt eller mottagare.

StoreReferenceOutput

En lagringsreferens för en artefakt eller mottagare.

TenantEmailRegistration

Ett dataöverföringsobjekt för e-postregistrering för klientorganisation.

TenantEmailRegistrationOutput

Ett dataöverföringsobjekt för e-postregistrering för klientorganisation.

TenantEmailRegistrationProperties

Egenskapsväska för e-postregistrering för klientorganisation.

TenantEmailRegistrationPropertiesOutput

Egenskapsväska för e-postregistrering för klientorganisation.

UserInvitation

En typ av användarinbjudan.

UserInvitationOutput

En typ av användarinbjudan.

UserInvitationProperties

Egenskaper för användarinbjudan.

UserInvitationPropertiesOutput

Egenskaper för användarinbjudan.

Typalias

Artifact

En klass för skickad resursartefakt.

ArtifactOutput

En klass för skickad resursartefakt.

GetArrayType

Hjälptyp för att extrahera typen av en matris

GetPage

Typen av en anpassad funktion som definierar hur du hämtar en sida och en länk till nästa om någon.

PaginateReturn

Hjälptyp för att härleda typen av sidelement från svarstypen Den här typen genereras baserat på swagger-informationen för x-ms-pageable specifikt på egenskapen itemName som anger egenskapen för svaret där sidobjekten hittas. Standardvärdet är value. Med den här typen kan vi ange en starkt typbaserad iterator baserat på svaret vi får som andra parameter

PurviewSharingClient
ReceivedShare

Ett mottaget resursdataöverföringsobjekt.

ReceivedShareOutput

Ett mottaget resursdataöverföringsobjekt.

ReceivedSharesActivateTenantEmailRegistrationParameters
ReceivedSharesCreateOrReplaceParameters
ReceivedSharesDeleteReceivedShareParameters
ReceivedSharesGetAllAttachedReceivedSharesParameters
ReceivedSharesGetAllDetachedReceivedSharesParameters
ReceivedSharesGetReceivedShareParameters
ReceivedSharesRegisterTenantEmailRegistrationParameters
SentShare

Ett skickat resursdataöverföringsobjekt.

SentShareInvitation

Ett dataöverföringsobjekt för skickad delningsinbjudan.

SentShareInvitationOutput

Ett dataöverföringsobjekt för skickad delningsinbjudan.

SentShareOutput

Ett skickat resursdataöverföringsobjekt.

SentSharesCreateOrReplaceParameters
SentSharesCreateSentShareInvitationParameters
SentSharesDeleteSentShareInvitationParameters
SentSharesDeleteSentShareParameters
SentSharesGetAllSentShareInvitationsParameters
SentSharesGetAllSentSharesParameters
SentSharesGetSentShareInvitationParameters
SentSharesGetSentShareParameters
SentSharesNotifyUserSentShareInvitationParameters
ShareResourcesGetAllShareResourcesParameters
Sink

Innehåller information om målet för den mappade artefakten

SinkOutput

Innehåller information om målet för den mappade artefakten

Funktioner

default(string, TokenCredential, PurviewSharingClientOptions)

Initiera en ny instans av PurviewSharingClient

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

Hjälpfunktionen som skapar ett Poller-objekt för att avsöka en tidskrävande åtgärd.

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>)

Hjälp för att paginate resultat från ett första svar som följer specifikationen för Autorest x-ms-pageable tillägg

Funktionsinformation

default(string, TokenCredential, PurviewSharingClientOptions)

Initiera en ny instans av PurviewSharingClient

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

Parametrar

endpoint

string

Delningsslutpunkten för ditt purview-konto. Exempel: https://{accountName}.purview.azure.com/share

credentials
TokenCredential

unikt identifiera klientautentiseringsuppgifter

options
PurviewSharingClientOptions

parametern för alla valfria parametrar

Returer

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

Hjälpfunktionen som skapar ett Poller-objekt för att avsöka en tidskrävande åtgärd.

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

Parametrar

client
Client

Klienten som ska användas för att skicka begäran för att hämta ytterligare sidor.

initialResponse

TResult

Det första svaret.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Alternativ för att ange ett cv-tillstånd eller anpassat avsökningsintervall.

Returer

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

  • Ett pollerobjekt som ska avsökas efter åtgärdstillståndsuppdateringar och slutligen få det slutliga svaret.

isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)

function isUnexpected(response: ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse): response

Parametrar

Returer

response

isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)

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

Parametrar

Returer

response

isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)

function isUnexpected(response: ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse): response

Parametrar

Returer

response

isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)

function isUnexpected(response: ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse): response

Parametrar

Returer

response

isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)

function isUnexpected(response: ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse): response

Parametrar

Returer

response

isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)

function isUnexpected(response: ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse): response

Parametrar

Returer

response

isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)

function isUnexpected(response: ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse): response

Parametrar

Returer

response

isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)

function isUnexpected(response: SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse): response

Parametrar

Returer

response

isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)

function isUnexpected(response: SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse): response

Parametrar

Returer

response

isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)

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

Parametrar

Returer

response

isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)

function isUnexpected(response: SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse): response

Parametrar

Returer

response

isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)

function isUnexpected(response: SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse): response

Parametrar

Returer

response

isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse): response

Parametrar

Returer

response

isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse): response

Parametrar

Returer

response

isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse): response

Parametrar

Returer

response

isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)

function isUnexpected(response: SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse): response

Parametrar

Returer

response

isUnexpected(ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse)

function isUnexpected(response: ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse): response

Parametrar

Returer

response

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

Hjälp för att paginate resultat från ett första svar som följer specifikationen för Autorest x-ms-pageable tillägg

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

Parametrar

client
Client

Klienten som ska användas för att skicka nästa sidbegäranden

initialResponse

TResponse

Första svaret som innehåller nästaLänk och aktuell sida med element

options

PagingOptions<TResponse>

Returer

  • PagedAsyncIterableIterator för att iterera elementen