ResourceGraphClient class
- Extends
Конструкторы
| Resource |
Инициализирует новый экземпляр класса ResourceGraphClient. |
Свойства
| operations |
Унаследованные свойства
| accept |
|
| credentials | |
| long |
Время ожидания повтора в секундах для длительных операций. Значение по умолчанию — 30. |
Методы
Наследуемые методы
| begin |
Отправьте первоначальный запрос LRO (длительной операции) и верните httpLongRunningOperationResponse, который предоставляет методы для опроса LRO и проверки завершения LRO. |
| restore |
Восстановите LROPoller из предоставленного LROPollState. Этот метод можно использовать для повторного создания LROPoller на другом процессе или компьютере. |
| send |
Предоставляет механизм для выполнения запроса, который будет опрашивать и предоставлять окончательный результат. |
| send |
Отправьте первоначальный запрос LRO (долго выполняющейся операции) и верните LROPoller, который предоставляет методы для опроса LRO и проверки завершения LRO. |
| send |
Отправьте HTTP-запрос, заполненный с помощью предоставленной операцииSpec. |
| send |
Отправьте предоставленный httpRequest. |
Сведения о конструкторе
ResourceGraphClient(ServiceClientCredentials | TokenCredential, ResourceGraphClientOptions)
Инициализирует новый экземпляр класса ResourceGraphClient.
new ResourceGraphClient(credentials: ServiceClientCredentials | TokenCredential, options?: ResourceGraphClientOptions)Параметры
- credentials
Учетные данные, необходимые для подключения клиента к Azure. Учетные данные, реализующие интерфейс TokenCredential из пакета @azure/identity, рекомендуется. Дополнительные сведения об этих учетных данных см. в https://www.npmjs.com/package/@azure/identity. Учетные данные, реализующие интерфейс ServiceClientCredentials из старых пакетов @azure/ms-rest-nodeauth и @azure/ms-rest-browserauth, также поддерживаются.
- options
- ResourceGraphClientOptions
Параметры параметра
Сведения о свойстве
operations
Сведения об унаследованном свойстве
acceptLanguage
acceptLanguage: stringЗначение свойства
string
наследуется отResourceGraphClientContext.acceptLanguage
credentials
credentials: 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>
Обещание<Models.ResourceChangeDetailsResponse>
resourceChangeDetails(ResourceChangeDetailsRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeData[]>)
function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, options: RequestOptionsBase, callback: ServiceCallback<ResourceChangeData[]>)Параметры
- parameters
- ResourceChangeDetailsRequestParameters
Параметры этого запроса для сведений об изменении ресурса.
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
resourceChangeDetails(ResourceChangeDetailsRequestParameters, ServiceCallback<ResourceChangeData[]>)
function resourceChangeDetails(parameters: ResourceChangeDetailsRequestParameters, callback: ServiceCallback<ResourceChangeData[]>)Параметры
- parameters
- ResourceChangeDetailsRequestParameters
Параметры этого запроса для сведений об изменении ресурса.
- callback
Обратный вызов
resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase)
Вывод списка изменений в ресурс для заданного интервала времени.
function resourceChanges(parameters: ResourceChangesRequestParameters, options?: RequestOptionsBase): Promise<ResourceChangesResponse>Параметры
- parameters
- ResourceChangesRequestParameters
Параметры этого запроса для изменений.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<ResourceChangesResponse>
Обещание<Models.ResourceChangesResponse>
resourceChanges(ResourceChangesRequestParameters, RequestOptionsBase, ServiceCallback<ResourceChangeList>)
function resourceChanges(parameters: ResourceChangesRequestParameters, options: RequestOptionsBase, callback: ServiceCallback<ResourceChangeList>)Параметры
- parameters
- ResourceChangesRequestParameters
Параметры этого запроса для изменений.
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
resourceChanges(ResourceChangesRequestParameters, ServiceCallback<ResourceChangeList>)
function resourceChanges(parameters: ResourceChangesRequestParameters, callback: ServiceCallback<ResourceChangeList>)Параметры
- parameters
- ResourceChangesRequestParameters
Параметры этого запроса для изменений.
- callback
Обратный вызов
resources(QueryRequest, RequestOptionsBase)
Запрашивает ресурсы, управляемые Azure Resource Manager, для областей, указанных в запросе.
function resources(query: QueryRequest, options?: RequestOptionsBase): Promise<ResourcesResponse>Параметры
- query
- QueryRequest
Запрос, указывающий запрос и его параметры.
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<ResourcesResponse>
Обещание<Models.ResourcesResponse>
resources(QueryRequest, RequestOptionsBase, ServiceCallback<QueryResponse>)
function resources(query: QueryRequest, options: RequestOptionsBase, callback: ServiceCallback<QueryResponse>)Параметры
- query
- QueryRequest
Запрос, указывающий запрос и его параметры.
- options
- RequestOptionsBase
Необязательные параметры
- callback
Обратный вызов
resources(QueryRequest, ServiceCallback<QueryResponse>)
function resources(query: QueryRequest, callback: ServiceCallback<QueryResponse>)Параметры
- query
- QueryRequest
Запрос, указывающий запрос и его параметры.
- callback
Обратный вызов
resourcesHistory(ResourcesHistoryRequest, RequestOptionsBase)
Список всех моментальных снимков ресурса для заданного интервала времени.
function resourcesHistory(request: ResourcesHistoryRequest, options?: RequestOptionsBase): Promise<ResourcesHistoryResponse>Параметры
- request
- ResourcesHistoryRequest
- options
- RequestOptionsBase
Необязательные параметры
Возвращаемое значение
Promise<ResourcesHistoryResponse>
Обещание<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
Объект запроса
- 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
Возвращаемое значение
унаследован отResourceGraphClientContext.restoreLROPoller
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)
Предоставляет механизм для выполнения запроса, который будет опрашивать и предоставлять окончательный результат.
function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<HttpOperationResponse>Параметры
- request
Объект запроса
- options
- RequestOptionsBase
Дополнительные параметры для отправки при выполнении запроса
Возвращаемое значение
Promise<HttpOperationResponse>
HttpOperationResponse, содержащий окончательный запрос опроса, ответ и ответ.
унаследован от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-запрос, заполненный с помощью предоставленной операцииSpec.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>Параметры
- operationArguments
- OperationArguments
Аргументы, из которыми будут заполнены шаблонные значения HTTP-запроса.
- operationSpec
- OperationSpec
ОперацияSpec, используемая для заполнения httpRequest.
- callback
-
ServiceCallback<any>
Обратный вызов при получении ответа.
Возвращаемое значение
Promise<RestResponse>
наследуется отResourceGraphClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Отправьте предоставленный httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Параметры
- options
Возвращаемое значение
Promise<HttpOperationResponse>
наследуется отResourceGraphClientContext.sendRequest