Service Microsoft.ApiManagement/namedValues 2021-08-01
Définition de ressource Bicep
Le type de ressource service/namedValues peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.ApiManagement/service/namedValues, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2021-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Valeurs de propriétés
service/namedValues
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep. |
string (obligatoire) |
| parent | Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente. |
Nom symbolique de la ressource de type : service |
| properties | Propriétés du contrat d’entité NamedValue pour l’opération PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Nom | Description | Valeur |
|---|---|---|
| displayName | Nom unique de NamedValue. Il peut contenir uniquement des lettres, des chiffres, des points, des tirets et des caractères de soulignement. | string (obligatoire) |
| keyVault | Détails de l’emplacement keyVault de la valeur nommée. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Détermine si la valeur est un secret et doit être chiffrée. La valeur par défaut est false. | bool |
| tags | Les balises facultatives qui, lorsqu’elles sont fournies, peuvent être utilisées pour filtrer la liste NamedValue. | string[] |
| value | Valeur de NamedValue. Peut contenir des expressions de stratégie. Elle ne peut pas être vide ni se composer uniquement d’espaces blancs. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur. | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nom | Description | Valeur |
|---|---|---|
| identityClientId | Null pour SystemAssignedIdentity ou ID client pour UserAssignedIdentity , qui sera utilisé pour accéder au secret du coffre de clés. | string |
| secretIdentifier | Identificateur du secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Pour cela, Gestion des API service doit être configuré avec aka.ms/apimmsi | string |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Front Door Standard/Premium avec origine Gestion des API |
Ce modèle crée un Front Door Premium et un Gestion des API instance, et utilise un groupe de sécurité réseau et une stratégie de Gestion des API globale pour vérifier que le trafic a transité par l’origine de Front Door. |
Définition de ressources de modèle ARM
Le type de ressource service/namedValues peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.ApiManagement/service/namedValues, ajoutez le JSON suivant à votre modèle.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2021-08-01",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Valeurs de propriétés
service/namedValues
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft.ApiManagement/service/namedValues' |
| apiVersion | Version de l’API de ressource | '2021-08-01' |
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON. |
string (obligatoire) |
| properties | Propriétés du contrat d’entité NamedValue pour l’opération PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Nom | Description | Valeur |
|---|---|---|
| displayName | Nom unique de NamedValue. Il peut contenir uniquement des lettres, des chiffres, des points, des tirets et des caractères de soulignement. | string (obligatoire) |
| keyVault | Détails de l’emplacement keyVault de la valeur nommée. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Détermine si la valeur est un secret et doit être chiffrée. La valeur par défaut est false. | bool |
| tags | Les balises facultatives qui, lorsqu’elles sont fournies, peuvent être utilisées pour filtrer la liste NamedValue. | string[] |
| value | Valeur de NamedValue. Peut contenir des expressions de stratégie. Elle ne peut pas être vide ni se composer uniquement d’espaces blancs. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur. | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nom | Description | Valeur |
|---|---|---|
| identityClientId | Null pour SystemAssignedIdentity ou ID client pour UserAssignedIdentity , qui sera utilisé pour accéder au secret du coffre de clés. | string |
| secretIdentifier | Identificateur du secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Pour cela, Gestion des API service doit être configuré avec aka.ms/apimmsi | string |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
| Front Door Standard/Premium avec origine Gestion des API |
Ce modèle crée un Front Door Premium et un Gestion des API instance, et utilise un groupe de sécurité réseau et une stratégie de Gestion des API globale pour vérifier que le trafic a transité par l’origine de Front Door. |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource service/namedValues peut être déployé avec des opérations qui ciblent :
- Groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.ApiManagement/service/namedValues, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2021-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Valeurs de propriétés
service/namedValues
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ApiManagement/service/namedValues@2021-08-01 » |
| name | Nom de la ressource | string (obligatoire) |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : service |
| properties | Propriétés du contrat d’entité NamedValue pour l’opération PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Nom | Description | Valeur |
|---|---|---|
| displayName | Nom unique de NamedValue. Il peut contenir uniquement des lettres, des chiffres, des points, des tirets et des caractères de soulignement. | string (obligatoire) |
| keyVault | Détails de l’emplacement keyVault de la valeur nommée. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Détermine si la valeur est un secret et doit être chiffrée. La valeur par défaut est false. | bool |
| tags | Les balises facultatives qui, lorsqu’elles sont fournies, peuvent être utilisées pour filtrer la liste NamedValue. | string[] |
| value | Valeur de NamedValue. Peut contenir des expressions de stratégie. Elle ne peut pas être vide ni se composer uniquement d’espaces blancs. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur. | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nom | Description | Valeur |
|---|---|---|
| identityClientId | Null pour SystemAssignedIdentity ou ID client pour UserAssignedIdentity , qui sera utilisé pour accéder au secret du coffre de clés. | string |
| secretIdentifier | Identificateur du secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Pour cela, Gestion des API service doit être configuré avec aka.ms/apimmsi | string |