GlobalSchema interface

パッケージ:

@azure/arm-apimanagement

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

メソッド

beginCreateOrUpdate(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)	API Management サービス インスタンスの新しいスキーマを作成するか、既存の指定したスキーマを更新します。
beginCreateOrUpdateAndWait(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)	API Management サービス インスタンスの新しいスキーマを作成するか、既存の指定したスキーマを更新します。
delete(string, string, string, string, GlobalSchemaDeleteOptionalParams)	特定のスキーマを削除します。
get(string, string, string, GlobalSchemaGetOptionalParams)	識別子で指定されたスキーマの詳細を取得します。
getEntityTag(string, string, string, GlobalSchemaGetEntityTagOptionalParams)	識別子で指定されたスキーマのエンティティ状態 (Etag) バージョンを取得します。
listByService(string, string, GlobalSchemaListByServiceOptionalParams)	サービス インスタンスに登録されているスキーマのコレクションを一覧表示します。

メソッドの詳細

beginCreateOrUpdate(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)

API Management サービス インスタンスの新しいスキーマを作成するか、既存の指定したスキーマを更新します。

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GlobalSchemaCreateOrUpdateResponse>, GlobalSchemaCreateOrUpdateResponse>>

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

schemaId

string

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

parameters

GlobalSchemaContract

パラメーターを作成または更新します。

options

GlobalSchemaCreateOrUpdateOptionalParams

options パラメーター。

戻り値

Promise<@azure/core-lro.SimplePollerLike<OperationState<GlobalSchemaCreateOrUpdateResponse>, GlobalSchemaCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)

API Management サービス インスタンスの新しいスキーマを作成するか、既存の指定したスキーマを更新します。

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<GlobalSchemaCreateOrUpdateResponse>

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

schemaId

string

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

parameters

GlobalSchemaContract

パラメーターを作成または更新します。

options

GlobalSchemaCreateOrUpdateOptionalParams

options パラメーター。

戻り値

Promise<GlobalSchemaCreateOrUpdateResponse>

delete(string, string, string, string, GlobalSchemaDeleteOptionalParams)

特定のスキーマを削除します。

function delete(resourceGroupName: string, serviceName: string, schemaId: string, ifMatch: string, options?: GlobalSchemaDeleteOptionalParams): Promise<void>

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

schemaId

string

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

ifMatch

string

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

options

GlobalSchemaDeleteOptionalParams

options パラメーター。

戻り値

Promise<void>

get(string, string, string, GlobalSchemaGetOptionalParams)

識別子で指定されたスキーマの詳細を取得します。

function get(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetOptionalParams): Promise<GlobalSchemaGetResponse>

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

schemaId

string

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

options

GlobalSchemaGetOptionalParams

options パラメーター。

戻り値

Promise<GlobalSchemaGetResponse>

getEntityTag(string, string, string, GlobalSchemaGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetEntityTagOptionalParams): Promise<GlobalSchemaGetEntityTagHeaders>

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

schemaId

string

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

options

GlobalSchemaGetEntityTagOptionalParams

options パラメーター。

戻り値

Promise<GlobalSchemaGetEntityTagHeaders>

listByService(string, string, GlobalSchemaListByServiceOptionalParams)

サービス インスタンスに登録されているスキーマのコレクションを一覧表示します。

function listByService(resourceGroupName: string, serviceName: string, options?: GlobalSchemaListByServiceOptionalParams): PagedAsyncIterableIterator<GlobalSchemaContract, GlobalSchemaContract[], PageSettings>

パラメーター

resourceGroupName

string

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

serviceName

string

API Management サービスの名前。

options

GlobalSchemaListByServiceOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<GlobalSchemaContract, GlobalSchemaContract[], PageSettings>