Product interface
Интерфейс, представляющий продукт.
Методы
| create |
Создает или изменяет продукт. |
| delete(string, string, string, string, Product |
Удаление продукта. |
| get(string, string, string, Product |
Возвращает сведения о продукте, заданном его идентификатором. |
| get |
Возвращает версию состояния сущности (Etag) продукта, указанную его идентификатором. |
| list |
Возвращает коллекцию продуктов в указанном экземпляре службы. |
| list |
Возвращает коллекцию продуктов, связанных с тегами. |
| update(string, string, string, string, Product |
Обновление сведений о существующем продукте. |
Сведения о методе
createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)
Создает или изменяет продукт.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: ProductContract, options?: ProductCreateOrUpdateOptionalParams): Promise<ProductCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- parameters
- ProductContract
Создание или обновление параметров.
Параметры параметров.
Возвращаемое значение
Promise<ProductCreateOrUpdateResponse>
delete(string, string, string, string, ProductDeleteOptionalParams)
Удаление продукта.
function delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- options
- ProductDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, ProductGetOptionalParams)
Возвращает сведения о продукте, заданном его идентификатором.
function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetOptionalParams): Promise<ProductGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- options
- ProductGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ProductGetResponse>
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) продукта, указанную его идентификатором.
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetEntityTagOptionalParams): Promise<ProductGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.
Возвращаемое значение
Promise<ProductGetEntityTagHeaders>
listByService(string, string, ProductListByServiceOptionalParams)
Возвращает коллекцию продуктов в указанном экземпляре службы.
function listByService(resourceGroupName: string, serviceName: string, options?: ProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
Параметры параметров.
Возвращаемое значение
listByTags(string, string, ProductListByTagsOptionalParams)
Возвращает коллекцию продуктов, связанных с тегами.
function listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- options
- ProductListByTagsOptionalParams
Параметры параметров.
Возвращаемое значение
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)
Обновление сведений о существующем продукте.
function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: ProductUpdateOptionalParams): Promise<ProductUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- productId
-
string
Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- parameters
- ProductUpdateParameters
Обновление параметров.
- options
- ProductUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ProductUpdateResponse>