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
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- versionName
-
string
Имя версии API.
- definitionName
-
string
Имя определения API.
Параметры параметров.
Возвращаемое значение
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
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- versionName
-
string
Имя версии API.
- definitionName
-
string
Имя определения API.
Параметры параметров.
Возвращаемое значение
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
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- versionName
-
string
Имя версии API.
- definitionName
-
string
Имя определения API.
- body
- ApiSpecImportRequest
Содержимое запроса действия
Параметры параметров.
Возвращаемое значение
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
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- versionName
-
string
Имя версии API.
- definitionName
-
string
Имя определения API.
- body
- ApiSpecImportRequest
Содержимое запроса действия
Параметры параметров.
Возвращаемое значение
Promise<void>
createOrUpdate(string, string, string, string, string, string, ApiDefinition, ApiDefinitionsCreateOrUpdateOptionalParams)
Создает новое или обновляет существующее определение 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
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- versionName
-
string
Имя версии API.
- definitionName
-
string
Имя определения API.
- resource
- ApiDefinition
Параметры создания ресурсов.
Параметры параметров.
Возвращаемое значение
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
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- versionName
-
string
Имя версии API.
- definitionName
-
string
Имя определения API.
Параметры параметров.
Возвращаемое значение
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
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- versionName
-
string
Имя версии API.
- definitionName
-
string
Имя определения API.
- options
- ApiDefinitionsGetOptionalParams
Параметры параметров.
Возвращаемое значение
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
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- versionName
-
string
Имя версии API.
- definitionName
-
string
Имя определения API.
- options
- ApiDefinitionsHeadOptionalParams
Параметры параметров.
Возвращаемое значение
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
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- versionName
-
string
Имя версии API.
- options
- ApiDefinitionsListOptionalParams
Параметры параметров.