Servizio Microsoft.ApiManagement/workspaces/namedValues 2023-03-01-preview
Definizione di risorsa Bicep
Il tipo di risorsa service/workspaces/namedValues può essere distribuito con operazioni destinate:
- 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/workspaces/namedValues, aggiungere il bicep seguente al modello.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/namedValues@2023-03-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Valori delle proprietà
service/workspaces/namedValues
| 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 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 |
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa service/workspaces/namedValues può essere distribuito con operazioni destinate:
- 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/workspaces/namedValues, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.ApiManagement/service/workspaces/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à
service/workspaces/namedValues
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | 'Microsoft.ApiManagement/service/workspaces/namedValues' |
| 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) |
| 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 |
Definizione della risorsa Terraform (provider AzAPI)
Il tipo di risorsa service/workspaces/namedValues può essere distribuito con operazioni destinate:
- 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/namedValues, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/namedValues@2023-03-01-preview"
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/workspaces/namedValues
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | "Microsoft.ApiManagement/service/workspaces/namedValues@2023-03-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 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 |