@azure-rest/purview-sharing package
Interfejsy
Aliasy typu
| Artifact |
Klasa dla wysłanego artefaktu udziału. |
| ArtifactOutput |
Klasa dla wysłanego artefaktu udziału. |
| GetArrayType |
Typ pomocnika w celu wyodrębnienia typu tablicy |
| GetPage |
Typ funkcji niestandardowej, która definiuje sposób pobierania strony i linku do następnej, jeśli istnieje. |
| PaginateReturn |
Typ pomocnika, aby wywnioskować typ stronicowanych elementów z typu odpowiedzi Ten typ jest generowany na podstawie informacji o programie Swagger dla elementu x-ms-pageable w szczególności na właściwości itemName, która wskazuje właściwość odpowiedzi, w której znaleziono elementy strony. Wartość domyślna to |
| PurviewSharingClient | |
| ReceivedShare |
Odebrany obiekt transferu danych udziału. |
| ReceivedShareOutput |
Odebrany obiekt transferu danych udziału. |
| ReceivedSharesActivateTenantEmailRegistrationParameters | |
| ReceivedSharesCreateOrReplaceParameters | |
| ReceivedSharesDeleteReceivedShareParameters | |
| ReceivedSharesGetAllAttachedReceivedSharesParameters | |
| ReceivedSharesGetAllDetachedReceivedSharesParameters | |
| ReceivedSharesGetReceivedShareParameters | |
| ReceivedSharesRegisterTenantEmailRegistrationParameters | |
| SentShare |
Wysłany obiekt transferu danych współużytkownika. |
| SentShareInvitation |
Obiekt transferu danych zaproszenia do wysłania. |
| SentShareInvitationOutput |
Obiekt transferu danych zaproszenia do wysłania. |
| SentShareOutput |
Wysłany obiekt transferu danych współużytkownika. |
| SentSharesCreateOrReplaceParameters | |
| SentSharesCreateSentShareInvitationParameters | |
| SentSharesDeleteSentShareInvitationParameters | |
| SentSharesDeleteSentShareParameters | |
| SentSharesGetAllSentShareInvitationsParameters | |
| SentSharesGetAllSentSharesParameters | |
| SentSharesGetSentShareInvitationParameters | |
| SentSharesGetSentShareParameters | |
| SentSharesNotifyUserSentShareInvitationParameters | |
| ShareResourcesGetAllShareResourcesParameters | |
| Sink |
Przechowuje szczegóły dotyczące miejsca docelowego zamapowanego artefaktu |
| SinkOutput |
Przechowuje szczegóły dotyczące miejsca docelowego zamapowanego artefaktu |
Funkcje
Szczegóły funkcji
default(string, TokenCredential, PurviewSharingClientOptions)
Inicjowanie nowego wystąpienia PurviewSharingClient
function default(endpoint: string, credentials: TokenCredential, options?: PurviewSharingClientOptions): PurviewSharingClient
Parametry
- endpoint
-
string
Punkt końcowy udostępniania konta usługi purview. Przykład: https://{accountName}.purview.azure.com/share
- credentials
- TokenCredential
unikatowe identyfikowanie poświadczeń klienta
- options
- PurviewSharingClientOptions
parametr dla wszystkich parametrów opcjonalnych
Zwraca
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Funkcja pomocnika, która tworzy obiekt Poller, aby ułatwić sondowanie długotrwałej operacji.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parametry
- client
- Client
Klient do użycia do wysyłania żądania w celu uzyskania dodatkowych stron.
- initialResponse
-
TResult
Początkowa odpowiedź.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opcje ustawiania stanu wznowienia lub niestandardowego interwału sondowania.
Zwraca
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Obiekt poller do sondowania pod kątem aktualizacji stanu operacji i ostatecznie uzyskać ostateczną odpowiedź.
isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)
function isUnexpected(response: SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse): response
Parametry
Zwraca
response
isUnexpected(ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse)
function isUnexpected(response: ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse): response
Parametry
Zwraca
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Pomocnik do stronicowania wyników z początkowej odpowiedzi zgodnej ze specyfikacją rozszerzenia Autorest x-ms-pageable
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parametry
- client
- Client
Klient do użycia do wysyłania żądań następnej strony
- initialResponse
-
TResponse
Początkowa odpowiedź zawierająca element nextLink i bieżącą stronę elementów
- options
-
PagingOptions<TResponse>
Zwraca
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator w celu iterowania elementów