Share via

Microsoft.App connectedEnvironments/certificates 2024-08-02-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.App/connectedEnvironments/certificates@2024-08-02-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    certificateKeyVaultProperties: {
      identity: 'string'
      keyVaultUrl: 'string'
    }
    certificateType: 'string'
    password: 'string'
    value: any(Azure.Bicep.Types.Concrete.AnyType)
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

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

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 any

Microsoft.App/connectedEnvironments/certificates

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (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: connectedEnvironments
properties Certificate resource specific properties CertificateProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

TrackedResourceTags

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.App/connectedEnvironments/certificates",
  "apiVersion": "2024-08-02-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "certificateKeyVaultProperties": {
      "identity": "string",
      "keyVaultUrl": "string"
    },
    "certificateType": "string",
    "password": "string",
    "value": {}
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

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

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 any

Microsoft.App/connectedEnvironments/certificates

Name Description Value
apiVersion The api version '2024-08-02-preview'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Certificate resource specific properties CertificateProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.App/connectedEnvironments/certificates'

TrackedResourceTags

Name Description Value

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/connectedEnvironments/certificates@2024-08-02-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      certificateKeyVaultProperties = {
        identity = "string"
        keyVaultUrl = "string"
      }
      certificateType = "string"
      password = "string"
      value = ?
    }
  })
}

Property values

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

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 any

Microsoft.App/connectedEnvironments/certificates

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

TrackedResourceTags

Name Description Value