WorkspaceProduct interface
Interface que representa um WorkspaceProduct.
Métodos
| create |
Cria ou atualiza um produto. |
| delete(string, string, string, string, string, Workspace |
Excluir produto. |
| get(string, string, string, string, Workspace |
Obtém os detalhes do produto especificado por seu identificador. |
| get |
Obtém a versão do estado da entidade (Etag) do produto especificado por seu identificador. |
| list |
Lista uma coleção de produtos no espaço de trabalho especificado em uma instância de serviço. |
| update(string, string, string, string, string, Product |
Atualize os detalhes do produto existente. |
Detalhes de Método
createOrUpdate(string, string, string, string, ProductContract, WorkspaceProductCreateOrUpdateOptionalParams)
Cria ou atualiza um produto.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, parameters: ProductContract, options?: WorkspaceProductCreateOrUpdateOptionalParams): Promise<WorkspaceProductCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- productId
-
string
Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- parameters
- ProductContract
Crie ou atualize parâmetros.
Os parâmetros de opções.
Devoluções
delete(string, string, string, string, string, WorkspaceProductDeleteOptionalParams)
Excluir produto.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, ifMatch: string, options?: WorkspaceProductDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- productId
-
string
Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, WorkspaceProductGetOptionalParams)
Obtém os detalhes do produto especificado por seu identificador.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, options?: WorkspaceProductGetOptionalParams): Promise<WorkspaceProductGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- productId
-
string
Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceProductGetResponse>
getEntityTag(string, string, string, string, WorkspaceProductGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do produto especificado por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, options?: WorkspaceProductGetEntityTagOptionalParams): Promise<WorkspaceProductGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- productId
-
string
Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceProductGetEntityTagHeaders>
listByService(string, string, string, WorkspaceProductListByServiceOptionalParams)
Lista uma coleção de produtos no espaço de trabalho especificado em uma instância de serviço.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
update(string, string, string, string, string, ProductUpdateParameters, WorkspaceProductUpdateOptionalParams)
Atualize os detalhes do produto existente.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: WorkspaceProductUpdateOptionalParams): Promise<WorkspaceProductUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- productId
-
string
Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- parameters
- ProductUpdateParameters
Atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceProductUpdateResponse>