@azure-rest/purview-sharing package
Rozhraní
Aliasy typu
| Artifact |
Třída pro odeslaný artefakt sdílené složky. |
| ArtifactOutput |
Třída pro odeslaný artefakt sdílené složky. |
| GetArrayType |
Pomocný typ pro extrahování typu pole |
| GetPage |
Typ vlastní funkce, která definuje, jak získat stránku, a odkaz na další, pokud existuje. |
| PaginateReturn |
Pomocný typ pro odvození typu stránkovaných prvků z typu odpovědi Tento typ je generován na základě informací swagger pro x-ms-pageable konkrétně na itemName vlastnost, která označuje vlastnost odpovědi, kde jsou nalezeny položky stránky. Výchozí hodnota je |
| PurviewSharingClient | |
| ReceivedShare |
Přijatý objekt přenosu dat sdílené složky. |
| ReceivedShareOutput |
Přijatý objekt přenosu dat sdílené složky. |
| ReceivedSharesActivateTenantEmailRegistrationParameters | |
| ReceivedSharesCreateOrReplaceParameters | |
| ReceivedSharesDeleteReceivedShareParameters | |
| ReceivedSharesGetAllAttachedReceivedSharesParameters | |
| ReceivedSharesGetAllDetachedReceivedSharesParameters | |
| ReceivedSharesGetReceivedShareParameters | |
| ReceivedSharesRegisterTenantEmailRegistrationParameters | |
| SentShare |
Odeslaný objekt pro přenos dat sdílené složky. |
| SentShareInvitation |
Odeslaný objekt přenosu dat pozvánky ke sdílené složce |
| SentShareInvitationOutput |
Odeslaný objekt přenosu dat pozvánky ke sdílené složce |
| SentShareOutput |
Odeslaný objekt pro přenos dat sdílené složky. |
| SentSharesCreateOrReplaceParameters | |
| SentSharesCreateSentShareInvitationParameters | |
| SentSharesDeleteSentShareInvitationParameters | |
| SentSharesDeleteSentShareParameters | |
| SentSharesGetAllSentShareInvitationsParameters | |
| SentSharesGetAllSentSharesParameters | |
| SentSharesGetSentShareInvitationParameters | |
| SentSharesGetSentShareParameters | |
| SentSharesNotifyUserSentShareInvitationParameters | |
| ShareResourcesGetAllShareResourcesParameters | |
| Sink |
Uchovává podrobnosti o cíli mapovaného artefaktu. |
| SinkOutput |
Uchovává podrobnosti o cíli mapovaného artefaktu. |
Funkce
Podrobnosti funkce
default(string, TokenCredential, PurviewSharingClientOptions)
Inicializace nové instance PurviewSharingClient
function default(endpoint: string, credentials: TokenCredential, options?: PurviewSharingClientOptions): PurviewSharingClient
Parametry
- endpoint
-
string
Koncový bod sdílení vašeho účtu Purview. Příklad: https://{accountName}.purview.azure.com/share
- credentials
- TokenCredential
jedinečně identifikovat přihlašovací údaje klienta
- options
- PurviewSharingClientOptions
parametr pro všechny volitelné parametry
Návraty
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Pomocná funkce, která vytvoří objekt Poller, který pomáhá dotazovat dlouho běžící operaci.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parametry
- client
- Client
Klient, který se má použít k odeslání požadavku, aby získal další stránky.
- initialResponse
-
TResult
Počáteční odpověď.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Možnosti nastavení stavu obnovení nebo vlastního intervalu dotazování
Návraty
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Objekt poller, který se má dotazovat na aktualizace stavu operace, a nakonec získat konečnou odpověď.
isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse): response
Parametry
Návraty
response
isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse): response
Parametry
Návraty
response
isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse): response
Parametry
Návraty
response
isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse): response
Parametry
Návraty
response
isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse): response
Parametry
Návraty
response
isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse): response
Parametry
Návraty
response
isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)
function isUnexpected(response: SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse): response
Parametry
Návraty
response
isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse): response
Parametry
Návraty
response
isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse): response
Parametry
Návraty
response
isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse): response
Parametry
Návraty
response
isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse): response
Parametry
Návraty
response
isUnexpected(ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse)
function isUnexpected(response: ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse): response
Parametry
Návraty
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Pomocná rutina stránkovat výsledky z počáteční odpovědi, která odpovídá specifikaci rozšíření Automatické x-ms-pageable
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parametry
- client
- Client
Klient, který se má použít k odesílání žádostí na další stránku
- initialResponse
-
TResponse
Počáteční odpověď obsahující nextLink a aktuální stránku prvků
- options
-
PagingOptions<TResponse>
Návraty
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator pro iteraci prvků