Apis interface
Интерфейс, представляющий API.
Методы
| create |
Создает новый или обновляет существующий API. |
| delete(string, string, string, string, Apis |
Удаляет указанный API. |
| get(string, string, string, string, Apis |
Возвращает сведения об API. |
| head(string, string, string, string, Apis |
Проверяет, существует ли указанный API. |
| list(string, string, string, Apis |
Возвращает коллекцию API. |
Сведения о методе
createOrUpdate(string, string, string, string, Api, ApisCreateOrUpdateOptionalParams)
Создает новый или обновляет существующий API.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, resource: Api, options?: ApisCreateOrUpdateOptionalParams): Promise<ApisCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не учитывает регистр.
- serviceName
-
string
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- resource
- Api
Параметры создания ресурсов.
- options
- ApisCreateOrUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ApisCreateOrUpdateResponse>
delete(string, string, string, string, ApisDeleteOptionalParams)
Удаляет указанный API.
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не учитывает регистр.
- serviceName
-
string
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- options
- ApisDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, string, ApisGetOptionalParams)
Возвращает сведения об API.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisGetOptionalParams): Promise<ApisGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не учитывает регистр.
- serviceName
-
string
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- options
- ApisGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ApisGetResponse>
head(string, string, string, string, ApisHeadOptionalParams)
Проверяет, существует ли указанный API.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisHeadOptionalParams): Promise<ApisHeadResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не учитывает регистр.
- serviceName
-
string
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- apiName
-
string
Имя API.
- options
- ApisHeadOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ApisHeadResponse>
list(string, string, string, ApisListOptionalParams)
Возвращает коллекцию API.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, options?: ApisListOptionalParams): PagedAsyncIterableIterator<Api, Api[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не учитывает регистр.
- serviceName
-
string
Имя службы Центра API Azure.
- workspaceName
-
string
Имя рабочей области.
- options
- ApisListOptionalParams
Параметры параметров.