Microsoft.ApiManagement service/namedValues
Bicep resource definition
The service/namedValues resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/namedValues resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Property values
service/namedValues
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: service |
| properties | NamedValue entity contract properties for PUT operation. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Name | Description | Value |
|---|---|---|
| displayName | Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. | string (required) Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| keyVault | KeyVault location details of the namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Determines whether the value is a secret and should be encrypted or not. Default value is false. | bool |
| tags | Optional tags that when provided can be used to filter the NamedValue list. | string[] Constraints: Max length = 32 |
| value | Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | string Constraints: Max length = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Name | Description | Value |
|---|---|---|
| identityClientId | Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. | string |
| secretIdentifier | Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Front Door Standard/Premium with API Management origin |
This template creates a Front Door Premium and an API Management instance, and uses an NSG and global API Management policy to validate that traffic has come through the Front Door origin. |
ARM template resource definition
The service/namedValues resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/namedValues resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Property values
service/namedValues
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/service/namedValues' |
| apiVersion | The resource api version | '2023-09-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | NamedValue entity contract properties for PUT operation. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Name | Description | Value |
|---|---|---|
| displayName | Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. | string (required) Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| keyVault | KeyVault location details of the namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Determines whether the value is a secret and should be encrypted or not. Default value is false. | bool |
| tags | Optional tags that when provided can be used to filter the NamedValue list. | string[] Constraints: Max length = 32 |
| value | Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | string Constraints: Max length = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Name | Description | Value |
|---|---|---|
| identityClientId | Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. | string |
| secretIdentifier | Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Front Door Standard/Premium with API Management origin |
This template creates a Front Door Premium and an API Management instance, and uses an NSG and global API Management policy to validate that traffic has come through the Front Door origin. |
Terraform (AzAPI provider) resource definition
The service/namedValues resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/namedValues resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Property values
service/namedValues
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/namedValues@2023-09-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service |
| properties | NamedValue entity contract properties for PUT operation. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Name | Description | Value |
|---|---|---|
| displayName | Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. | string (required) Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ |
| keyVault | KeyVault location details of the namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Determines whether the value is a secret and should be encrypted or not. Default value is false. | bool |
| tags | Optional tags that when provided can be used to filter the NamedValue list. | string[] Constraints: Max length = 32 |
| value | Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. | string Constraints: Max length = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Name | Description | Value |
|---|---|---|
| identityClientId | Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. | string |
| secretIdentifier | Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi | string |