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)	查詢 Azure Resource Manager所管理的資源，以取得要求中指定的範圍。
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)	從提供的 LROPollState 還原 LROPoller。 這個方法可用來在不同的進程或電腦上重新建立 LROPoller。
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)	提供一種機制，以提出將輪詢並提供最終結果的要求。
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	傳送 LRO 的初始要求 (長時間執行的作業) ，並取得 LROPoller，以提供輪詢 LRO 的方法，並檢查 LRO 是否已完成。
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)	傳送使用提供的 OperationSpec 填入的 HTTP 要求。
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 。 從舊版套件 @azure/ms-rest-nodeauth@azure/ms-rest-browserauth 實作 ServiceClientCredentials 介面的認證也受到支援。

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)

查詢 Azure Resource Manager所管理的資源，以取得要求中指定的範圍。

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)

從提供的 LROPollState 還原 LROPoller。 這個方法可用來在不同的進程或電腦上重新建立 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>

包含最終輪詢要求、回應和 responseBody 的 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>)

傳送使用提供的 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>

繼承自ResourceGraphClientCoNtext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

傳送提供的 HTTPRequest。

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

參數

options

RequestPrepareOptions | WebResourceLike

傳回

Promise<HttpOperationResponse>

繼承自ResourceGraphClientCoNtext.sendRequest