Product interface
Interface que representa um Produto.
Métodos
| create |
Cria ou atualiza um produto. |
| delete(string, string, string, string, Product |
Excluir produto. |
| get(string, string, string, Product |
Obtém os detalhes do produto especificado por seu identificador. |
| get |
Obtém a versão Etag (estado de entidade) do produto especificado por seu identificador. |
| list |
Lista uma coleção de produtos na instância de serviço especificada. |
| list |
Lista uma coleção de produtos associados a marcas. |
| update(string, string, string, string, Product |
Atualize os detalhes do produto existentes. |
Detalhes do método
createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)
Cria ou atualiza um produto.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: ProductContract, options?: ProductCreateOrUpdateOptionalParams): Promise<ProductCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- productId
-
string
Identificador do produto. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- parameters
- ProductContract
Criar ou atualizar parâmetros.
Os parâmetros de opções.
Retornos
Promise<ProductCreateOrUpdateResponse>
delete(string, string, string, string, ProductDeleteOptionalParams)
Excluir produto.
function delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- productId
-
string
Identificador do produto. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- options
- ProductDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
get(string, string, string, ProductGetOptionalParams)
Obtém os detalhes do produto especificado por seu identificador.
function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetOptionalParams): Promise<ProductGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- productId
-
string
Identificador do produto. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- options
- ProductGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<ProductGetResponse>
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)
Obtém a versão Etag (estado de entidade) do produto especificado por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetEntityTagOptionalParams): Promise<ProductGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- productId
-
string
Identificador do produto. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
Promise<ProductGetEntityTagHeaders>
listByService(string, string, ProductListByServiceOptionalParams)
Lista uma coleção de produtos na instância de serviço especificada.
function listByService(resourceGroupName: string, serviceName: string, options?: ProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
Os parâmetros de opções.
Retornos
listByTags(string, string, ProductListByTagsOptionalParams)
Lista uma coleção de produtos associados a marcas.
function listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- options
- ProductListByTagsOptionalParams
Os parâmetros de opções.
Retornos
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)
Atualize os detalhes do produto existentes.
function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: ProductUpdateOptionalParams): Promise<ProductUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- productId
-
string
Identificador do produto. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- parameters
- ProductUpdateParameters
Atualizar parâmetros.
- options
- ProductUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<ProductUpdateResponse>