Microsoft.ApiManagement service/namedValues 2021-01-01-preview

The service/namedValues resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.ApiManagement/service/namedValues resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2021-01-01-preview' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    displayName: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    secret: bool
    tags: [ 'string' ]
      tagName1: 'tagValue1'
      tagName2: 'tagValue2'
    }
    value: 'string'
  }
}

Property values

service/namedValues

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ApiManagement/service/namedValues'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-01-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
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.
parentSymbolicName
properties NamedValue Contract properties. NamedValueCreateContractProperties

NamedValueCreateContractProperties

Name Description Value
displayName Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. string (required)
keyVault KeyVault contract details. KeyVaultContractCreateProperties
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[]
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

KeyVaultContractCreateProperties

Name Description Value
identityClientId SystemAssignedIdentity or UserAssignedIdentity Client Id 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

Deploy to Azure
This template creates a Front Door Premium (Preview) 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.