@azure-rest/purview-sharing package
Interfaces
Type-aliassen
| Artifact |
Een klasse voor verzonden shareartefacten. |
| ArtifactOutput |
Een klasse voor verzonden shareartefacten. |
| GetArrayType |
Helpertype voor het extraheren van het type matrix |
| GetPage |
Het type aangepaste functie waarmee wordt gedefinieerd hoe u een pagina en een koppeling naar de volgende krijgt, indien van toepassing. |
| PaginateReturn |
Helpertype voor het afleiden van het type gepaginade elementen van het antwoordtype Dit type wordt gegenereerd op basis van de swagger-informatie voor x-ms-pageable specifiek op de eigenschap itemName die de eigenschap aangeeft van het antwoord waarin de pagina-items worden gevonden. De standaardwaarde is |
| PurviewSharingClient | |
| ReceivedShare |
Een ontvangen object voor gegevensoverdracht delen. |
| ReceivedShareOutput |
Een ontvangen object voor gegevensoverdracht delen. |
| ReceivedSharesActivateTenantEmailRegistrationParameters | |
| ReceivedSharesCreateOrReplaceParameters | |
| ReceivedSharesDeleteReceivedShareParameters | |
| ReceivedSharesGetAllAttachedReceivedSharesParameters | |
| ReceivedSharesGetAllDetachedReceivedSharesParameters | |
| ReceivedSharesGetReceivedShareParameters | |
| ReceivedSharesRegisterTenantEmailRegistrationParameters | |
| SentShare |
Een verzonden sharegegevensoverdrachtobject. |
| SentShareInvitation |
Een verzonden object voor het overdragen van uitnodigingsgegevens. |
| SentShareInvitationOutput |
Een verzonden object voor het overdragen van uitnodigingsgegevens. |
| SentShareOutput |
Een verzonden sharegegevensoverdrachtobject. |
| SentSharesCreateOrReplaceParameters | |
| SentSharesCreateSentShareInvitationParameters | |
| SentSharesDeleteSentShareInvitationParameters | |
| SentSharesDeleteSentShareParameters | |
| SentSharesGetAllSentShareInvitationsParameters | |
| SentSharesGetAllSentSharesParameters | |
| SentSharesGetSentShareInvitationParameters | |
| SentSharesGetSentShareParameters | |
| SentSharesNotifyUserSentShareInvitationParameters | |
| ShareResourcesGetAllShareResourcesParameters | |
| Sink |
Bevat details over het doel van het toegewezen artefact |
| SinkOutput |
Bevat details over het doel van het toegewezen artefact |
Functies
Functiedetails
default(string, TokenCredential, PurviewSharingClientOptions)
Een nieuw exemplaar van PurviewSharingClient initialiseren
function default(endpoint: string, credentials: TokenCredential, options?: PurviewSharingClientOptions): PurviewSharingClient
Parameters
- endpoint
-
string
Het eindpunt voor delen van uw purview-account. Voorbeeld: https://{accountName}.purview.azure.com/share
- credentials
- TokenCredential
clientreferenties uniek identificeren
- options
- PurviewSharingClientOptions
de parameter voor alle optionele parameters
Retouren
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
De Helper-functie waarmee een Poller-object wordt gebouwd om te helpen bij het peilen van een langdurige bewerking.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
Client die moet worden gebruikt voor het verzenden van de aanvraag om extra pagina's op te halen.
- initialResponse
-
TResult
Het eerste antwoord.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opties voor het instellen van een cv-status of aangepast polling-interval.
Retouren
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Een poller-object om te peilen naar updates van bewerkingsstatussen en uiteindelijk het uiteindelijke antwoord op te halen.
isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse): response
Parameters
Retouren
response
isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse): response
Parameters
Retouren
response
isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse): response
Parameters
Retouren
response
isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse): response
Parameters
Retouren
response
isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse): response
Parameters
Retouren
response
isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse): response
Parameters
Retouren
response
isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)
function isUnexpected(response: SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse): response
Parameters
Retouren
response
isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse): response
Parameters
Retouren
response
isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse): response
Parameters
Retouren
response
isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse): response
Parameters
Retouren
response
isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse)
function isUnexpected(response: ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse): response
Parameters
Retouren
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Helper voor het pagineren van resultaten van een eerste antwoord dat volgt op de specificatie van autorest x-ms-pageable-extensie
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parameters
- client
- Client
Client die moet worden gebruikt voor het verzenden van de volgende paginaaanvragen
- initialResponse
-
TResponse
Eerste antwoord met de nextLink en de huidige pagina met elementen
- options
-
PagingOptions<TResponse>
Retouren
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator om de elementen te herhalen