@azure-rest/purview-sharing package
Interfaces
Aliases de tipo
| Artifact |
Uma classe para o artefato de compartilhamento enviado. |
| ArtifactOutput |
Uma classe para o artefato de compartilhamento enviado. |
| GetArrayType |
Tipo auxiliar para extrair o tipo de uma matriz |
| GetPage |
O tipo de uma função personalizada que define como obter uma página e um link para a próxima, se houver. |
| PaginateReturn |
Tipo auxiliar para inferir o tipo dos elementos de página do tipo de resposta Esse tipo é gerado com base nas informações de swagger para x-ms-pageable especificamente na propriedade itemName que indica a propriedade da resposta em que os itens de página são encontrados. O valor padrão é |
| PurviewSharingClient | |
| ReceivedShare |
Um objeto de transferência de dados de compartilhamento recebido. |
| ReceivedShareOutput |
Um objeto de transferência de dados de compartilhamento recebido. |
| ReceivedSharesActivateTenantEmailRegistrationParameters | |
| ReceivedSharesCreateOrReplaceParameters | |
| ReceivedSharesDeleteReceivedShareParameters | |
| ReceivedSharesGetAllAttachedReceivedSharesParameters | |
| ReceivedSharesGetAllDetachedReceivedSharesParameters | |
| ReceivedSharesGetReceivedShareParameters | |
| ReceivedSharesRegisterTenantEmailRegistrationParameters | |
| SentShare |
Um objeto de transferência de dados de compartilhamento enviado. |
| SentShareInvitation |
Um objeto de transferência de dados de convite de compartilhamento enviado. |
| SentShareInvitationOutput |
Um objeto de transferência de dados de convite de compartilhamento enviado. |
| SentShareOutput |
Um objeto de transferência de dados de compartilhamento enviado. |
| SentSharesCreateOrReplaceParameters | |
| SentSharesCreateSentShareInvitationParameters | |
| SentSharesDeleteSentShareInvitationParameters | |
| SentSharesDeleteSentShareParameters | |
| SentSharesGetAllSentShareInvitationsParameters | |
| SentSharesGetAllSentSharesParameters | |
| SentSharesGetSentShareInvitationParameters | |
| SentSharesGetSentShareParameters | |
| SentSharesNotifyUserSentShareInvitationParameters | |
| ShareResourcesGetAllShareResourcesParameters | |
| Sink |
Contém detalhes sobre o destino do artefato mapeado |
| SinkOutput |
Contém detalhes sobre o destino do artefato mapeado |
Funções
Detalhes da função
default(string, TokenCredential, PurviewSharingClientOptions)
Inicializar uma nova instância de PurviewSharingClient
function default(endpoint: string, credentials: TokenCredential, options?: PurviewSharingClientOptions): PurviewSharingClient
Parâmetros
- endpoint
-
string
O ponto de extremidade de compartilhamento da sua conta do Purview. Exemplo: https://{accountName}.purview.azure.com/share
- credentials
- TokenCredential
identificar exclusivamente a credencial do cliente
- options
- PurviewSharingClientOptions
o parâmetro para todos os parâmetros opcionais
Retornos
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Função auxiliar que cria um objeto Poller para ajudar a sondar uma operação de execução longa.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parâmetros
- client
- Client
Cliente a ser usado para enviar a solicitação para obter páginas adicionais.
- initialResponse
-
TResult
A resposta inicial.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opções para definir um estado de retomada ou um intervalo de sondagem personalizado.
Retornos
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Um objeto poller para sondar atualizações de estado de operação e, eventualmente, obter a resposta final.
isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)
function isUnexpected(response: SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse): response
Parâmetros
Retornos
response
isUnexpected(ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse)
function isUnexpected(response: ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse): response
Parâmetros
Retornos
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Auxiliar para paginar resultados de uma resposta inicial que segue a especificação da extensão de x-ms-pageable Autorest
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parâmetros
- client
- Client
Cliente a ser usado para enviar as solicitações da próxima página
- initialResponse
-
TResponse
Resposta inicial que contém o nextLink e a página atual dos elementos
- options
-
PagingOptions<TResponse>
Retornos
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator para iterar os elementos