Servizio Microsoft.ApiManagement/sottoscrizioni 2021-04-01-preview
Definizione di risorsa Bicep
Il tipo di risorsa service/subscriptions 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/subscriptions, aggiungere il bicep seguente al modello.
resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2021-04-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
Valori delle proprietà
servizio/sottoscrizioni
| 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 di sottoscrizione. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| Nome | Descrizione | Valore |
|---|---|---|
| allowTracing | Determina se è possibile abilitare la traccia | bool |
| displayName | nome della sottoscrizione. | stringa (obbligatorio) |
| ownerId | Utente (percorso ID utente) per il quale viene creata la sottoscrizione nel formato /users/{userId} | string |
| primaryKey | Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente. | string |
| ambito | Ambito come /products/{productId} o /apis o /apis/{apiId}. | stringa (obbligatorio) |
| secondaryKey | Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente. | string |
| state | Stato iniziale della sottoscrizione. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata- la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * Scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata. | 'active' 'cancelled' 'scaduto' 'rifiutato' 'inviato' 'sospeso' |
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à |
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa service/subscriptions 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/subscriptions, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.ApiManagement/service/subscriptions",
"apiVersion": "2021-04-01-preview",
"name": "string",
"properties": {
"allowTracing": "bool",
"displayName": "string",
"ownerId": "string",
"primaryKey": "string",
"scope": "string",
"secondaryKey": "string",
"state": "string"
}
}
Valori delle proprietà
servizio/sottoscrizioni
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | 'Microsoft.ApiManagement/service/subscriptions' |
| apiVersion | Versione dell'API della risorsa | '2021-04-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 di sottoscrizione. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| Nome | Descrizione | Valore |
|---|---|---|
| allowTracing | Determina se è possibile abilitare la traccia | bool |
| displayName | nome della sottoscrizione. | stringa (obbligatorio) |
| ownerId | Utente (percorso ID utente) per il quale viene creata la sottoscrizione nel formato /users/{userId} | string |
| primaryKey | Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente. | string |
| ambito | Ambito come /products/{productId} o /apis o /apis/{apiId}. | stringa (obbligatorio) |
| secondaryKey | Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente. | string |
| state | Stato iniziale della sottoscrizione. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata- la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * Scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata. | 'active' 'cancelled' 'scaduto' 'rifiutato' 'inviato' 'sospeso' |
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à |
Definizione della risorsa Terraform (provider AzAPI)
Il tipo di risorsa service/subscriptions 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/subscriptions, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/subscriptions@2021-04-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
allowTracing = bool
displayName = "string"
ownerId = "string"
primaryKey = "string"
scope = "string"
secondaryKey = "string"
state = "string"
}
})
}
Valori delle proprietà
servizio/sottoscrizioni
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | "Microsoft.ApiManagement/service/subscriptions@2021-04-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 di sottoscrizione. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| Nome | Descrizione | Valore |
|---|---|---|
| allowTracing | Determina se è possibile abilitare la traccia | bool |
| displayName | nome della sottoscrizione. | stringa (obbligatorio) |
| ownerId | Utente (percorso ID utente) per il quale viene creata la sottoscrizione nel formato /users/{userId} | string |
| primaryKey | Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente. | string |
| ambito | Ambito come /products/{productId} o /apis o /apis/{apiId}. | stringa (obbligatorio) |
| secondaryKey | Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente. | string |
| state | Stato della sottoscrizione iniziale. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata - la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * scaduto: la sottoscrizione ha raggiunto la data di scadenza e è stata disattivata. | "attivo" "annullata" "scaduto" "rifiutato" "inviato" "sospeso" |