Condividi tramite

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

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa service/namedValues 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/namedValues, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2023-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    displayName: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    secret: bool
    tags: [
      'string'
    ]
    value: 'string'
  }
}

Valori delle proprietà

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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. corda
secretIdentifier Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con controllo delle versioni, si impedisce l'aggiornamento automatico. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi corda

Microsoft.ApiManagement/service/namedValues

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza massima =
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
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à NamedValue per l'operazione PUT. NamedValueCreateContractPropertiesOrNamedValueContractProperties

NamedValueCreateContractPropertiesOrNamedValueContractProperties

Nome Descrizione Valore
displayName Nome univoco di NamedValue. Può contenere solo lettere, cifre, punti, trattini e caratteri di sottolineatura. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[A-Za-z0-9-._]+$ (obbligatorio)
keyVault Dettagli della posizione dell'insieme di credenziali delle chiavi di namedValue. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
segreto Determina se il valore è un segreto e deve essere crittografato o meno. Il valore predefinito è false. Bool
Tag Tag facoltativi che, se specificati, possono essere usati per filtrare l'elenco NamedValue. string[]
valore Valore di NamedValue. Può contenere espressioni di criteri. Potrebbe non essere vuoto o costituito solo da spazi vuoti. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. corda

Vincoli:
Lunghezza massima =

Esempi di avvio rapido

Gli esempi di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Bicep File Descrizione
Frontdoor Standard/Premium con di origine di Gestione API Questo modello crea un'istanza di Frontdoor Premium e di Gestione API e usa un gruppo di sicurezza di rete e un criterio di Gestione API globale per verificare che il traffico provenga dall'origine di Frontdoor.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/namedValues 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/namedValues, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service/namedValues",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "secret": "bool",
    "tags": [ "string" ],
    "value": "string"
  }
}

Valori delle proprietà

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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. corda
secretIdentifier Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con controllo delle versioni, si impedisce l'aggiornamento automatico. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi corda

Microsoft.ApiManagement/service/namedValues

Nome Descrizione Valore
apiVersion Versione dell'API '2023-03-01-preview'
nome Nome della risorsa corda

Vincoli:
Lunghezza massima =
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
proprietà Proprietà del contratto di entità NamedValue per l'operazione PUT. NamedValueCreateContractPropertiesOrNamedValueContractProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/namedValues'

NamedValueCreateContractPropertiesOrNamedValueContractProperties

Nome Descrizione Valore
displayName Nome univoco di NamedValue. Può contenere solo lettere, cifre, punti, trattini e caratteri di sottolineatura. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[A-Za-z0-9-._]+$ (obbligatorio)
keyVault Dettagli della posizione dell'insieme di credenziali delle chiavi di namedValue. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
segreto Determina se il valore è un segreto e deve essere crittografato o meno. Il valore predefinito è false. Bool
Tag Tag facoltativi che, se specificati, possono essere usati per filtrare l'elenco NamedValue. string[]
valore Valore di NamedValue. Può contenere espressioni di criteri. Potrebbe non essere vuoto o costituito solo da spazi vuoti. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. corda

Vincoli:
Lunghezza massima =

Modelli di avvio rapido

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

Sagoma Descrizione
Frontdoor Standard/Premium con di origine di Gestione API

Distribuire in Azure 		Questo modello crea un'istanza di Frontdoor Premium e di Gestione API e usa un gruppo di sicurezza di rete e un criterio di Gestione API globale per verificare che il traffico provenga dall'origine di Frontdoor.

Definizione di 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 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@2023-03-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      secret = bool
      tags = [
        "string"
      ]
      value = "string"
    }
  })
}

Valori delle proprietà

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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. corda
secretIdentifier Identificatore del segreto dell'insieme di credenziali delle chiavi per il recupero del segreto. Se si specifica un segreto con controllo delle versioni, si impedisce l'aggiornamento automatico. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi corda

Microsoft.ApiManagement/service/namedValues

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza massima =
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
proprietà Proprietà del contratto di entità NamedValue per l'operazione PUT. NamedValueCreateContractPropertiesOrNamedValueContractProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/namedValues@2023-03-01-preview"

NamedValueCreateContractPropertiesOrNamedValueContractProperties

Nome Descrizione Valore
displayName Nome univoco di NamedValue. Può contenere solo lettere, cifre, punti, trattini e caratteri di sottolineatura. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[A-Za-z0-9-._]+$ (obbligatorio)
keyVault Dettagli della posizione dell'insieme di credenziali delle chiavi di namedValue. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
segreto Determina se il valore è un segreto e deve essere crittografato o meno. Il valore predefinito è false. Bool
Tag Tag facoltativi che, se specificati, possono essere usati per filtrare l'elenco NamedValue. string[]
valore Valore di NamedValue. Può contenere espressioni di criteri. Potrebbe non essere vuoto o costituito solo da spazi vuoti. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore. corda

Vincoli:
Lunghezza massima =