Microsoft.Automation automationAccounts/credentials

Bicep resource definition

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

resource symbolicname 'Microsoft.Automation/automationAccounts/credentials@2024-10-23' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    password: 'string'
    userName: 'string'
  }
}

Property Values

Microsoft.Automation/automationAccounts/credentials

Name Description Value
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: automationAccounts
properties Gets or sets the properties of the credential. CredentialCreateOrUpdatePropertiesOrCredentialProperties (required)

CredentialCreateOrUpdatePropertiesOrCredentialProperties

Name Description Value
description Gets or sets the description of the credential. string
password Gets or sets the password of the credential. string (required)
userName Gets or sets the user name of the credential. string (required)

Usage Examples

Bicep Samples

A basic example of deploying Automation Credential.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@secure()
@description('The password for the automation account credential')
param automationCredentialPassword string

resource automationAccount 'Microsoft.Automation/automationAccounts@2021-06-22' = {
  name: resourceName
  location: location
  properties: {
    encryption: {
      keySource: 'Microsoft.Automation'
    }
    publicNetworkAccess: true
    sku: {
      name: 'Basic'
    }
  }
}

resource credential 'Microsoft.Automation/automationAccounts/credentials@2020-01-13-preview' = {
  parent: automationAccount
  name: resourceName
  properties: {
    description: ''
    password: null
    userName: 'test_user'
  }
}

ARM template resource definition

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

{
  "type": "Microsoft.Automation/automationAccounts/credentials",
  "apiVersion": "2024-10-23",
  "name": "string",
  "properties": {
    "description": "string",
    "password": "string",
    "userName": "string"
  }
}

Property Values

Microsoft.Automation/automationAccounts/credentials

Name Description Value
apiVersion The api version '2024-10-23'
name The resource name string (required)
properties Gets or sets the properties of the credential. CredentialCreateOrUpdatePropertiesOrCredentialProperties (required)
type The resource type 'Microsoft.Automation/automationAccounts/credentials'

CredentialCreateOrUpdatePropertiesOrCredentialProperties

Name Description Value
description Gets or sets the description of the credential. string
password Gets or sets the password of the credential. string (required)
userName Gets or sets the user name of the credential. string (required)

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Azure Resource Optimization (ARO) Toolkit

Deploy to Azure		 The Azure Resource Optimization Toolkit is a decentralized, native Azure solution using serverless technologies to optimize Azure resources on your subscription. Optimization happens automatically on your subscription once you enable or create your own schedule, including on new resources. This is an Azure Automation account with preconfigured runbooks and schedules you can utilize on your subscription to start saving money.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/credentials@2024-10-23"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      password = "string"
      userName = "string"
    }
  }
}

Property Values

Microsoft.Automation/automationAccounts/credentials

Name Description Value
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: automationAccounts
properties Gets or sets the properties of the credential. CredentialCreateOrUpdatePropertiesOrCredentialProperties (required)
type The resource type "Microsoft.Automation/automationAccounts/credentials@2024-10-23"

CredentialCreateOrUpdatePropertiesOrCredentialProperties

Name Description Value
description Gets or sets the description of the credential. string
password Gets or sets the password of the credential. string (required)
userName Gets or sets the user name of the credential. string (required)

Usage Examples

Terraform Samples

A basic example of deploying Automation Credential.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "automation_credential_password" {
  type        = string
  description = "The password for the automation account credential"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "automationAccount" {
  type      = "Microsoft.Automation/automationAccounts@2021-06-22"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      encryption = {
        keySource = "Microsoft.Automation"
      }
      publicNetworkAccess = true
      sku = {
        name = "Basic"
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "credential" {
  type      = "Microsoft.Automation/automationAccounts/credentials@2020-01-13-preview"
  parent_id = azapi_resource.automationAccount.id
  name      = var.resource_name
  body = {
    properties = {
      description = ""
      password    = var.automation_credential_password
      userName    = "test_user"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on