Servizio Microsoft.ApiManagement/products 2023-03-01-preview

Articolo
01/18/2024

Definizione di risorsa Bicep

Il tipo di risorsa servizio/prodotti può essere distribuito con operazioni destinate a:

Gruppi di risorse - Vedere i comandi di distribuzione dei gruppi di risorse

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

Formato di risorsa

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

resource symbolicname 'Microsoft.ApiManagement/service/products@2023-03-01-preview' = {
  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
name	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.
padre	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 esterna alla risorsa padre.	Nome simbolico per la risorsa di tipo: servizio
properties	Proprietà del contratto dell'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 il valore false.	bool
description	Descrizione del prodotto. Può includere tag di formattazione HTML.	string
displayName	Nome prodotto.	stringa (obbligatorio)
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 del prodotto non è Pubblicato.	'notPublished' 'published'
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 per una richiesta a un'API inclusa nel prodotto è necessaria una chiave di sottoscrizione valida. 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 durante la creazione di un nuovo prodotto, si presuppone che il valore sia true.	bool
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 il valore false.	INT
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.	string

Modelli di avvio rapido

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

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

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa servizio/prodotti può essere distribuito con operazioni destinate a:

Gruppi di risorse - Vedere i comandi di distribuzione dei gruppi di risorse

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

Formato di risorsa

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

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2023-03-01-preview",
  "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
tipo	Tipo di risorsa	'Microsoft.ApiManagement/service/products'
apiVersion	Versione dell'API della risorsa	'2023-03-01-preview'
name	Nome della risorsa Informazioni su come impostare nomi e tipi per le risorse figlio nei 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.
properties	Proprietà del contratto dell'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 il valore false.	bool
description	Descrizione del prodotto. Può includere tag di formattazione HTML.	string
displayName	Nome prodotto.	stringa (obbligatorio)
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 del prodotto non è Pubblicato.	'notPublished' 'published'
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 per una richiesta a un'API inclusa nel prodotto è necessaria una chiave di sottoscrizione valida. 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 durante la creazione di un nuovo prodotto, si presuppone che il valore sia true.	bool
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 il valore false.	INT
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.	string

Modelli di avvio rapido

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

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

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa servizio/prodotti 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 di 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@2023-03-01-preview"
  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
tipo	Tipo di risorsa	"Microsoft.ApiManagement/service/products@2023-03-01-preview"
name	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
properties	Proprietà del contratto dell'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 avere una delle API del prodotto. Può essere presente solo se la proprietà subscriptionRequired è presente e ha un valore false.	bool
description	Descrizione del prodotto. Può includere tag di formattazione HTML.	string
displayName	Nome prodotto.	stringa (obbligatoria)
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.	"notPubblicato" "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.	bool
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.	INT
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.	string

Condividi tramite

Servizio Microsoft.ApiManagement/products 2023-03-01-preview

Definizione di risorsa Bicep

Formato di risorsa

Valori delle proprietà

servizio/prodotti

ProductContractProperties

Modelli di avvio rapido

Definizione di risorsa del modello di Resource Manager

Formato di risorsa

Valori delle proprietà

servizio/prodotti

ProductContractProperties

Modelli di avvio rapido

Definizione della risorsa Terraform (provider AzAPI)

Formato di risorsa

Valori delle proprietà

servizio/prodotti

ProductContractProperties

Risorse aggiuntive