Servizio Microsoft.ApiManagement/products 2022-08-01

Articolo
07/24/2024

Definizione di risorsa Bicep

Il tipo di risorsa service/products può essere distribuito con operazioni destinate a:

gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/products, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/products@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

Valori delle proprietà

servizio/prodotti

Nome	Descrizione	Valore
nome	Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep.	stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
genitore	In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre. Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.	Nome simbolico per la risorsa di tipo: servizio
proprietà	Proprietà del contratto di entità prodotto.	ProductContractProperties

ProductContractProperties

Nome	Descrizione	Valore
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 qualsiasi API del prodotto. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false.	Bool
descrizione	Descrizione del prodotto. Può includere tag di formattazione HTML.	corda Vincoli: Lunghezza massima = 1000
displayName	Nome prodotto.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 300
stato	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.	'notPublished' 'published'
subscriptionRequired	Indica se è necessaria una sottoscrizione di 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 effettuate senza una chiave di sottoscrizione. Se la proprietà viene omessa quando si crea un nuovo prodotto, si presuppone che il valore sia true.	Bool
subscriptionsLimit	Indica se il numero di sottoscrizioni che un utente può avere contemporaneamente a questo prodotto. 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.	Int
Termini	Condizioni per l'utilizzo del prodotto. Gli sviluppatori che provano a sottoscrivere il prodotto verranno presentati e dovranno accettare queste condizioni prima di poter completare il processo di sottoscrizione.	corda

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma	Descrizione
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello	Questo modello illustra come creare un servizio Gestione API e configurare le sottoentità
Creare frontdoor di Azure davanti a Gestione API di Azure	Questo esempio illustra come usare Frontdoor di Azure come servizio di bilanciamento del carico globale davanti a Gestione API di Azure.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/products può essere distribuito con operazioni destinate a:

gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/products, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

Valori delle proprietà

servizio/prodotti

Nome	Descrizione	Valore
digitare	Tipo di risorsa	'Microsoft.ApiManagement/service/products'
apiVersion	Versione dell'API della risorsa	'2022-08-01'
nome	Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in modelli DI Resource Manager JSON.	stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
proprietà	Proprietà del contratto di entità prodotto.	ProductContractProperties

ProductContractProperties

Nome	Descrizione	Valore
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 qualsiasi API del prodotto. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false.	Bool
descrizione	Descrizione del prodotto. Può includere tag di formattazione HTML.	corda Vincoli: Lunghezza massima = 1000
displayName	Nome prodotto.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 300
stato	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.	'notPublished' 'published'
subscriptionRequired	Indica se è necessaria una sottoscrizione di 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 effettuate senza una chiave di sottoscrizione. Se la proprietà viene omessa quando si crea un nuovo prodotto, si presuppone che il valore sia true.	Bool
subscriptionsLimit	Indica se il numero di sottoscrizioni che un utente può avere contemporaneamente a questo prodotto. 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.	Int
Termini	Condizioni per l'utilizzo del prodotto. Gli sviluppatori che provano a sottoscrivere il prodotto verranno presentati e dovranno accettare queste condizioni prima di poter completare il processo di sottoscrizione.	corda

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma	Descrizione
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello	Questo modello illustra come creare un servizio Gestione API e configurare le sottoentità
Creare frontdoor di Azure davanti a Gestione API di Azure	Questo esempio illustra come usare Frontdoor di Azure come servizio di bilanciamento del carico globale davanti a Gestione API di Azure.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/products può essere distribuito con operazioni destinate a:

gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/products, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  })
}

Valori delle proprietà

servizio/prodotti

Nome	Descrizione	Valore
digitare	Tipo di risorsa	"Microsoft.ApiManagement/service/products@2022-08-01"
nome	Nome della risorsa	stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
parent_id	ID della risorsa padre per questa risorsa.	ID per la risorsa di tipo: servizio
proprietà	Proprietà del contratto di entità prodotto.	ProductContractProperties

ProductContractProperties

Nome	Descrizione	Valore
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 qualsiasi API del prodotto. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false.	Bool
descrizione	Descrizione del prodotto. Può includere tag di formattazione HTML.	corda Vincoli: Lunghezza massima = 1000
displayName	Nome prodotto.	stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 300
stato	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.	"notPublished" "pubblicato"
subscriptionRequired	Indica se è necessaria una sottoscrizione di 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 effettuate senza una chiave di sottoscrizione. Se la proprietà viene omessa quando si crea un nuovo prodotto, si presuppone che il valore sia true.	Bool
subscriptionsLimit	Indica se il numero di sottoscrizioni che un utente può avere contemporaneamente a questo prodotto. 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.	Int
Termini	Condizioni per l'utilizzo del prodotto. Gli sviluppatori che provano a sottoscrivere il prodotto verranno presentati e dovranno accettare queste condizioni prima di poter completare il processo di sottoscrizione.	corda

Condividi tramite

Servizio Microsoft.ApiManagement/products 2022-08-01

Definizione di risorsa Bicep

Formato risorsa

Valori delle proprietà

servizio/prodotti

ProductContractProperties

Modelli di avvio rapido

Definizione di risorsa del modello di Resource Manager

Formato risorsa

Valori delle proprietà

servizio/prodotti

ProductContractProperties

Modelli di avvio rapido

Definizione di risorsa Terraform (provider AzAPI)

Formato risorsa

Valori delle proprietà

servizio/prodotti

ProductContractProperties

Commenti e suggerimenti

Risorse aggiuntive