Share via

Microsoft.ApiManagement service/properties 2016-07-07

Bicep resource definition

The service/properties 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/properties resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/properties@2016-07-07' = {
  parent: resourceSymbolicName
  name: 'string'
  secret: bool
  tags: [
    'string'
  ]
  value: 'string'
}

Property Values

Microsoft.ApiManagement/service/properties

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
secret Determines whether the value is a secret and should be encrypted or not. Default value is false. bool
tags Resource tags Dictionary of tag names and values. See Tags in templates
value Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. string

Constraints:
Min length = 1
Max length = 4096 (required)

ARM template resource definition

The service/properties 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/properties resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/properties",
  "apiVersion": "2016-07-07",
  "name": "string",
  "secret": "bool",
  "tags": [ "string" ],
  "value": "string"
}

Property Values

Microsoft.ApiManagement/service/properties

Name Description Value
apiVersion The api version '2016-07-07'
name The resource name string

Constraints:
Max length = 256
Pattern = ^[^*#&+:<>?]+$ (required)
secret Determines whether the value is a secret and should be encrypted or not. Default value is false. bool
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.ApiManagement/service/properties'
value Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. string

Constraints:
Min length = 1
Max length = 4096 (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The service/properties 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/properties resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/properties@2016-07-07"
  name = "string"
  parent_id = "string"
  tags = [
    "string"
  ]
  body = {
    secret = bool
    value = "string"
  }
}

Property Values

Microsoft.ApiManagement/service/properties

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
secret Determines whether the value is a secret and should be encrypted or not. Default value is false. bool
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.ApiManagement/service/properties@2016-07-07"
value Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. string

Constraints:
Min length = 1
Max length = 4096 (required)