你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
ResourceGraphClient class
- Extends
构造函数
Resource |
初始化 ResourceGraphClient 类的新实例。 |
属性
operations |
继承属性
accept |
|
credentials | |
long |
长时间运行的操作的重试超时(以秒为单位)。 默认值为 30。 |
方法
继承的方法
begin |
) 发送 LRO (长时间运行的操作的初始请求,并取回 HttpLongRunningOperationResponse,该请求提供轮询 LRO 和检查 LRO 是否已完成的方法。 |
restore |
从提供的 LROPollState 还原 LROPoller。 此方法可用于在不同的进程或计算机上重新创建 LROPoller。 |
send |
提供一种机制,用于发出将轮询并提供最终结果的请求。 |
send |
发送 LRO 的初始请求 (长时间运行的操作) 并取回 LROPoller,该 LROPoller 提供轮询 LRO 和检查 LRO 是否已完成的方法。 |
send |
发送使用提供的 OperationSpec 填充的 HTTP 请求。 |
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。 实现旧包 @azure/ms-rest-nodeauth 中的 ServiceClientCredentials 接口的凭据也 @azure/ms-rest-browserauth 受支持。
- options
- ResourceGraphClientOptions
参数选项
属性详细信息
operations
继承属性详细信息
acceptLanguage
credentials
credentials: ServiceClientCredentials | TokenCredential
属性值
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
回调
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>
Promise<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 资源管理器管理的资源。
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
回调
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>
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
请求对象
- options
- RequestOptionsBase
发出请求时要发送的其他选项
返回
Promise<@azure/ms-rest-azure-js.LROPoller>
HttpLongRunningOperationResponse,提供与 LRO 交互的方法。
restoreLROPoller(LROPollState)
从提供的 LROPollState 还原 LROPoller。 此方法可用于在不同的进程或计算机上重新创建 LROPoller。
function restoreLROPoller(lroPollState: LROPollState): LROPoller
参数
- lroPollState
- @azure/ms-rest-azure-js.LROPollState
返回
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)
提供一种机制,用于发出将轮询并提供最终结果的请求。
function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<HttpOperationResponse>
参数
- request
请求对象
- options
- RequestOptionsBase
发出请求时要发送的其他选项
返回
Promise<HttpOperationResponse>
包含最终轮询请求、响应和 responseBody 的 HttpOperationResponse。
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)
发送 LRO 的初始请求 (长时间运行的操作) 并取回 LROPoller,该 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>
提供与 LRO 交互的方法的 LROPoller 对象。
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
发送使用提供的 OperationSpec 填充的 HTTP 请求。
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>
参数
- operationArguments
- OperationArguments
将从中填充 HTTP 请求的模板化值的参数。
- operationSpec
- OperationSpec
用于填充 httpRequest 的 OperationSpec。
- callback
-
ServiceCallback<any>
收到响应时要调用的回调。
返回
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
发送提供的 httpRequest。
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>
参数
- options
返回
Promise<HttpOperationResponse>