ApiSchema interface
ApiSchema を表すインターフェイス。
メソッド
| begin |
API のスキーマ構成を作成または更新します。 |
| begin |
API のスキーマ構成を作成または更新します。 |
| delete(string, string, string, string, string, Api |
API のスキーマ構成を削除します。 |
| get(string, string, string, string, Api |
API レベルでスキーマ構成を取得します。 |
| get |
識別子で指定されたスキーマのエンティティ状態 (Etag) バージョンを取得します。 |
| list |
API レベルでスキーマ構成を取得します。 |
メソッドの詳細
beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
API のスキーマ構成を作成または更新します。
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- schemaId
-
string
スキーマ ID 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- SchemaContract
適用するスキーマの内容。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)
API のスキーマ構成を作成または更新します。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- schemaId
-
string
スキーマ ID 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- SchemaContract
適用するスキーマの内容。
options パラメーター。
戻り値
Promise<ApiSchemaCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)
API のスキーマ構成を削除します。
function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- schemaId
-
string
スキーマ ID 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- ApiSchemaDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, ApiSchemaGetOptionalParams)
API レベルでスキーマ構成を取得します。
function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- schemaId
-
string
スキーマ ID 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- ApiSchemaGetOptionalParams
options パラメーター。
戻り値
Promise<ApiSchemaGetResponse>
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)
識別子で指定されたスキーマのエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- schemaId
-
string
スキーマ ID 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<ApiSchemaGetEntityTagHeaders>
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)
API レベルでスキーマ構成を取得します。
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- options
- ApiSchemaListByApiOptionalParams
options パラメーター。