ApiDefinitions interface
ApiDefinitions を表すインターフェイス。
メソッド
メソッドの詳細
beginExportSpecification(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
API 仕様をエクスポートします。
function beginExportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- versionName
-
string
API バージョンの名前。
- definitionName
-
string
API 定義の名前。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSpecExportResult>, ApiSpecExportResult>>
beginExportSpecificationAndWait(string, string, string, string, string, string, ApiDefinitionsExportSpecificationOptionalParams)
API 仕様をエクスポートします。
function beginExportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsExportSpecificationOptionalParams): Promise<ApiSpecExportResult>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- versionName
-
string
API バージョンの名前。
- definitionName
-
string
API 定義の名前。
options パラメーター。
戻り値
Promise<ApiSpecExportResult>
beginImportSpecification(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
API 仕様をインポートします。
function beginImportSpecification(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- versionName
-
string
API バージョンの名前。
- definitionName
-
string
API 定義の名前。
- body
- ApiSpecImportRequest
アクション要求の内容
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportSpecificationAndWait(string, string, string, string, string, string, ApiSpecImportRequest, ApiDefinitionsImportSpecificationOptionalParams)
API 仕様をインポートします。
function beginImportSpecificationAndWait(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, body: ApiSpecImportRequest, options?: ApiDefinitionsImportSpecificationOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- versionName
-
string
API バージョンの名前。
- definitionName
-
string
API 定義の名前。
- body
- ApiSpecImportRequest
アクション要求の内容
options パラメーター。
戻り値
Promise<void>
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)
新しい API 定義を作成するか、既存の API 定義を更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, resource: ApiDefinition, options?: ApiDefinitionsCreateOrUpdateOptionalParams): Promise<ApiDefinitionsCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- versionName
-
string
API バージョンの名前。
- definitionName
-
string
API 定義の名前。
- resource
- ApiDefinition
リソース作成パラメーター。
options パラメーター。
戻り値
Promise<ApiDefinitionsCreateOrUpdateResponse>
delete(string, string, string, string, string, string, ApiDefinitionsDeleteOptionalParams)
指定した API 定義を削除します。
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- versionName
-
string
API バージョンの名前。
- definitionName
-
string
API 定義の名前。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, string, string, ApiDefinitionsGetOptionalParams)
API 定義の詳細を返します。
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsGetOptionalParams): Promise<ApiDefinitionsGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- versionName
-
string
API バージョンの名前。
- definitionName
-
string
API 定義の名前。
- options
- ApiDefinitionsGetOptionalParams
options パラメーター。
戻り値
Promise<ApiDefinitionsGetResponse>
head(string, string, string, string, string, string, ApiDefinitionsHeadOptionalParams)
指定された API 定義が存在するかどうかを確認します。
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, definitionName: string, options?: ApiDefinitionsHeadOptionalParams): Promise<ApiDefinitionsHeadResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- versionName
-
string
API バージョンの名前。
- definitionName
-
string
API 定義の名前。
- options
- ApiDefinitionsHeadOptionalParams
options パラメーター。
戻り値
Promise<ApiDefinitionsHeadResponse>
list(string, string, string, string, string, ApiDefinitionsListOptionalParams)
API 定義のコレクションを返します。
function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiDefinitionsListOptionalParams): PagedAsyncIterableIterator<ApiDefinition, ApiDefinition[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- versionName
-
string
API バージョンの名前。
- options
- ApiDefinitionsListOptionalParams
options パラメーター。