Servizio Microsoft.ApiManagement/namedValues 2022-08-01
Definizione di risorsa Bicep
Il tipo di risorsa service/namedValues può essere distribuito con operazioni destinate:
- 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 di risorsa
Per creare una risorsa Microsoft.ApiManagement/service/namedValues, aggiungere il codice Bicep seguente al modello.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Valori delle proprietà
service/namedValues
| Nome | Descrizione | valore |
|---|---|---|
| name | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep. |
stringa (obbligatoria) |
| 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 entità NamedValue per l'operazione PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Nome | Descrizione | Valore |
|---|---|---|
| displayName | Nome univoco di NamedValue. Può contenere solo lettere, cifre, punti, trattini e caratteri di sottolineatura. | stringa (obbligatoria) |
| keyVault | Dettagli della posizione di KeyVault dell'oggetto namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Determina se il valore è un segreto e se deve essere crittografato. Il valore predefinito è false. | bool |
| tags | Tag facoltativi che, se specificato, possono essere usati per filtrare l'elenco NamedValue. | string[] |
| Valore | Valore di NamedValue. Può contenere espressioni di criteri. Non può essere vuoto o contenere solo spazi. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nome | Descrizione | Valore |
|---|---|---|
| identityClientId | Null per SystemAssignedIdentity o Id client per UserAssignedIdentity , che verrà usato per accedere al segreto dell'insieme di credenziali delle chiavi. | string |
| secretIdentifier | Identificatore segreto dell'insieme di credenziali delle chiavi per recuperare il segreto. La fornitura di un segreto con versione impedisce l'aggiornamento automatico. Ciò richiede la configurazione del servizio Gestione API con aka.ms/apimmsi | string |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
| Modello | Descrizione |
|---|---|
Frontdoor Standard/Premium con origine Gestione API |
Questo modello crea un'istanza di Frontdoor Premium e un'istanza di Gestione API e usa un criterio di sicurezza di rete e di Gestione API globale per verificare che il traffico sia arrivato attraverso l'origine frontdoor. |
Definizione della risorsa modello di Resource Manager
Il tipo di risorsa service/namedValues può essere distribuito con operazioni destinate:
- 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 di risorsa
Per creare una risorsa Microsoft.ApiManagement/service/namedValues, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Valori delle proprietà
service/namedValues
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | 'Microsoft.ApiManagement/service/namedValues' |
| apiVersion | Versione dell'API risorsa | '2022-08-01' |
| name | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON. |
stringa (obbligatorio) |
| properties | Proprietà del contratto di entità NamedValue per l'operazione PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Nome | Descrizione | Valore |
|---|---|---|
| displayName | Nome univoco di NamedValue. Può contenere solo lettere, cifre, punti, trattini e caratteri di sottolineatura. | stringa (obbligatorio) |
| keyVault | Dettagli della posizione dell'insieme di credenziali delle chiavi del valore namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Determina se il valore è un segreto e se deve essere crittografato. Il valore predefinito è false. | bool |
| tags | Tag facoltativi che, se specificati, possono essere usati per filtrare l'elenco NamedValue. | string[] |
| Valore | Valore di NamedValue. Può contenere espressioni di criteri. Non può essere vuoto o contenere solo spazi. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nome | Descrizione | Valore |
|---|---|---|
| identityClientId | Null per SystemAssignedIdentity o ID client per UserAssignedIdentity , che verrà usato per accedere al segreto dell'insieme di credenziali delle chiavi. | string |
| secretIdentifier | Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con versione, si impedisce l'aggiornamento automatico. Ciò richiede la configurazione del servizio Gestione API con aka.ms/apimmsi | string |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
| Modello | Descrizione |
|---|---|
| Frontdoor Standard/Premium con origine Gestione API |
Questo modello crea un'istanza di Frontdoor Premium e un'istanza di Gestione API e usa un gruppo di sicurezza di rete e un criterio di Gestione API globale per verificare che il traffico provengano dall'origine di Frontdoor. |
Definizione della risorsa Terraform (provider AzAPI)
Il tipo di risorsa service/namedValues 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/namedValues, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2022-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Valori delle proprietà
service/namedValues
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | "Microsoft.ApiManagement/service/namedValues@2022-08-01" |
| name | Nome della risorsa | stringa (obbligatorio) |
| parent_id | ID della risorsa padre per questa risorsa. | ID per la risorsa di tipo: servizio |
| properties | Proprietà del contratto di entità NamedValue per l'operazione PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Nome | Descrizione | Valore |
|---|---|---|
| displayName | Nome univoco di NamedValue. Può contenere solo lettere, cifre, punti, trattini e caratteri di sottolineatura. | stringa (obbligatorio) |
| keyVault | Dettagli della posizione dell'insieme di credenziali delle chiavi del valore namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Determina se il valore è un segreto e se deve essere crittografato. Il valore predefinito è false. | bool |
| tags | Tag facoltativi che, se specificati, possono essere usati per filtrare l'elenco NamedValue. | string[] |
| Valore | Valore di NamedValue. Può contenere espressioni di criteri. Non può essere vuoto o contenere solo spazi. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nome | Descrizione | Valore |
|---|---|---|
| identityClientId | Null per SystemAssignedIdentity o ID client per UserAssignedIdentity , che verrà usato per accedere al segreto dell'insieme di credenziali delle chiavi. | string |
| secretIdentifier | Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con versione, si impedisce l'aggiornamento automatico. Ciò richiede la configurazione del servizio Gestione API con aka.ms/apimmsi | string |