@azure-rest/purview-sharing package
Interfacce
Alias tipo
Artifact |
Classe per l'artefatto di condivisione inviato. |
ArtifactOutput |
Classe per l'artefatto di condivisione inviato. |
GetArrayType |
Tipo di helper per estrarre il tipo di una matrice |
GetPage |
Tipo di una funzione personalizzata che definisce come ottenere una pagina e un collegamento a quello successivo, se presente. |
PaginateReturn |
Tipo di helper per dedurre il tipo di elementi di paging dal tipo di risposta Questo tipo viene generato in base alle informazioni swagger per x-ms-pageable specificamente nella proprietà itemName che indica la proprietà della risposta in cui vengono trovati gli elementi della pagina. Il valore predefinito è |
PurviewSharingClient | |
ReceivedShare |
Oggetto di trasferimento dati condiviso ricevuto. |
ReceivedShareOutput |
Oggetto di trasferimento dati condiviso ricevuto. |
ReceivedSharesActivateTenantEmailRegistrationParameters | |
ReceivedSharesCreateOrReplaceParameters | |
ReceivedSharesDeleteReceivedShareParameters | |
ReceivedSharesGetAllAttachedReceivedSharesParameters | |
ReceivedSharesGetAllDetachedReceivedSharesParameters | |
ReceivedSharesGetReceivedShareParameters | |
ReceivedSharesRegisterTenantEmailRegistrationParameters | |
SentShare |
Oggetto di trasferimento dati di condivisione inviato. |
SentShareInvitation |
Oggetto di trasferimento dati di invito di condivisione inviato. |
SentShareInvitationOutput |
Oggetto di trasferimento dati di invito di condivisione inviato. |
SentShareOutput |
Oggetto di trasferimento dati di condivisione inviato. |
SentSharesCreateOrReplaceParameters | |
SentSharesCreateSentShareInvitationParameters | |
SentSharesDeleteSentShareInvitationParameters | |
SentSharesDeleteSentShareParameters | |
SentSharesGetAllSentShareInvitationsParameters | |
SentSharesGetAllSentSharesParameters | |
SentSharesGetSentShareInvitationParameters | |
SentSharesGetSentShareParameters | |
SentSharesNotifyUserSentShareInvitationParameters | |
Sink |
Contiene i dettagli sulla destinazione dell'artefatto mappato |
SinkOutput |
Contiene i dettagli sulla destinazione dell'artefatto mappato |
Funzioni
Dettagli funzione
default(string, TokenCredential, ClientOptions)
Inizializzare una nuova istanza di PurviewSharingClient
function default(endpoint: string, credentials: TokenCredential, options?: ClientOptions): PurviewSharingClient
Parametri
- endpoint
-
string
type: string, Endpoint di condivisione dell'account purview. Esempio: https://{accountName}.purview.azure.com/share
- credentials
- TokenCredential
type: TokenCredential, identificare in modo univoco le credenziali client
- options
- ClientOptions
type: ClientOptions, il parametro per tutti i parametri facoltativi
Restituisce
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Funzione helper che compila un oggetto Poller per consentire il polling di un'operazione a esecuzione prolungata.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parametri
- client
- Client
Client da usare per inviare la richiesta per ottenere pagine aggiuntive.
- initialResponse
-
TResult
Risposta iniziale.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opzioni per impostare uno stato di ripresa o un intervallo di polling personalizzato.
Restituisce
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
- Oggetto poller per eseguire il polling degli aggiornamenti dello stato dell'operazione e infine ottenere la risposta finale.
isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)
function isUnexpected(response: SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse): response
Parametri
Restituisce
response
isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse): response
Parametri
Restituisce
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Helper per impaginare i risultati da una risposta iniziale che segue la specifica dell'estensione autorest x-ms-pageable
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parametri
- client
- Client
Client da usare per l'invio delle richieste di pagina successiva
- initialResponse
-
TResponse
Risposta iniziale contenente il nextLink e la pagina corrente degli elementi
- options
-
PagingOptions<TResponse>
Restituisce
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator per scorrere gli elementi
Azure SDK for JavaScript