ProductApi interface
Интерфейс, представляющий ProductApi.
Методы
| check |
Проверяет, связана ли сущность API, указанная идентификатором, с сущностью Product. |
| create |
Добавляет API в указанный продукт. |
| delete(string, string, string, string, Product |
Удаляет указанный API из указанного продукта. |
| list |
Возвращает коллекцию API, связанных с продуктом. |
Сведения о методе
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
Проверяет, связана ли сущность API, указанная идентификатором, с сущностью Product.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.
Параметры параметров.
Возвращаемое значение
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
Добавляет API в указанный продукт.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.
Параметры параметров.
Возвращаемое значение
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
Удаляет указанный API из указанного продукта.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.
- options
- ProductApiDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
Возвращает коллекцию API, связанных с продуктом.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.