@azure-rest/purview-sharing package
Gränssnitt
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 |
| 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
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<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator för att iterera elementen