@azure-rest/purview-sharing package
Interfaces
Alias de tipos
| Artifact |
Clase para el artefacto de recurso compartido enviado. |
| ArtifactOutput |
Clase para el artefacto de recurso compartido enviado. |
| GetArrayType |
Tipo auxiliar para extraer el tipo de una matriz |
| GetPage |
Tipo de una función personalizada que define cómo obtener una página y un vínculo al siguiente si existe. |
| PaginateReturn |
Tipo auxiliar para deducir el tipo de los elementos paginados del tipo de respuesta Este tipo se genera en función de la información de swagger para x-ms-pageable específicamente en la propiedad itemName, que indica la propiedad de la respuesta donde se encuentran los elementos de página. El valor predeterminado es |
| PurviewSharingClient | |
| ReceivedShare |
Objeto de transferencia de datos compartido recibido. |
| ReceivedShareOutput |
Objeto de transferencia de datos compartido recibido. |
| ReceivedSharesActivateTenantEmailRegistrationParameters | |
| ReceivedSharesCreateOrReplaceParameters | |
| ReceivedSharesDeleteReceivedShareParameters | |
| ReceivedSharesGetAllAttachedReceivedSharesParameters | |
| ReceivedSharesGetAllDetachedReceivedSharesParameters | |
| ReceivedSharesGetReceivedShareParameters | |
| ReceivedSharesRegisterTenantEmailRegistrationParameters | |
| SentShare |
Objeto de transferencia de datos compartido enviado. |
| SentShareInvitation |
Objeto de transferencia de datos de invitación de recurso compartido enviado. |
| SentShareInvitationOutput |
Objeto de transferencia de datos de invitación de recurso compartido enviado. |
| SentShareOutput |
Objeto de transferencia de datos compartido enviado. |
| SentSharesCreateOrReplaceParameters | |
| SentSharesCreateSentShareInvitationParameters | |
| SentSharesDeleteSentShareInvitationParameters | |
| SentSharesDeleteSentShareParameters | |
| SentSharesGetAllSentShareInvitationsParameters | |
| SentSharesGetAllSentSharesParameters | |
| SentSharesGetSentShareInvitationParameters | |
| SentSharesGetSentShareParameters | |
| SentSharesNotifyUserSentShareInvitationParameters | |
| ShareResourcesGetAllShareResourcesParameters | |
| Sink |
Contiene detalles sobre el destino del artefacto asignado. |
| SinkOutput |
Contiene detalles sobre el destino del artefacto asignado. |
Funciones
Detalles de la función
default(string, TokenCredential, PurviewSharingClientOptions)
Inicialización de una nueva instancia de PurviewSharingClient
function default(endpoint: string, credentials: TokenCredential, options?: PurviewSharingClientOptions): PurviewSharingClient
Parámetros
- endpoint
-
string
Punto de conexión de uso compartido de la cuenta de purview. Ejemplo: https://{accountName}.purview.azure.com/share
- credentials
- TokenCredential
identificar de forma única las credenciales de cliente
- options
- PurviewSharingClientOptions
el parámetro para todos los parámetros opcionales
Devoluciones
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Función auxiliar que compila un objeto Poller para ayudar a sondear una operación de larga duración.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parámetros
- client
- Client
Cliente que se va a usar para enviar la solicitud para obtener páginas adicionales.
- initialResponse
-
TResult
Respuesta inicial.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opciones para establecer un estado de reanudación o un intervalo de sondeo personalizado.
Devoluciones
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Objeto de sondeo para sondear las actualizaciones de estado de la operación y, finalmente, obtener la respuesta final.
isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)
function isUnexpected(response: ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)
function isUnexpected(response: ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)
function isUnexpected(response: ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)
function isUnexpected(response: SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)
function isUnexpected(response: SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)
function isUnexpected(response: SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)
function isUnexpected(response: SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse): response
Parámetros
Devoluciones
response
isUnexpected(ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse)
function isUnexpected(response: ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse): response
Parámetros
Devoluciones
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Asistente para paginar los resultados de una respuesta inicial que sigue la especificación de Autorest x-ms-pageable extensión
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parámetros
- client
- Client
Cliente que se va a usar para enviar las solicitudes de página siguiente
- initialResponse
-
TResponse
Respuesta inicial que contiene la página nextLink y actual de los elementos
- options
-
PagingOptions<TResponse>
Devoluciones
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator para iterar los elementos