Partilhar via


ProductContractProperties interface

Perfil do produto.

Extends

Propriedades

displayName

Nome do produto.

Propriedades Herdadas

approvalRequired

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

description

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

state

se o produto é publicado ou não. Os produtos publicados podem ser descobertos pelos usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para administradores. O estado padrão do Produto não é Publicado.

subscriptionRequired

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

subscriptionsLimit

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

terms

Termos de utilização do produto. Os programadores que tentem subscrever o produto serão apresentados e obrigados a aceitar estes termos antes de poderem concluir o processo de subscrição.

Detalhes de Propriedade

displayName

Nome do produto.

displayName: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

approvalRequired

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

approvalRequired?: boolean

Valor de Propriedade

boolean

herdado deProductEntityBaseParameters.approvalRequired

description

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

description?: string

Valor de Propriedade

string

herdado deProductEntityBaseParameters.description

state

se o produto é publicado ou não. Os produtos publicados podem ser descobertos pelos usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para administradores. O estado padrão do Produto não é Publicado.

state?: ProductState

Valor de Propriedade

herdado de ProductEntityBaseParameters.state

subscriptionRequired

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

subscriptionRequired?: boolean

Valor de Propriedade

boolean

herdado deProductEntityBaseParameters.subscriptionRequired

subscriptionsLimit

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

subscriptionsLimit?: number

Valor de Propriedade

number

herdado deProductEntityBaseParameters.subscriptionsLimit

terms

Termos de utilização do produto. Os programadores que tentem subscrever o produto serão apresentados e obrigados a aceitar estes termos antes de poderem concluir o processo de subscrição.

terms?: string

Valor de Propriedade

string

herdado deProductEntityBaseParameters.terms