Microsoft.Web sites/publicCertificates 2020-10-01

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Web/sites/publicCertificates@2020-10-01' = {
  name: 'string'
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    blob: any()
    publicCertificateLocation: 'string'
  }
}

Property values

sites/publicCertificates

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
kind Kind of resource. string
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: sites
properties PublicCertificate resource specific properties PublicCertificateProperties

PublicCertificateProperties

Name Description Value
blob Public Certificate byte array For Bicep, you can use the any() function.
publicCertificateLocation Public Certificate Location 'CurrentUserMy'
'LocalMachineMy'
'Unknown'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Install Public Certificate in App Service

Deploy to Azure		 Install a Public Certificate in App Service. Once a public certificate is installed by deploying this template, it would be accessible to App Service code for consumption. This is supported only on dedicated App Service Plans. If your App Service is hosted on a public scale unit then you can only install certificates in CurrentUser-Personal certificate store. For App Service Environments, LocalMachine-Personal certificate store is also supported

ARM template resource definition

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

{
  "type": "Microsoft.Web/sites/publicCertificates",
  "apiVersion": "2020-10-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "blob": {},
    "publicCertificateLocation": "string"
  }
}

Property values

sites/publicCertificates

Name Description Value
type The resource type 'Microsoft.Web/sites/publicCertificates'
apiVersion The resource api version '2020-10-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
kind Kind of resource. string
properties PublicCertificate resource specific properties PublicCertificateProperties

PublicCertificateProperties

Name Description Value
blob Public Certificate byte array
publicCertificateLocation Public Certificate Location 'CurrentUserMy'
'LocalMachineMy'
'Unknown'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Install Public Certificate in App Service

Deploy to Azure		 Install a Public Certificate in App Service. Once a public certificate is installed by deploying this template, it would be accessible to App Service code for consumption. This is supported only on dedicated App Service Plans. If your App Service is hosted on a public scale unit then you can only install certificates in CurrentUser-Personal certificate store. For App Service Environments, LocalMachine-Personal certificate store is also supported

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/publicCertificates@2020-10-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      publicCertificateLocation = "string"
    }
    kind = "string"
  })
}

Property values

sites/publicCertificates

Name Description Value
type The resource type "Microsoft.Web/sites/publicCertificates@2020-10-01"
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: sites
kind Kind of resource. string
properties PublicCertificate resource specific properties PublicCertificateProperties

PublicCertificateProperties

Name Description Value
blob Public Certificate byte array
publicCertificateLocation Public Certificate Location "CurrentUserMy"
"LocalMachineMy"
"Unknown"