@azure-rest/purview-sharing package

Interfaces

AdlsGen2AccountSink

Receptor de AdlsGen2

AdlsGen2AccountSinkOutput

Receptor de AdlsGen2

AdlsGen2AccountSinkProperties

Propiedades de la cuenta de almacenamiento de AdlsGen2

AdlsGen2AccountSinkPropertiesOutput

Propiedades de la cuenta de almacenamiento de AdlsGen2

AdlsGen2Artifact

Un artefacto de cuenta de almacenamiento de Adls Gen2.

AdlsGen2ArtifactOutput

Un artefacto de cuenta de almacenamiento de Adls Gen2.

AdlsGen2ArtifactProperties

Propiedades de la cuenta de almacenamiento de Adls Gen2.

AdlsGen2ArtifactPropertiesOutput

Propiedades de la cuenta de almacenamiento de Adls Gen2.

ArtifactOutputParent

Clase para el artefacto de recurso compartido enviado.

ArtifactParent

Clase para el artefacto de recurso compartido enviado.

BlobAccountSink

Receptor de blobs

BlobAccountSinkOutput

Receptor de blobs

BlobAccountSinkProperties

Propiedades de la cuenta de Blob Storage

BlobAccountSinkPropertiesOutput

Propiedades de la cuenta de Blob Storage

BlobStorageArtifact

Artefacto de la cuenta de Blob Storage.

BlobStorageArtifactOutput

Artefacto de la cuenta de Blob Storage.

BlobStorageArtifactProperties

Propiedades de la cuenta de Blob Storage.

BlobStorageArtifactPropertiesOutput

Propiedades de la cuenta de Blob Storage.

InPlaceReceivedShare

Tipo de recurso compartido recibido inPlace.

InPlaceReceivedShareOutput

Tipo de recurso compartido recibido inPlace.

InPlaceReceivedShareProperties

Propiedades del recurso compartido recibido en su lugar.

InPlaceReceivedSharePropertiesOutput

Propiedades del recurso compartido recibido en su lugar.

InPlaceSentShare

Tipo de recurso compartido InPlace.

InPlaceSentShareOutput

Tipo de recurso compartido InPlace.

InPlaceSentShareProperties

Propiedades del recurso compartido enviado de InPlace.

InPlaceSentSharePropertiesOutput

Propiedades del recurso compartido enviado de InPlace.

OperationResponseOutput

Respuesta para la operación de larga duración.

PageSettings

Interfaz que realiza un seguimiento de la configuración de la iteración paginada

PagedAsyncIterableIterator

Interfaz que permite la iteración asincrónica tanto a la finalización como a la página.

PagingOptions

Opciones para el asistente de paginación

ProxyResource

Implementación de objetos de transferencia de datos base para recursos proxy.

ProxyResourceOutput

Implementación de objetos de transferencia de datos base para recursos proxy.

PurviewShareErrorInfoOutput

El modelo de cuerpo del error compartido de purview.

PurviewShareErrorOutput

Modelo de error de recurso compartido de purview.

PurviewSharingClientOptions

Parámetros opcionales para el cliente

ReceivedShareListOutput

Lista de recursos compartidos recibidos.

ReceivedShareOutputParent

Objeto de transferencia de datos compartido recibido.

ReceivedShareParent

Objeto de transferencia de datos compartido recibido.

ReceivedSharesActivateTenantEmailRegistration
ReceivedSharesActivateTenantEmailRegistration200Response

Activa el registro de correo electrónico para el inquilino actual.

ReceivedSharesActivateTenantEmailRegistrationBodyParam
ReceivedSharesActivateTenantEmailRegistrationDefaultHeaders
ReceivedSharesActivateTenantEmailRegistrationDefaultResponse

Activa el registro de correo electrónico para el inquilino actual.

ReceivedSharesActivateTenantEmailRegistrationHeaderParam
ReceivedSharesActivateTenantEmailRegistrationHeaders
ReceivedSharesActivateTenantEmailRegistrationMediaTypesParam
ReceivedSharesCreateOrReplace200Headers
ReceivedSharesCreateOrReplace200Response

Actualización de los cambios en un recurso compartido recibido

ReceivedSharesCreateOrReplace201Headers
ReceivedSharesCreateOrReplace201Response

Actualización de los cambios en un recurso compartido recibido

ReceivedSharesCreateOrReplaceBodyParam
ReceivedSharesCreateOrReplaceDefaultHeaders
ReceivedSharesCreateOrReplaceDefaultResponse

Actualización de los cambios en un recurso compartido recibido

ReceivedSharesCreateOrReplaceMediaTypesParam
ReceivedSharesDeleteReceivedShare202Headers
ReceivedSharesDeleteReceivedShare202Response

Eliminación de un recurso compartido recibido

ReceivedSharesDeleteReceivedShareDefaultHeaders
ReceivedSharesDeleteReceivedShareDefaultResponse

Eliminación de un recurso compartido recibido

ReceivedSharesGetAllAttachedReceivedShares
ReceivedSharesGetAllAttachedReceivedShares200Response

Enumerar recursos compartidos recibidos adjuntos

ReceivedSharesGetAllAttachedReceivedSharesDefaultHeaders
ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse

Enumerar recursos compartidos recibidos adjuntos

ReceivedSharesGetAllAttachedReceivedSharesQueryParam
ReceivedSharesGetAllAttachedReceivedSharesQueryParamProperties
ReceivedSharesGetAllDetachedReceivedShares
ReceivedSharesGetAllDetachedReceivedShares200Response

Enumerar recursos compartidos recibidos desasociados

ReceivedSharesGetAllDetachedReceivedSharesDefaultHeaders
ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse

Enumerar recursos compartidos recibidos desasociados

ReceivedSharesGetAllDetachedReceivedSharesQueryParam
ReceivedSharesGetAllDetachedReceivedSharesQueryParamProperties
ReceivedSharesGetReceivedShare
ReceivedSharesGetReceivedShare200Response

Obtener un recurso compartido recibido

ReceivedSharesGetReceivedShareDefaultHeaders
ReceivedSharesGetReceivedShareDefaultResponse

Obtener un recurso compartido recibido

ReceivedSharesRegisterTenantEmailRegistration
ReceivedSharesRegisterTenantEmailRegistration200Response

Registro de un correo electrónico para el inquilino actual

ReceivedSharesRegisterTenantEmailRegistrationDefaultHeaders
ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse

Registro de un correo electrónico para el inquilino actual

ReceivedSharesRegisterTenantEmailRegistrationHeaderParam
ReceivedSharesRegisterTenantEmailRegistrationHeaders
Routes
SentShareInvitationListOutput

Lista de las invitaciones de recursos compartidos enviadas

SentShareInvitationOutputParent

Objeto de transferencia de datos de invitación de recurso compartido enviado.

SentShareInvitationParent

Objeto de transferencia de datos de invitación de recurso compartido enviado.

SentShareListOutput

Lista de recursos compartidos enviados.

SentShareOutputParent

Objeto de transferencia de datos compartido enviado.

SentShareParent

Objeto de transferencia de datos compartido enviado.

SentSharesCreateOrReplace200Headers
SentSharesCreateOrReplace200Response

Crear o reemplazar un recurso compartido enviado

SentSharesCreateOrReplace201Headers
SentSharesCreateOrReplace201Response

Crear o reemplazar un recurso compartido enviado

SentSharesCreateOrReplaceBodyParam
SentSharesCreateOrReplaceDefaultHeaders
SentSharesCreateOrReplaceDefaultResponse

Crear o reemplazar un recurso compartido enviado

SentSharesCreateOrReplaceMediaTypesParam
SentSharesCreateSentShareInvitation201Response

Creación de un destinatario para un recurso compartido enviado determinado

SentSharesCreateSentShareInvitationBodyParam
SentSharesCreateSentShareInvitationDefaultHeaders
SentSharesCreateSentShareInvitationDefaultResponse

Creación de un destinatario para un recurso compartido enviado determinado

SentSharesCreateSentShareInvitationMediaTypesParam
SentSharesDeleteSentShare202Headers
SentSharesDeleteSentShare202Response

Eliminación de un recurso compartido enviado

SentSharesDeleteSentShareDefaultHeaders
SentSharesDeleteSentShareDefaultResponse

Eliminación de un recurso compartido enviado

SentSharesDeleteSentShareInvitation202Headers
SentSharesDeleteSentShareInvitation202Response

Eliminación de una invitación de recurso compartido enviado

SentSharesDeleteSentShareInvitationDefaultHeaders
SentSharesDeleteSentShareInvitationDefaultResponse

Eliminación de una invitación de recurso compartido enviado

SentSharesGetAllSentShareInvitations
SentSharesGetAllSentShareInvitations200Response

Enumerar destinatarios de recursos compartidos enviados

SentSharesGetAllSentShareInvitationsDefaultHeaders
SentSharesGetAllSentShareInvitationsDefaultResponse

Enumerar destinatarios de recursos compartidos enviados

SentSharesGetAllSentShareInvitationsQueryParam
SentSharesGetAllSentShareInvitationsQueryParamProperties
SentSharesGetAllSentShares
SentSharesGetAllSentShares200Response

Enumerar recursos compartidos enviados

SentSharesGetAllSentSharesDefaultHeaders
SentSharesGetAllSentSharesDefaultResponse

Enumerar recursos compartidos enviados

SentSharesGetAllSentSharesQueryParam
SentSharesGetAllSentSharesQueryParamProperties
SentSharesGetSentShare
SentSharesGetSentShare200Response

Obtener un recurso compartido enviado

SentSharesGetSentShareDefaultHeaders
SentSharesGetSentShareDefaultResponse

Obtener un recurso compartido enviado

SentSharesGetSentShareInvitation
SentSharesGetSentShareInvitation200Response

Obtención del destinatario de un recurso compartido enviado determinado

SentSharesGetSentShareInvitationDefaultHeaders
SentSharesGetSentShareInvitationDefaultResponse

Obtención del destinatario de un recurso compartido enviado determinado

SentSharesNotifyUserSentShareInvitation
SentSharesNotifyUserSentShareInvitation200Response

Notifica al destinatario del usuario de la invitación de recurso compartido enviado, no se aplica a las invitaciones de servicio.

SentSharesNotifyUserSentShareInvitationDefaultHeaders
SentSharesNotifyUserSentShareInvitationDefaultResponse

Notifica al destinatario del usuario de la invitación de recurso compartido enviado, no se aplica a las invitaciones de servicio.

SentSharesNotifyUserSentShareInvitationHeaderParam
SentSharesNotifyUserSentShareInvitationHeaders
ServiceInvitation

Tipo de invitación de servicio.

ServiceInvitationOutput

Tipo de invitación de servicio.

ServiceInvitationProperties

Propiedades del tipo de invitación de servicio.

ServiceInvitationPropertiesOutput

Propiedades del tipo de invitación de servicio.

ShareResource

Un recurso compartido.

ShareResourceListOutput

Página de resultados de ShareResource.

ShareResourceOutput

Un recurso compartido.

ShareResourcesGetAllShareResources
ShareResourcesGetAllShareResources200Response

Enumerar recursos compartidos

ShareResourcesGetAllShareResourcesDefaultHeaders
ShareResourcesGetAllShareResourcesDefaultResponse

Enumerar recursos compartidos

ShareResourcesGetAllShareResourcesQueryParam
ShareResourcesGetAllShareResourcesQueryParamProperties
SimplePollerLike

Un sondeo sencillo que se puede usar para sondear una operación de larga duración.

SinkOutputParent

Contiene detalles sobre el destino del artefacto asignado.

SinkParent

Contiene detalles sobre el destino del artefacto asignado.

StorageAccountPath

Define una única ruta de acceso StorageAccountPath.

StorageAccountPathOutput

Define una única ruta de acceso StorageAccountPath.

StoreReference

Referencia de la Tienda para un artefacto o receptor.

StoreReferenceOutput

Referencia de la Tienda para un artefacto o receptor.

TenantEmailRegistration

Objeto de transferencia de datos de registro de correo electrónico de inquilino.

TenantEmailRegistrationOutput

Objeto de transferencia de datos de registro de correo electrónico de inquilino.

TenantEmailRegistrationProperties

Contenedor de propiedades de registro de correo electrónico de inquilino.

TenantEmailRegistrationPropertiesOutput

Contenedor de propiedades de registro de correo electrónico de inquilino.

UserInvitation

Tipo de invitación de usuario.

UserInvitationOutput

Tipo de invitación de usuario.

UserInvitationProperties

Propiedades del tipo de invitación de usuario.

UserInvitationPropertiesOutput

Propiedades del tipo de invitación de usuario.

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 value. Este tipo nos permitirá proporcionar iterador fuertemente tipado en función de la respuesta que obtenemos como segundo parámetro.

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

default(string, TokenCredential, PurviewSharingClientOptions)

Inicialización de una nueva instancia de PurviewSharingClient

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.

isUnexpected(ReceivedSharesGetReceivedShare200Response | ReceivedSharesGetReceivedShareDefaultResponse)
isUnexpected(ReceivedSharesCreateOrReplace200Response | ReceivedSharesCreateOrReplace201Response | ReceivedSharesCreateOrReplaceDefaultResponse)
isUnexpected(ReceivedSharesDeleteReceivedShare202Response | ReceivedSharesDeleteReceivedShareDefaultResponse)
isUnexpected(ReceivedSharesGetAllAttachedReceivedShares200Response | ReceivedSharesGetAllAttachedReceivedSharesDefaultResponse)
isUnexpected(ReceivedSharesGetAllDetachedReceivedShares200Response | ReceivedSharesGetAllDetachedReceivedSharesDefaultResponse)
isUnexpected(ReceivedSharesActivateTenantEmailRegistration200Response | ReceivedSharesActivateTenantEmailRegistrationDefaultResponse)
isUnexpected(ReceivedSharesRegisterTenantEmailRegistration200Response | ReceivedSharesRegisterTenantEmailRegistrationDefaultResponse)
isUnexpected(SentSharesGetAllSentShares200Response | SentSharesGetAllSentSharesDefaultResponse)
isUnexpected(SentSharesGetSentShare200Response | SentSharesGetSentShareDefaultResponse)
isUnexpected(SentSharesCreateOrReplace200Response | SentSharesCreateOrReplace201Response | SentSharesCreateOrReplaceDefaultResponse)
isUnexpected(SentSharesDeleteSentShare202Response | SentSharesDeleteSentShareDefaultResponse)
isUnexpected(SentSharesGetAllSentShareInvitations200Response | SentSharesGetAllSentShareInvitationsDefaultResponse)
isUnexpected(SentSharesGetSentShareInvitation200Response | SentSharesGetSentShareInvitationDefaultResponse)
isUnexpected(SentSharesCreateSentShareInvitation201Response | SentSharesCreateSentShareInvitationDefaultResponse)
isUnexpected(SentSharesDeleteSentShareInvitation202Response | SentSharesDeleteSentShareInvitationDefaultResponse)
isUnexpected(SentSharesNotifyUserSentShareInvitation200Response | SentSharesNotifyUserSentShareInvitationDefaultResponse)
isUnexpected(ShareResourcesGetAllShareResources200Response | ShareResourcesGetAllShareResourcesDefaultResponse)
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

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 para iterar los elementos