ProductGroup interface
Interface que representa um ProductGroup.
Métodos
| check |
Verifica se a entidade Grupo especificada pelo identificador está associada à entidade Produto. |
| create |
Adiciona a associação entre o grupo de programadores especificado com o produto especificado. |
| delete(string, string, string, string, Product |
Elimina a associação entre o grupo especificado e o produto. |
| list |
Lista a coleção de grupos de programadores associados ao produto especificado. |
Detalhes de Método
checkEntityExists(string, string, string, string, ProductGroupCheckEntityExistsOptionalParams)
Verifica se a entidade Grupo especificada pelo identificador está associada à entidade Produto.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, groupId: string, options?: ProductGroupCheckEntityExistsOptionalParams): Promise<ProductGroupCheckEntityExistsResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- productId
-
string
Identificador de produto. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.
Devoluções
createOrUpdate(string, string, string, string, ProductGroupCreateOrUpdateOptionalParams)
Adiciona a associação entre o grupo de programadores especificado com o produto especificado.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, groupId: string, options?: ProductGroupCreateOrUpdateOptionalParams): Promise<GroupContract>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- productId
-
string
Identificador de produto. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.
Devoluções
Promise<GroupContract>
delete(string, string, string, string, ProductGroupDeleteOptionalParams)
Elimina a associação entre o grupo especificado e o produto.
function delete(resourceGroupName: string, serviceName: string, productId: string, groupId: string, options?: ProductGroupDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- productId
-
string
Identificador de produto. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- options
- ProductGroupDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
listByProduct(string, string, string, ProductGroupListByProductOptionalParams)
Lista a coleção de grupos de programadores associados ao produto especificado.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGroupListByProductOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- productId
-
string
Identificador de produto. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.