Share via

Microsoft.Batch batchAccounts/certificates

Bicep resource definition

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

resource symbolicname 'Microsoft.Batch/batchAccounts/certificates@2024-07-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    data: 'string'
    format: 'string'
    password: 'string'
    thumbprint: 'string'
    thumbprintAlgorithm: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Batch/batchAccounts/certificates

Name Description Value
name The resource name string

Constraints:
Min length = 5
Max length = 45
Pattern = ^[\w]+-[\w]+$ (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: batchAccounts
properties The properties associated with the certificate. CertificateCreateOrUpdatePropertiesOrCertificateProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

AzureProxyResourceTags

Name Description Value

CertificateCreateOrUpdatePropertiesOrCertificateProperties

Name Description Value
data The maximum size is 10KB. string (required)
format The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. 'Cer'
'Pfx'
password This must not be specified if the certificate format is Cer. string

Constraints:
Sensitive value. Pass in as a secure parameter.
thumbprint This must match the thumbprint from the name. string
thumbprintAlgorithm This must match the first portion of the certificate name. Currently required to be 'SHA1'. string

ARM template resource definition

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

{
  "type": "Microsoft.Batch/batchAccounts/certificates",
  "apiVersion": "2024-07-01",
  "name": "string",
  "properties": {
    "data": "string",
    "format": "string",
    "password": "string",
    "thumbprint": "string",
    "thumbprintAlgorithm": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Batch/batchAccounts/certificates

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

Constraints:
Min length = 5
Max length = 45
Pattern = ^[\w]+-[\w]+$ (required)
properties The properties associated with the certificate. CertificateCreateOrUpdatePropertiesOrCertificateProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Batch/batchAccounts/certificates'

AzureProxyResourceTags

Name Description Value

CertificateCreateOrUpdatePropertiesOrCertificateProperties

Name Description Value
data The maximum size is 10KB. string (required)
format The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. 'Cer'
'Pfx'
password This must not be specified if the certificate format is Cer. string

Constraints:
Sensitive value. Pass in as a secure parameter.
thumbprint This must match the thumbprint from the name. string
thumbprintAlgorithm This must match the first portion of the certificate name. Currently required to be 'SHA1'. string

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Existing Azure Batch Service with Pfx from Keyvault

Deploy to Azure		 This template demostrates using Azure Batch service with pfx password certificate from keyvault

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts/certificates@2024-07-01"
  name = "string"
  parent_id = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      data = "string"
      format = "string"
      password = "string"
      thumbprint = "string"
      thumbprintAlgorithm = "string"
    }
  }
}

Property Values

Microsoft.Batch/batchAccounts/certificates

Name Description Value
name The resource name string

Constraints:
Min length = 5
Max length = 45
Pattern = ^[\w]+-[\w]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: batchAccounts
properties The properties associated with the certificate. CertificateCreateOrUpdatePropertiesOrCertificateProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Batch/batchAccounts/certificates@2024-07-01"

AzureProxyResourceTags

Name Description Value

CertificateCreateOrUpdatePropertiesOrCertificateProperties

Name Description Value
data The maximum size is 10KB. string (required)
format The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. 'Cer'
'Pfx'
password This must not be specified if the certificate format is Cer. string

Constraints:
Sensitive value. Pass in as a secure parameter.
thumbprint This must match the thumbprint from the name. string
thumbprintAlgorithm This must match the first portion of the certificate name. Currently required to be 'SHA1'. string