NamedValueContract interface

Package:

@azure/arm-apimanagement

NamedValue details.

Extends

ProxyResource

Properties

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

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

displayName

Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.

displayName?: string

Property Value

string

keyVault

KeyVault location details of the namedValue.

keyVault?: KeyVaultContractProperties

Property Value

KeyVaultContractProperties

secret

Determines whether the value is a secret and should be encrypted or not. Default value is false.

secret?: boolean

Property Value

boolean

tags

Optional tags that when provided can be used to filter the NamedValue list.

tags?: string[]

Property Value

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.

value?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type