ResourceGraphClient class

Пакет:

@azure/arm-resourcegraph

Extends

ResourceGraphClientContext

Конструкторы

ResourceGraphClient(ServiceClientCredentials | TokenCredential, ResourceGraphClientOptions)

Инициализирует новый экземпляр класса ResourceGraphClient.

Свойства

operations

Унаследованные свойства

acceptLanguage
credentials
longRunningOperationRetryTimeout	Время ожидания повторных попыток в секундах для длительных операций. Значение по умолчанию — 30.

Методы

resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase)	Получение сведений об изменении ресурса.
resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeData[]>)
resourceChangeDetails(ResourceChangeDetailsRequestParameters, ServiceCallback<ResourceChangeData[]>)
resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase)	Вывод списка изменений ресурса за заданный интервал времени.
resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeList>)
resourceChanges(ResourceChangesRequestParameters, ServiceCallback<ResourceChangeList>)
resources(QueryRequest, RequestOptionsBase)	Запрашивает ресурсы, управляемые Resource Manager Azure, для областей, указанных в запросе.
resources(QueryRequest, RequestOptionsBase, ServiceCallback<QueryResponse>)
resources(QueryRequest, ServiceCallback<QueryResponse>)
resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase)	Вывод списка всех моментальных снимков ресурса за заданный интервал времени.
resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase, ServiceCallback<any>)
resourcesHistory(ResourcesHistoryRequest, ServiceCallback<any>)

Наследуемые методы

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)	Отправьте первоначальный запрос LRO (длительная операция) и получите httpLongRunningOperationResponse, который предоставляет методы для опроса LRO и проверки завершения LRO.
restoreLROPoller(LROPollState)	Восстановите LROPoller из предоставленного LROPollState. Этот метод можно использовать для повторного создания LROPoller на другом процессе или компьютере.
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)	Предоставляет механизм для выполнения запроса, который будет опрашивать и предоставлять окончательный результат.
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	Отправьте первоначальный запрос LRO (длительная операция) и получите LROPoller, который предоставляет методы для опроса LRO и проверки завершения LRO.
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	Отправьте HTTP-запрос, который заполняется с помощью предоставленного OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)	Отправка предоставленного httpRequest.

Сведения о конструкторе

ResourceGraphClient(ServiceClientCredentials | TokenCredential, ResourceGraphClientOptions)

Инициализирует новый экземпляр класса ResourceGraphClient.

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

Параметры

credentials

ServiceClientCredentials | TokenCredential

Учетные данные, необходимые клиенту для подключения к Azure. Рекомендуется использовать учетные данные, реализующие интерфейс TokenCredential из @azure/identity пакета. Дополнительные сведения об этих учетных данных см. в разделе https://www.npmjs.com/package/@azure/identity. Учетные данные, реализующие интерфейс ServiceClientCredentials из старых пакетов @azure/ms-rest-nodeauth , также @azure/ms-rest-browserauth поддерживаются.

options

ResourceGraphClientOptions

Параметры параметра

Сведения о свойстве

operations

operations: Operations

Значение свойства

Operations

Сведения об унаследованном свойстве

acceptLanguage

acceptLanguage: string

Значение свойства

string

Наследуется отResourceGraphClientContext.acceptLanguage

credentials

credentials: ServiceClientCredentials | TokenCredential

Значение свойства

ServiceClientCredentials | TokenCredential

Наследуется отResourceGraphClientContext.credentials

longRunningOperationRetryTimeout

Время ожидания повторных попыток в секундах для длительных операций. Значение по умолчанию — 30.

longRunningOperationRetryTimeout?: number

Значение свойства

number

Наследуется отResourceGraphClientContext.longRunningOperationRetryTimeout

Сведения о методе

resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase)

Получение сведений об изменении ресурса.

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

Параметры

parameters

ResourceChangeDetailsRequestParameters

Параметры для этого запроса для сведений об изменении ресурса.

options

RequestOptionsBase

Необязательные параметры

Возвращаемое значение

Promise<ResourceChangeDetailsResponse>

Promise<Models.ResourceChangeDetailsResponse>

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

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

Параметры

parameters

ResourceChangeDetailsRequestParameters

Параметры для этого запроса для сведений об изменении ресурса.

options

RequestOptionsBase

Необязательные параметры

callback

ServiceCallback<ResourceChangeData[]>

Обратный вызов

resourceChangeDetails(ResourceChangeDetailsRequestParameters, ServiceCallback<ResourceChangeData[]>)

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

Параметры

parameters

ResourceChangeDetailsRequestParameters

Параметры для этого запроса для сведений об изменении ресурса.

callback

ServiceCallback<ResourceChangeData[]>

Обратный вызов

resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase)

Вывод списка изменений ресурса за заданный интервал времени.

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

Параметры

parameters

ResourceChangesRequestParameters

параметры для этого запроса на изменения.

options

RequestOptionsBase

Необязательные параметры

Возвращаемое значение

Promise<ResourceChangesResponse>

Promise<Models.ResourceChangesResponse>

resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeList>)

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

Параметры

parameters

ResourceChangesRequestParameters

параметры для этого запроса на изменения.

options

RequestOptionsBase

Необязательные параметры

callback

ServiceCallback<ResourceChangeList>

Обратный вызов

resourceChanges(ResourceChangesRequestParameters, ServiceCallback<ResourceChangeList>)

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

Параметры

parameters

ResourceChangesRequestParameters

параметры для этого запроса на изменения.

callback

ServiceCallback<ResourceChangeList>

Обратный вызов

resources(QueryRequest, RequestOptionsBase)

Запрашивает ресурсы, управляемые Resource Manager Azure, для областей, указанных в запросе.

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

Параметры

query

QueryRequest

Запрос с указанием запроса и его параметров.

options

RequestOptionsBase

Необязательные параметры

Возвращаемое значение

Promise<ResourcesResponse>

Promise<Models.ResourcesResponse>

resources(QueryRequest, RequestOptionsBase, ServiceCallback<QueryResponse>)

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

Параметры

query

QueryRequest

Запрос с указанием запроса и его параметров.

options

RequestOptionsBase

Необязательные параметры

callback

ServiceCallback<QueryResponse>

Обратный вызов

resources(QueryRequest, ServiceCallback<QueryResponse>)

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

Параметры

query

QueryRequest

Запрос с указанием запроса и его параметров.

callback

ServiceCallback<QueryResponse>

Обратный вызов

resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase)

Вывод списка всех моментальных снимков ресурса за заданный интервал времени.

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

Параметры

request

ResourcesHistoryRequest

options

RequestOptionsBase

Необязательные параметры

Возвращаемое значение

Promise<ResourcesHistoryResponse>

Promise<Models.ResourcesHistoryResponse>

resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase, ServiceCallback<any>)

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

Параметры

request

ResourcesHistoryRequest

options

RequestOptionsBase

Необязательные параметры

callback

ServiceCallback<any>

Обратный вызов

resourcesHistory(ResourcesHistoryRequest, ServiceCallback<any>)

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

Параметры

request

ResourcesHistoryRequest

callback

ServiceCallback<any>

Обратный вызов

Сведения о наследуемом методе

beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Отправьте первоначальный запрос LRO (длительная операция) и получите httpLongRunningOperationResponse, который предоставляет методы для опроса LRO и проверки завершения LRO.

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

Параметры

request

RequestPrepareOptions | WebResource

Объект запроса

options

RequestOptionsBase

Дополнительные параметры для отправки при выполнении запроса

Возвращаемое значение

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

HttpLongRunningOperationResponse, предоставляющий методы для взаимодействия с LRO.

Наследуется отResourceGraphClientContext.beginLongRunningRequest

restoreLROPoller(LROPollState)

Восстановите LROPoller из предоставленного LROPollState. Этот метод можно использовать для повторного создания LROPoller на другом процессе или компьютере.

function restoreLROPoller(lroPollState: LROPollState): LROPoller

Параметры

lroPollState

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

Возвращаемое значение

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

Наследуется отResourceGraphClientContext.restoreLROPoller

sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)

Предоставляет механизм для выполнения запроса, который будет опрашивать и предоставлять окончательный результат.

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

Параметры

request

RequestPrepareOptions | WebResource

Объект запроса

options

RequestOptionsBase

Дополнительные параметры для отправки при выполнении запроса

Возвращаемое значение

Promise<HttpOperationResponse>

HttpOperationResponse, содержащий окончательный запрос опроса, ответ и responseBody.

Наследуется отResourceGraphClientContext.sendLongRunningRequest

sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)

Отправьте первоначальный запрос LRO (длительная операция) и получите LROPoller, который предоставляет методы для опроса LRO и проверки завершения LRO.

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

Параметры

operationArguments

OperationArguments

Аргументы операции.

operationSpec

OperationSpec

Спецификация операции.

options

RequestOptionsBase

Дополнительные параметры для отправки при выполнении запроса.

Возвращаемое значение

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

Объект LROPoller, предоставляющий методы для взаимодействия с LRO.

Наследуется отResourceGraphClientContext.sendLRORequest

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Отправьте HTTP-запрос, который заполняется с помощью предоставленного OperationSpec.

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

Параметры

operationArguments

OperationArguments

Аргументы, из которым будут заполнены шаблонные значения HTTP-запроса.

operationSpec

OperationSpec

OperationSpec, используемый для заполнения httpRequest.

callback

ServiceCallback<any>

Обратный вызов при получении ответа.

Возвращаемое значение

Promise<RestResponse>

Наследуется отResourceGraphClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Отправка предоставленного httpRequest.

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

Параметры

options

RequestPrepareOptions | WebResourceLike

Возвращаемое значение

Promise<HttpOperationResponse>

Наследуется отResourceGraphClientContext.sendRequest