ProductContract interface

Pacchetto:

@azure/arm-apimanagement

Dettagli prodotto.

Extends

ProxyResource

Proprietà

approvalRequired	se è necessaria l'approvazione della sottoscrizione. Se false, le nuove sottoscrizioni verranno approvate automaticamente consentendo agli sviluppatori di chiamare le API del prodotto immediatamente dopo la sottoscrizione. Se true, gli amministratori devono approvare manualmente la sottoscrizione prima che lo sviluppatore possa avere una delle API del prodotto. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false.
description	Descrizione del prodotto. Può includere tag di formattazione HTML.
displayName	Nome prodotto.
state	se il prodotto viene pubblicato o meno. I prodotti pubblicati sono individuabili dagli utenti del portale per sviluppatori. I prodotti non pubblicati sono visibili solo agli amministratori. Lo stato predefinito di Product non è Pubblicato.
subscriptionRequired	Indica se è necessaria una sottoscrizione del prodotto per l'accesso alle API incluse in questo prodotto. Se true, il prodotto viene definito "protetto" e una chiave di sottoscrizione valida è necessaria per una richiesta a un'API inclusa nel prodotto. Se false, il prodotto viene definito "aperto" e le richieste a un'API inclusa nel prodotto possono essere eseguite senza una chiave di sottoscrizione. Se la proprietà viene omessa quando si crea un nuovo prodotto, si presuppone che sia true.
subscriptionsLimit	Indica se il numero di sottoscrizioni che un utente può avere a questo prodotto contemporaneamente. Impostare su Null o omettere per consentire sottoscrizioni illimitate per utente. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false.
terms	Condizioni per l'utilizzo del prodotto. Gli sviluppatori che tentano di sottoscrivere il prodotto vengono presentati e devono accettare queste condizioni prima di poter completare il processo di sottoscrizione.

Proprietà ereditate

id	ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
name	Nome della risorsa NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
type	Tipo di risorsa. Nota su "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts": questa proprietà non verrà serializzata. Può essere popolato solo dal server.

Dettagli proprietà

approvalRequired

se è necessaria l'approvazione della sottoscrizione. Se false, le nuove sottoscrizioni verranno approvate automaticamente consentendo agli sviluppatori di chiamare le API del prodotto immediatamente dopo la sottoscrizione. Se true, gli amministratori devono approvare manualmente la sottoscrizione prima che lo sviluppatore possa avere una delle API del prodotto. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false.

approvalRequired?: boolean

Valore della proprietà

boolean

description

Descrizione del prodotto. Può includere tag di formattazione HTML.

description?: string

Valore della proprietà

string

displayName

Nome prodotto.

displayName?: string

Valore della proprietà

string

state

se il prodotto viene pubblicato o meno. I prodotti pubblicati sono individuabili dagli utenti del portale per sviluppatori. I prodotti non pubblicati sono visibili solo agli amministratori. Lo stato predefinito di Product non è Pubblicato.

state?: ProductState

Valore della proprietà

ProductState

subscriptionRequired

Indica se è necessaria una sottoscrizione del prodotto per l'accesso alle API incluse in questo prodotto. Se true, il prodotto viene definito "protetto" e una chiave di sottoscrizione valida è necessaria per una richiesta a un'API inclusa nel prodotto. Se false, il prodotto viene definito "aperto" e le richieste a un'API inclusa nel prodotto possono essere eseguite senza una chiave di sottoscrizione. Se la proprietà viene omessa quando si crea un nuovo prodotto, si presuppone che sia true.

subscriptionRequired?: boolean

Valore della proprietà

boolean

subscriptionsLimit

Indica se il numero di sottoscrizioni che un utente può avere a questo prodotto contemporaneamente. Impostare su Null o omettere per consentire sottoscrizioni illimitate per utente. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false.

subscriptionsLimit?: number

Valore della proprietà

number

terms

Condizioni per l'utilizzo del prodotto. Gli sviluppatori che tentano di sottoscrivere il prodotto vengono presentati e devono accettare queste condizioni prima di poter completare il processo di sottoscrizione.

terms?: string

Valore della proprietà

string

Dettagli proprietà ereditate

id

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

id?: string

Valore della proprietà

string

Ereditato daProxyResource.id

name

Nome della risorsa NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

name?: string

Valore della proprietà

string

Ereditato daProxyResource.name

type

Tipo di risorsa. Nota su "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts": questa proprietà non verrà serializzata. Può essere popolato solo dal server.

type?: string

Valore della proprietà

string

Ereditato daProxyResource.type