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 - Consultez commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
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é
service/namedValues
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep. |
chaîne (obligatoire) |
| parent | Dans Bicep, vous pouvez spécifier la ressource parente d’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 |
| Propriétés | 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. | chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 256 Modèle = ^[A-Za-z0-9-._]+$ |
| 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 ou non. La valeur par défaut est false. | Bool |
| étiquettes | Balises facultatives qui, lorsqu’elles sont fournies, peuvent être utilisées pour filtrer la liste NamedValue. | string[] Contraintes: Longueur maximale = 32 |
| valeur | Valeur de la valeur NamedValue. Peut contenir des expressions de stratégie. Il ne peut pas être vide ou 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. | corde Contraintes: Longueur maximale = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nom | Description | Valeur |
|---|---|---|
| identityClientId | Null pour SystemAssignedIdentity ou l’ID client pour UserAssignedIdentity, qui sera utilisé pour accéder au secret du coffre de clés. | corde |
| secretIdentifier | Identificateur de secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Cela nécessite que le service Gestion des API soit configuré avec aka.ms/apimmsi | corde |
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 l’origine gestion des API
|
Ce modèle crée une instance Front Door Premium et gestion des API et utilise un groupe de sécurité réseau et une stratégie de gestion des API globale pour vérifier que le trafic est passé par l’origine Front Door. |
Définition de ressource de modèle ARM
Le type de ressource service/namedValues peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.ApiManagement/service/namedValues, ajoutez le code 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é
service/namedValues
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft.ApiManagement/service/namedValues' |
| apiVersion | Version de l’API de ressource | '2021-08-01' |
| nom | Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON. |
chaîne (obligatoire) |
| Propriétés | 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. | chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 256 Modèle = ^[A-Za-z0-9-._]+$ |
| 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 ou non. La valeur par défaut est false. | Bool |
| étiquettes | Balises facultatives qui, lorsqu’elles sont fournies, peuvent être utilisées pour filtrer la liste NamedValue. | string[] Contraintes: Longueur maximale = 32 |
| valeur | Valeur de la valeur NamedValue. Peut contenir des expressions de stratégie. Il ne peut pas être vide ou 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. | corde Contraintes: Longueur maximale = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nom | Description | Valeur |
|---|---|---|
| identityClientId | Null pour SystemAssignedIdentity ou l’ID client pour UserAssignedIdentity, qui sera utilisé pour accéder au secret du coffre de clés. | corde |
| secretIdentifier | Identificateur de secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Cela nécessite que le service Gestion des API soit configuré avec aka.ms/apimmsi | corde |
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 l’origine gestion des API
|
Ce modèle crée une instance Front Door Premium et gestion des API et utilise un groupe de sécurité réseau et une stratégie de gestion des API globale pour vérifier que le trafic est passé par l’origine 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 de l’API, consultez journal des modifications.
Format de ressource
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é
service/namedValues
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ApiManagement/service/namedValues@2021-08-01 » |
| nom | Nom de la ressource | chaîne (obligatoire) |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : de service |
| Propriétés | 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. | chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 256 Modèle = ^[A-Za-z0-9-._]+$ |
| 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 ou non. La valeur par défaut est false. | Bool |
| étiquettes | Balises facultatives qui, lorsqu’elles sont fournies, peuvent être utilisées pour filtrer la liste NamedValue. | string[] Contraintes: Longueur maximale = 32 |
| valeur | Valeur de la valeur NamedValue. Peut contenir des expressions de stratégie. Il ne peut pas être vide ou 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. | corde Contraintes: Longueur maximale = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nom | Description | Valeur |
|---|---|---|
| identityClientId | Null pour SystemAssignedIdentity ou l’ID client pour UserAssignedIdentity, qui sera utilisé pour accéder au secret du coffre de clés. | corde |
| secretIdentifier | Identificateur de secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Cela nécessite que le service Gestion des API soit configuré avec aka.ms/apimmsi | corde |