Microsoft.ApiManagement service/namedValues

Template format

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

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

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ApiManagement/service/namedValues object

Name Type Required Value
name string Yes Identifier of the NamedValue.
type enum Yes namedValues
-or-
Microsoft.ApiManagement/service/namedValues

See Set name and type for child resources.
apiVersion enum Yes 2020-06-01-preview
properties object Yes NamedValue entity contract properties for PUT operation. - NamedValueCreateContractProperties object

NamedValueCreateContractProperties object

Name Type Required Value
tags array No Optional tags that when provided can be used to filter the NamedValue list. - string
secret boolean No Determines whether the value is a secret and should be encrypted or not. Default value is false.
displayName string Yes Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
value string No 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.
keyVault object No KeyVault location details of the namedValue. - KeyVaultContractCreateProperties object

KeyVaultContractCreateProperties object

Name Type Required Value
secretIdentifier string No Key vault secret identifier for fetching secret.
identityClientId string No SystemAssignedIdentity or UserAssignedIdentity Client Id which will be used to access key vault secret.