次の方法で共有

ApiDiagnostic interface

  • リファレンス
パッケージ:
@azure/arm-apimanagement

ApiDiagnostic を表すインターフェイス。

メソッド

createOrUpdate(string, string, string, string, DiagnosticContract, ApiDiagnosticCreateOrUpdateOptionalParams)

API の新しい診断を作成するか、既存のものを更新します。
delete(string, string, string, string, string, ApiDiagnosticDeleteOptionalParams)

指定された診断を API から削除します。
get(string, string, string, string, ApiDiagnosticGetOptionalParams)

識別子で指定された API の診断の詳細を取得します。
getEntityTag(string, string, string, string, ApiDiagnosticGetEntityTagOptionalParams)

識別子で指定された API の診断のエンティティ状態 (Etag) バージョンを取得します。
listByService(string, string, string, ApiDiagnosticListByServiceOptionalParams)

API のすべての診断を一覧表示します。
update(string, string, string, string, string, DiagnosticContract, ApiDiagnosticUpdateOptionalParams)

識別子で指定された API の診断の詳細を更新します。

メソッドの詳細

createOrUpdate(string, string, string, string, DiagnosticContract, ApiDiagnosticCreateOrUpdateOptionalParams)

API の新しい診断を作成するか、既存のものを更新します。

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, parameters: DiagnosticContract, options?: ApiDiagnosticCreateOrUpdateOptionalParams): Promise<ApiDiagnosticCreateOrUpdateResponse>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName

string

API Management サービスの名前。

apiId

string

API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

diagnosticId

string

診断識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

parameters
DiagnosticContract

パラメーターを作成します。

options
ApiDiagnosticCreateOrUpdateOptionalParams

options パラメーター。

戻り値

Promise<ApiDiagnosticCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiDiagnosticDeleteOptionalParams)

指定された診断を API から削除します。

function delete(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, options?: ApiDiagnosticDeleteOptionalParams): Promise<void>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName

string

API Management サービスの名前。

apiId

string

API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

diagnosticId

string

診断識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

ifMatch

string

エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。

options
ApiDiagnosticDeleteOptionalParams

options パラメーター。

戻り値

Promise<void>

get(string, string, string, string, ApiDiagnosticGetOptionalParams)

識別子で指定された API の診断の詳細を取得します。

function get(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetOptionalParams): Promise<ApiDiagnosticGetResponse>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName

string

API Management サービスの名前。

apiId

string

API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

diagnosticId

string

診断識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

options
ApiDiagnosticGetOptionalParams

options パラメーター。

戻り値

Promise<ApiDiagnosticGetResponse>

getEntityTag(string, string, string, string, ApiDiagnosticGetEntityTagOptionalParams)

識別子で指定された API の診断のエンティティ状態 (Etag) バージョンを取得します。

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, options?: ApiDiagnosticGetEntityTagOptionalParams): Promise<ApiDiagnosticGetEntityTagHeaders>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName

string

API Management サービスの名前。

apiId

string

API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

diagnosticId

string

診断識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

options
ApiDiagnosticGetEntityTagOptionalParams

options パラメーター。

戻り値

Promise<ApiDiagnosticGetEntityTagHeaders>

listByService(string, string, string, ApiDiagnosticListByServiceOptionalParams)

API のすべての診断を一覧表示します。

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiDiagnosticListByServiceOptionalParams): PagedAsyncIterableIterator<DiagnosticContract, DiagnosticContract[], PageSettings>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName

string

API Management サービスの名前。

apiId

string

API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

options
ApiDiagnosticListByServiceOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<DiagnosticContract, DiagnosticContract[], PageSettings>

update(string, string, string, string, string, DiagnosticContract, ApiDiagnosticUpdateOptionalParams)

識別子で指定された API の診断の詳細を更新します。

function update(resourceGroupName: string, serviceName: string, apiId: string, diagnosticId: string, ifMatch: string, parameters: DiagnosticContract, options?: ApiDiagnosticUpdateOptionalParams): Promise<ApiDiagnosticUpdateResponse>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName

string

API Management サービスの名前。

apiId

string

API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

diagnosticId

string

診断識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

ifMatch

string

エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。

parameters
DiagnosticContract

診断更新パラメーター。

options
ApiDiagnosticUpdateOptionalParams

options パラメーター。

戻り値

Promise<ApiDiagnosticUpdateResponse>