Microsoft.ApiManagement service/workspaces/namedValues

ARM template resource definition

The service/workspaces/namedValues resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.ApiManagement/service/workspaces/namedValues",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "secret": "bool",
    "tags": [ "string" ],
    "value": "string"
  }
}

Property values

service/workspaces/namedValues

Name Description Value
type The resource type 'Microsoft.ApiManagement/service/workspaces/namedValues'
apiVersion The resource api version '2023-05-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)
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[]
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

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