Condividi tramite

Servizio Microsoft.ApiManagement/workspaces/products 2023-05-01-preview

  • Articolo

Definizione di risorsa Bicep

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

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/workspaces/products, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/products@2023-05-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/aree di lavoro/prodotti

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatorio)
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: aree di lavoro
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

Definizione di risorsa del modello di Resource Manager

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

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/workspaces/products, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

servizio/aree di lavoro/prodotti

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.ApiManagement/service/workspaces/products'
apiVersion Versione dell'API della risorsa '2023-05-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)
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

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/workspaces/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 di risorsa

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/products@2023-05-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/aree di lavoro/prodotti

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.ApiManagement/service/workspaces/products@2023-05-01-preview"
name Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: aree di lavoro
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"
"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 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