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 の最初の要求 (実行時間の長い操作) を送信し、LRO をポーリングし、LRO が完了したかどうかを確認するためのメソッドを提供する HttpLongRunningOperationResponse を取得します。
restoreLROPoller(LROPollState)	指定された LROPollState から LROPoller を復元します。 このメソッドを使用して、別のプロセスまたはマシンで LROPoller を再作成できます。
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)	ポーリングして最終的な結果を提供する要求を行うメカニズムを提供します。
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)	LRO の最初の要求 (実行時間の長い操作) を送信し、LRO をポーリングし、LRO が完了したかどうかを確認するためのメソッドを提供する LROPoller を取得します。
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 の最初の要求 (実行時間の長い操作) を送信し、LRO をポーリングし、LRO が完了したかどうかを確認するためのメソッドを提供する HttpLongRunningOperationResponse を取得します。

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

パラメーター

request

RequestPrepareOptions | WebResource

要求オブジェクト

options

RequestOptionsBase

要求の実行中に送信される追加のオプション

戻り値

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

LRO と対話するためのメソッドを提供する HttpLongRunningOperationResponse。

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 の最初の要求 (実行時間の長い操作) を送信し、LRO をポーリングし、LRO が完了したかどうかを確認するためのメソッドを提供する LROPoller を取得します。

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 オブジェクト。

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から継承