Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The service/workspaces/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/workspaces/namedValues resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/namedValues@2023-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Property Values
Microsoft.ApiManagement/service/workspaces/namedValues
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Max length = 256 Pattern = ^[^*#&+:<>?]+$ (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/workspaces |
| properties | NamedValue entity contract properties for PUT operation. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 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 |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Name | Description | Value |
|---|---|---|
| displayName | Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. | string Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ (required) |
| keyVault | KeyVault location details of the namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| 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 Constraints: Max length = 4096 |
ARM template resource definition
The service/workspaces/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/workspaces/namedValues resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/workspaces/namedValues",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Property Values
Microsoft.ApiManagement/service/workspaces/namedValues
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-09-01-preview' |
| name | The resource name | string Constraints: Max length = 256 Pattern = ^[^*#&+:<>?]+$ (required) |
| properties | NamedValue entity contract properties for PUT operation. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/workspaces/namedValues' |
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 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 |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Name | Description | Value |
|---|---|---|
| displayName | Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. | string Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ (required) |
| keyVault | KeyVault location details of the namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| 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 Constraints: Max length = 4096 |
Usage Examples
Terraform (AzAPI provider) resource definition
The service/workspaces/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/workspaces/namedValues resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/namedValues@2023-09-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
}
}
Property Values
Microsoft.ApiManagement/service/workspaces/namedValues
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Max length = 256 Pattern = ^[^*#&+:<>?]+$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: service/workspaces |
| properties | NamedValue entity contract properties for PUT operation. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| type | The resource type | "Microsoft.ApiManagement/service/workspaces/namedValues@2023-09-01-preview" |
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 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 |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Name | Description | Value |
|---|---|---|
| displayName | Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. | string Constraints: Min length = 1 Max length = 256 Pattern = ^[A-Za-z0-9-._]+$ (required) |
| keyVault | KeyVault location details of the namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| 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 Constraints: Max length = 4096 |