ResourceGraphClient class

Pacote:

@azure/arm-resourcegraph

Extends

ResourceGraphClientContext

Construtores

ResourceGraphClient(ServiceClientCredentials | TokenCredential, ResourceGraphClientOptions)

Inicializa uma nova instância da classe ResourceGraphClient.

Propriedades

operations

Propriedades herdadas

acceptLanguage
credentials
longRunningOperationRetryTimeout	O tempo limite de repetição em segundos para Operações de Execução Longa. O valor padrão é 30.

Métodos

resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase)	Obter detalhes de alteração de recurso.
resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeData[]>)
resourceChangeDetails(ResourceChangeDetailsRequestParameters, ServiceCallback<ResourceChangeData[]>)
resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase)	Listar alterações em um recurso para um determinado intervalo de tempo.
resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeList>)
resourceChanges(ResourceChangesRequestParameters, ServiceCallback<ResourceChangeList>)
resources(QueryRequest, RequestOptionsBase)	Consulta os recursos gerenciados pelo Azure Resource Manager para escopos especificados na solicitação.
resources(QueryRequest, RequestOptionsBase, ServiceCallback<QueryResponse>)
resources(QueryRequest, ServiceCallback<QueryResponse>)
resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase)	Liste todos os instantâneos de um recurso para um determinado intervalo de tempo.
resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase, ServiceCallback<any>)
resourcesHistory(ResourcesHistoryRequest, ServiceCallback<any>)

Métodos herdados

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)	Envie a solicitação inicial de um LRO (operação de execução prolongada) e retorne um HttpLongRunningOperationResponse que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.
restoreLROPoller(LROPollState)	Restaure um LROPoller do LROPollState fornecido. Esse método pode ser usado para recriar um LROPoller em um processo ou computador diferente.
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)	Fornece um mecanismo para fazer uma solicitação que sondará e fornecerá o resultado final.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Envie a solicitação inicial de um LRO (operação de execução prolongada) e retorne um LROPoller que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.
sendRequest(RequestPrepareOptions | WebResourceLike)	Envie o httpRequest fornecido.

Detalhes do construtor

ResourceGraphClient(ServiceClientCredentials | TokenCredential, ResourceGraphClientOptions)

Inicializa uma nova instância da classe ResourceGraphClient.

new ResourceGraphClient(credentials: ServiceClientCredentials | TokenCredential, options?: ResourceGraphClientOptions)

Parâmetros

credentials

ServiceClientCredentials | TokenCredential

Credenciais necessárias para que o cliente se conecte ao Azure. As credenciais que implementam a interface TokenCredential do @azure/identity pacote são recomendadas. Para obter mais informações sobre essas credenciais, consulte https://www.npmjs.com/package/@azure/identity. As credenciais que implementam a interface ServiceClientCredentials dos pacotes @azure/ms-rest-nodeauth mais antigos e @azure/ms-rest-browserauth também têm suporte.

options

ResourceGraphClientOptions

As opções de parâmetro

Detalhes da propriedade

operations

operations: Operations

Valor da propriedade

Operations

Detalhes das propriedades herdadas

acceptLanguage

acceptLanguage: string

Valor da propriedade

string

Herdado deResourceGraphClientContext.acceptLanguage

credentials

credentials: ServiceClientCredentials | TokenCredential

Valor da propriedade

ServiceClientCredentials | TokenCredential

Herdado deResourceGraphClientContext.credentials

longRunningOperationRetryTimeout

O tempo limite de repetição em segundos para Operações de Execução Longa. O valor padrão é 30.

longRunningOperationRetryTimeout?: number

Valor da propriedade

number

Herdado deResourceGraphClientContext.longRunningOperationRetryTimeout

Detalhes do método

resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase)

Obter detalhes de alteração de recurso.

function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, options?: RequestOptionsBase): Promise<ResourceChangeDetailsResponse>

Parâmetros

parameters

ResourceChangeDetailsRequestParameters

Os parâmetros dessa solicitação para detalhes de alteração de recurso.

options

RequestOptionsBase

Os parâmetros opcionais

Retornos

Promise<ResourceChangeDetailsResponse>

Modelos de Promessa.ResourceChangeDetailsResponse<>

resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeData[]>)

function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, options: RequestOptionsBase, callback: ServiceCallback<ResourceChangeData[]>)

Parâmetros

parameters

ResourceChangeDetailsRequestParameters

Os parâmetros dessa solicitação para detalhes de alteração de recurso.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<ResourceChangeData[]>

O retorno de chamada

resourceChangeDetails(ResourceChangeDetailsRequestParameters, ServiceCallback<ResourceChangeData[]>)

function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, callback: ServiceCallback<ResourceChangeData[]>)

Parâmetros

parameters

ResourceChangeDetailsRequestParameters

Os parâmetros dessa solicitação para detalhes de alteração de recurso.

callback

ServiceCallback<ResourceChangeData[]>

O retorno de chamada

resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase)

Listar alterações em um recurso para um determinado intervalo de tempo.

function resourceChanges(parameters: ResourceChangesRequestParameters, options?: RequestOptionsBase): Promise<ResourceChangesResponse>

Parâmetros

parameters

ResourceChangesRequestParameters

os parâmetros dessa solicitação para alterações.

options

RequestOptionsBase

Os parâmetros opcionais

Retornos

Promise<ResourceChangesResponse>

Modelos de Promessa.ResourceChangesResponse<>

resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeList>)

function resourceChanges(parameters: ResourceChangesRequestParameters, options: RequestOptionsBase, callback: ServiceCallback<ResourceChangeList>)

Parâmetros

parameters

ResourceChangesRequestParameters

os parâmetros dessa solicitação para alterações.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<ResourceChangeList>

O retorno de chamada

resourceChanges(ResourceChangesRequestParameters, ServiceCallback<ResourceChangeList>)

function resourceChanges(parameters: ResourceChangesRequestParameters, callback: ServiceCallback<ResourceChangeList>)

Parâmetros

parameters

ResourceChangesRequestParameters

os parâmetros dessa solicitação para alterações.

callback

ServiceCallback<ResourceChangeList>

O retorno de chamada

resources(QueryRequest, RequestOptionsBase)

Consulta os recursos gerenciados pelo Azure Resource Manager para escopos especificados na solicitação.

function resources(query: QueryRequest, options?: RequestOptionsBase): Promise<ResourcesResponse>

Parâmetros

query

QueryRequest

Solicitação especificando a consulta e suas opções.

options

RequestOptionsBase

Os parâmetros opcionais

Retornos

Promise<ResourcesResponse>

Modelos de Promessa.ResourcesResponse<>

resources(QueryRequest, RequestOptionsBase, ServiceCallback<QueryResponse>)

function resources(query: QueryRequest, options: RequestOptionsBase, callback: ServiceCallback<QueryResponse>)

Parâmetros

query

QueryRequest

Solicitação especificando a consulta e suas opções.

options

RequestOptionsBase

Os parâmetros opcionais

callback

ServiceCallback<QueryResponse>

O retorno de chamada

resources(QueryRequest, ServiceCallback<QueryResponse>)

function resources(query: QueryRequest, callback: ServiceCallback<QueryResponse>)

Parâmetros

query

QueryRequest

Solicitação especificando a consulta e suas opções.

callback

ServiceCallback<QueryResponse>

O retorno de chamada

resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase)

Liste todos os instantâneos de um recurso para um determinado intervalo de tempo.

function resourcesHistory(request: ResourcesHistoryRequest, options?: RequestOptionsBase): Promise<ResourcesHistoryResponse>

Parâmetros

request

ResourcesHistoryRequest

options

RequestOptionsBase

Os parâmetros opcionais

Retornos

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

Os parâmetros opcionais

callback

ServiceCallback<any>

O retorno de chamada

resourcesHistory(ResourcesHistoryRequest, ServiceCallback<any>)

function resourcesHistory(request: ResourcesHistoryRequest, callback: ServiceCallback<any>)

Parâmetros

request

ResourcesHistoryRequest

callback

ServiceCallback<any>

O retorno de chamada

Detalhes do método herdado

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Envie a solicitação inicial de um LRO (operação de execução prolongada) e retorne um HttpLongRunningOperationResponse que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.

function beginLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<LROPoller>

Parâmetros

request

RequestPrepareOptions | WebResource

O objeto de solicitação

options

RequestOptionsBase

Opções adicionais a serem enviadas ao fazer a solicitação

Retornos

Promise<@azure/ms-rest-azure-js.LROPoller>

O HttpLongRunningOperationResponse que fornece métodos para interagir com o LRO.

Herdado deResourceGraphClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Restaure um LROPoller do LROPollState fornecido. Esse método pode ser usado para recriar um LROPoller em um processo ou computador diferente.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Parâmetros

lroPollState

@azure/ms-rest-azure-js.LROPollState

Retornos

@azure/ms-rest-azure-js.LROPoller

Herdado deResourceGraphClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Fornece um mecanismo para fazer uma solicitação que sondará e fornecerá o resultado final.

function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<HttpOperationResponse>

Parâmetros

request

RequestPrepareOptions | WebResource

O objeto de solicitação

options

RequestOptionsBase

Opções adicionais a serem enviadas ao fazer a solicitação

Retornos

Promise<HttpOperationResponse>

O HttpOperationResponse que contém a solicitação de sondagem final, a resposta e o responseBody.

Herdado deResourceGraphClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Envie a solicitação inicial de um LRO (operação de execução prolongada) e retorne um LROPoller que fornece métodos para sondar o LRO e verificar se o LRO foi concluído.

function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>

Parâmetros

operationArguments

OperationArguments

Os argumentos para a operação.

operationSpec

OperationSpec

A especificação da operação.

options

RequestOptionsBase

Opções adicionais a serem enviadas ao fazer a solicitação.

Retornos

Promise<@azure/ms-rest-azure-js.LROPoller>

O objeto LROPoller que fornece métodos para interagir com o LRO.

Herdado deResourceGraphClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

Parâmetros

operationArguments

OperationArguments

Os argumentos dos quais os valores de modelo da solicitação HTTP serão preenchidos.

operationSpec

OperationSpec

O OperationSpec a ser usado para preencher o httpRequest.

callback

ServiceCallback<any>

O retorno de chamada a ser chamado quando a resposta é recebida.

Retornos

Promise<RestResponse>

Herdado deResourceGraphClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Envie o httpRequest fornecido.

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

Parâmetros

options

RequestPrepareOptions | WebResourceLike

Retornos

Promise<HttpOperationResponse>

Herdado deResourceGraphClientContext.sendRequest