Share via

Microsoft.App managedEnvironments/certificates 2023-11-02-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.App/managedEnvironments/certificates@2023-11-02-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    certificateKeyVaultProperties: {
      identity: 'string'
      keyVaultUrl: 'string'
    }
    certificateType: 'string'
    password: 'string'
    value: any()
  }
}

Property values

managedEnvironments/certificates

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
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: managedEnvironments
properties Certificate resource specific properties CertificateProperties

CertificateProperties

Name Description Value
certificateKeyVaultProperties Properties for a certificate stored in a Key Vault. CertificateKeyVaultProperties
certificateType The type of the certificate. Allowed values are ServerSSLCertificate and ImagePullTrustedCA 'ImagePullTrustedCA'
'ServerSSLCertificate'
password Certificate password. string

Constraints:
Sensitive value. Pass in as a secure parameter.
value PFX or PEM blob For Bicep, you can use the any() function.

CertificateKeyVaultProperties

Name Description Value
identity Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. string
keyVaultUrl URL pointing to the Azure Key Vault secret that holds the certificate. string

ARM template resource definition

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

{
  "type": "Microsoft.App/managedEnvironments/certificates",
  "apiVersion": "2023-11-02-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "certificateKeyVaultProperties": {
      "identity": "string",
      "keyVaultUrl": "string"
    },
    "certificateType": "string",
    "password": "string",
    "value": {}
  }
}

Property values

managedEnvironments/certificates

Name Description Value
type The resource type 'Microsoft.App/managedEnvironments/certificates'
apiVersion The resource api version '2023-11-02-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Certificate resource specific properties CertificateProperties

CertificateProperties

Name Description Value
certificateKeyVaultProperties Properties for a certificate stored in a Key Vault. CertificateKeyVaultProperties
certificateType The type of the certificate. Allowed values are ServerSSLCertificate and ImagePullTrustedCA 'ImagePullTrustedCA'
'ServerSSLCertificate'
password Certificate password. string

Constraints:
Sensitive value. Pass in as a secure parameter.
value PFX or PEM blob

CertificateKeyVaultProperties

Name Description Value
identity Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. string
keyVaultUrl URL pointing to the Azure Key Vault secret that holds the certificate. string

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/managedEnvironments/certificates@2023-11-02-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      certificateKeyVaultProperties = {
        identity = "string"
        keyVaultUrl = "string"
      }
      certificateType = "string"
      password = "string"
    }
  })
}

Property values

managedEnvironments/certificates

Name Description Value
type The resource type "Microsoft.App/managedEnvironments/certificates@2023-11-02-preview"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: managedEnvironments
tags Resource tags. Dictionary of tag names and values.
properties Certificate resource specific properties CertificateProperties

CertificateProperties

Name Description Value
certificateKeyVaultProperties Properties for a certificate stored in a Key Vault. CertificateKeyVaultProperties
certificateType The type of the certificate. Allowed values are ServerSSLCertificate and ImagePullTrustedCA "ImagePullTrustedCA"
"ServerSSLCertificate"
password Certificate password. string

Constraints:
Sensitive value. Pass in as a secure parameter.
value PFX or PEM blob

CertificateKeyVaultProperties

Name Description Value
identity Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. string
keyVaultUrl URL pointing to the Azure Key Vault secret that holds the certificate. string