ProductContract interface

Pacote:

@azure/arm-apimanagement

Detalhes do produto.

Extends

ProxyResource

Propriedades

approvalRequired	se a aprovação da assinatura é necessária. Se for false, novas assinaturas serão aprovadas automaticamente, permitindo que os desenvolvedores chamem as APIs do produto imediatamente após a assinatura. Se for true, os administradores devem aprovar manualmente a assinatura antes que o desenvolvedor possa qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de false.
description	Descrição do produto. Pode incluir marcas de formatação HTML.
displayName	Nome do produto.
state	se o produto é publicado ou não. Os produtos publicados são detectáveis por usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para os administradores. O estado padrão do Produto não é publicado.
subscriptionRequired	Se uma assinatura de produto é necessária para acessar APIs incluídas neste produto. Se for true, o produto será chamado de "protegido" e uma chave de assinatura válida será necessária para que uma solicitação a uma API incluída no produto seja bem-sucedida. Se for falso, o produto será chamado de "aberto" e as solicitações para uma API incluída no produto poderão ser feitas sem uma chave de assinatura. Se a propriedade for omitida ao criar um novo produto, seu valor será considerado verdadeiro.
subscriptionsLimit	Se o número de assinaturas que um usuário pode ter para este produto ao mesmo tempo. Defina como nulo ou omita para permitir assinaturas ilimitadas por usuário. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de false.
terms	Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto verão e deverão aceitar esses termos para concluir o processo de assinatura.

Propriedades herdadas

id	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name	O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da propriedade

approvalRequired

se a aprovação da assinatura é necessária. Se for false, novas assinaturas serão aprovadas automaticamente, permitindo que os desenvolvedores chamem as APIs do produto imediatamente após a assinatura. Se for true, os administradores devem aprovar manualmente a assinatura antes que o desenvolvedor possa qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de false.

approvalRequired?: boolean

Valor da propriedade

boolean

description

Descrição do produto. Pode incluir marcas de formatação HTML.

description?: string

Valor da propriedade

string

displayName

Nome do produto.

displayName?: string

Valor da propriedade

string

state

se o produto é publicado ou não. Os produtos publicados são detectáveis por usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para os administradores. O estado padrão do Produto não é publicado.

state?: ProductState

Valor da propriedade

ProductState

subscriptionRequired

Se uma assinatura de produto é necessária para acessar APIs incluídas neste produto. Se for true, o produto será chamado de "protegido" e uma chave de assinatura válida será necessária para que uma solicitação a uma API incluída no produto seja bem-sucedida. Se for falso, o produto será chamado de "aberto" e as solicitações para uma API incluída no produto poderão ser feitas sem uma chave de assinatura. Se a propriedade for omitida ao criar um novo produto, seu valor será considerado verdadeiro.

subscriptionRequired?: boolean

Valor da propriedade

boolean

subscriptionsLimit

Se o número de assinaturas que um usuário pode ter para este produto ao mesmo tempo. Defina como nulo ou omita para permitir assinaturas ilimitadas por usuário. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de false.

subscriptionsLimit?: number

Valor da propriedade

number

terms

Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto verão e deverão aceitar esses termos para concluir o processo de assinatura.

terms?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

id

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor da propriedade

string

Herdado deProxyResource.id

name

O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor da propriedade

string

Herdado deProxyResource.name

type

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor da propriedade

string

Herdado deProxyResource.type