ResourceGraphClient class
- Extends
Constructores
Resource |
Inicializa una nueva instancia de la clase ResourceGraphClient. |
Propiedades
operations |
Propiedades heredadas
accept |
|
credentials | |
long |
Tiempo de espera de reintento en segundos para las operaciones de larga duración. El valor predeterminado es 30. |
Métodos
Métodos heredados
begin |
Envíe la solicitud inicial de un LRO (operación de larga duración) y obtenga una httpLongRunningOperationResponse que proporciona métodos para sondear el LRO y comprobar si el LRO ha finalizado. |
restore |
Restaure un LROPoller desde el LROPollState proporcionado. Este método se puede usar para volver a crear un LROPoller en un proceso o máquina diferente. |
send |
Proporciona un mecanismo para realizar una solicitud que sondeará y proporcionará el resultado final. |
send |
Envíe la solicitud inicial de un LRO (operación de larga duración) y obtenga un LROPoller que proporciona métodos para sondear el LRO y comprobar si el LRO ha finalizado. |
send |
Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada. |
send |
Envíe el httpRequest proporcionado. |
Detalles del constructor
ResourceGraphClient(ServiceClientCredentials | TokenCredential, ResourceGraphClientOptions)
Inicializa una nueva instancia de la clase ResourceGraphClient.
new ResourceGraphClient(credentials: ServiceClientCredentials | TokenCredential, options?: ResourceGraphClientOptions)
Parámetros
- credentials
Credenciales necesarias para que el cliente se conecte a Azure. Se recomiendan las credenciales que implementan la interfaz TokenCredential desde el @azure/identity paquete. Para obtener más información sobre estas credenciales, vea https://www.npmjs.com/package/@azure/identity. Las credenciales que implementan la interfaz ServiceClientCredentials de los paquetes @azure/ms-rest-nodeauth anteriores y @azure/ms-rest-browserauth también se admiten.
- options
- ResourceGraphClientOptions
Las opciones de parámetro
Detalles de las propiedades
operations
Detalles de las propiedades heredadas
acceptLanguage
acceptLanguage: string
Valor de propiedad
string
Heredado deResourceGraphClientContext.acceptLanguage
credentials
credentials: ServiceClientCredentials | TokenCredential
Valor de propiedad
Heredado deResourceGraphClientContext.credentials
longRunningOperationRetryTimeout
Tiempo de espera de reintento en segundos para las operaciones de larga duración. El valor predeterminado es 30.
longRunningOperationRetryTimeout?: number
Valor de propiedad
number
Heredado deResourceGraphClientContext.longRunningOperationRetryTimeout
Detalles del método
resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase)
Obtenga los detalles del cambio de recursos.
function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, options?: RequestOptionsBase): Promise<ResourceChangeDetailsResponse>
Parámetros
- parameters
- ResourceChangeDetailsRequestParameters
Los parámetros de esta solicitud para los detalles del cambio de recursos.
- options
- RequestOptionsBase
Los parámetros opcionales
Devoluciones
Promise<ResourceChangeDetailsResponse>
Promise<Models.ResourceChangeDetailsResponse>
resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeData[]>)
function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, options: RequestOptionsBase, callback: ServiceCallback<ResourceChangeData[]>)
Parámetros
- parameters
- ResourceChangeDetailsRequestParameters
Los parámetros de esta solicitud para los detalles del cambio de recursos.
- options
- RequestOptionsBase
Los parámetros opcionales
- callback
La devolución de llamada
resourceChangeDetails(ResourceChangeDetailsRequestParameters, ServiceCallback<ResourceChangeData[]>)
function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, callback: ServiceCallback<ResourceChangeData[]>)
Parámetros
- parameters
- ResourceChangeDetailsRequestParameters
Los parámetros de esta solicitud para los detalles del cambio de recursos.
- callback
La devolución de llamada
resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase)
Enumera los cambios en un recurso para un intervalo de tiempo determinado.
function resourceChanges(parameters: ResourceChangesRequestParameters, options?: RequestOptionsBase): Promise<ResourceChangesResponse>
Parámetros
- parameters
- ResourceChangesRequestParameters
los parámetros de esta solicitud de cambios.
- options
- RequestOptionsBase
Los parámetros opcionales
Devoluciones
Promise<ResourceChangesResponse>
Promise<Models.ResourceChangesResponse>
resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeList>)
function resourceChanges(parameters: ResourceChangesRequestParameters, options: RequestOptionsBase, callback: ServiceCallback<ResourceChangeList>)
Parámetros
- parameters
- ResourceChangesRequestParameters
los parámetros de esta solicitud de cambios.
- options
- RequestOptionsBase
Los parámetros opcionales
- callback
La devolución de llamada
resourceChanges(ResourceChangesRequestParameters, ServiceCallback<ResourceChangeList>)
function resourceChanges(parameters: ResourceChangesRequestParameters, callback: ServiceCallback<ResourceChangeList>)
Parámetros
- parameters
- ResourceChangesRequestParameters
los parámetros de esta solicitud de cambios.
- callback
La devolución de llamada
resources(QueryRequest, RequestOptionsBase)
Consulta los recursos administrados por Azure Resource Manager para los ámbitos especificados en la solicitud.
function resources(query: QueryRequest, options?: RequestOptionsBase): Promise<ResourcesResponse>
Parámetros
- query
- QueryRequest
Solicitud que especifica la consulta y sus opciones.
- options
- RequestOptionsBase
Los parámetros opcionales
Devoluciones
Promise<ResourcesResponse>
Promise<Models.ResourcesResponse>
resources(QueryRequest, RequestOptionsBase, ServiceCallback<QueryResponse>)
function resources(query: QueryRequest, options: RequestOptionsBase, callback: ServiceCallback<QueryResponse>)
Parámetros
- query
- QueryRequest
Solicitud que especifica la consulta y sus opciones.
- options
- RequestOptionsBase
Los parámetros opcionales
- callback
La devolución de llamada
resources(QueryRequest, ServiceCallback<QueryResponse>)
function resources(query: QueryRequest, callback: ServiceCallback<QueryResponse>)
Parámetros
- query
- QueryRequest
Solicitud que especifica la consulta y sus opciones.
- callback
La devolución de llamada
resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase)
Enumera todas las instantáneas de un recurso para un intervalo de tiempo determinado.
function resourcesHistory(request: ResourcesHistoryRequest, options?: RequestOptionsBase): Promise<ResourcesHistoryResponse>
Parámetros
- request
- ResourcesHistoryRequest
- options
- RequestOptionsBase
Los parámetros opcionales
Devoluciones
Promise<ResourcesHistoryResponse>
Promise<Models.ResourcesHistoryResponse>
resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase, ServiceCallback<any>)
function resourcesHistory(request: ResourcesHistoryRequest, options: RequestOptionsBase, callback: ServiceCallback<any>)
Parámetros
- request
- ResourcesHistoryRequest
- options
- RequestOptionsBase
Los parámetros opcionales
- callback
-
ServiceCallback<any>
La devolución de llamada
resourcesHistory(ResourcesHistoryRequest, ServiceCallback<any>)
function resourcesHistory(request: ResourcesHistoryRequest, callback: ServiceCallback<any>)
Parámetros
- request
- ResourcesHistoryRequest
- callback
-
ServiceCallback<any>
La devolución de llamada
Detalles de los métodos heredados
beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)
Envíe la solicitud inicial de un LRO (operación de larga duración) y obtenga una httpLongRunningOperationResponse que proporciona métodos para sondear el LRO y comprobar si el LRO ha finalizado.
function beginLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<LROPoller>
Parámetros
- request
El objeto de solicitud
- options
- RequestOptionsBase
Opciones adicionales que se enviarán al realizar la solicitud
Devoluciones
Promise<@azure/ms-rest-azure-js.LROPoller>
HttpLongRunningOperationResponse que proporciona métodos para interactuar con el LRO.
Heredado deResourceGraphClientContext.beginLongRunningRequest
restoreLROPoller(LROPollState)
Restaure un LROPoller desde el LROPollState proporcionado. Este método se puede usar para volver a crear un LROPoller en un proceso o máquina diferente.
function restoreLROPoller(lroPollState: LROPollState): LROPoller
Parámetros
- lroPollState
- @azure/ms-rest-azure-js.LROPollState
Devoluciones
Heredado deResourceGraphClientContext.restoreLROPoller
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)
Proporciona un mecanismo para realizar una solicitud que sondeará y proporcionará el resultado final.
function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<HttpOperationResponse>
Parámetros
- request
El objeto de solicitud
- options
- RequestOptionsBase
Opciones adicionales que se enviarán al realizar la solicitud
Devoluciones
Promise<HttpOperationResponse>
HttpOperationResponse que contiene la solicitud de sondeo final, la respuesta y la respuestaBody.
Heredado deResourceGraphClientContext.sendLongRunningRequest
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)
Envíe la solicitud inicial de un LRO (operación de larga duración) y obtenga un LROPoller que proporciona métodos para sondear el LRO y comprobar si el LRO ha finalizado.
function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>
Parámetros
- operationArguments
- OperationArguments
Argumentos de la operación.
- operationSpec
- OperationSpec
Especificación de la operación.
- options
- RequestOptionsBase
Opciones adicionales que se enviarán al realizar la solicitud.
Devoluciones
Promise<@azure/ms-rest-azure-js.LROPoller>
Objeto LROPoller que proporciona métodos para interactuar con el LRO.
Heredado deResourceGraphClientContext.sendLRORequest
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>
Parámetros
- operationArguments
- OperationArguments
Argumentos de los que se rellenarán los valores con plantilla de la solicitud HTTP.
- operationSpec
- OperationSpec
OperationSpec que se va a usar para rellenar httpRequest.
- callback
-
ServiceCallback<any>
Devolución de llamada que se va a llamar cuando se recibe la respuesta.
Devoluciones
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
Envíe el httpRequest proporcionado.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>
Parámetros
- options
Devoluciones
Promise<HttpOperationResponse>
Heredado deResourceGraphClientContext.sendRequest