Share via

Microsoft.Automation automationAccounts/connections 2022-08-08

Bicep resource definition

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

resource symbolicname 'Microsoft.Automation/automationAccounts/connections@2022-08-08' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    connectionType: {
      name: 'string'
    }
    description: 'string'
    fieldDefinitionValues: {
      {customized property}: 'string'
    }
  }
}

Property Values

Microsoft.Automation/automationAccounts/connections

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 connection. ConnectionCreateOrUpdatePropertiesOrConnectionProperties (required)

ConnectionCreateOrUpdatePropertiesFieldDefinitionValues

Name Description Value

ConnectionCreateOrUpdatePropertiesOrConnectionProperties

Name Description Value
connectionType Gets or sets the connectionType of the connection. ConnectionTypeAssociationProperty (required)
description Gets or sets the description of the connection. string
fieldDefinitionValues Gets or sets the field definition properties of the connection. ConnectionCreateOrUpdatePropertiesFieldDefinitionValues

ConnectionTypeAssociationProperty

Name Description Value
name Gets or sets the name of the connection type. string

ARM template resource definition

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

{
  "type": "Microsoft.Automation/automationAccounts/connections",
  "apiVersion": "2022-08-08",
  "name": "string",
  "properties": {
    "connectionType": {
      "name": "string"
    },
    "description": "string",
    "fieldDefinitionValues": {
      "{customized property}": "string"
    }
  }
}

Property Values

Microsoft.Automation/automationAccounts/connections

Name Description Value
apiVersion The api version '2022-08-08'
name The resource name string (required)
properties Gets or sets the properties of the connection. ConnectionCreateOrUpdatePropertiesOrConnectionProperties (required)
type The resource type 'Microsoft.Automation/automationAccounts/connections'

ConnectionCreateOrUpdatePropertiesFieldDefinitionValues

Name Description Value

ConnectionCreateOrUpdatePropertiesOrConnectionProperties

Name Description Value
connectionType Gets or sets the connectionType of the connection. ConnectionTypeAssociationProperty (required)
description Gets or sets the description of the connection. string
fieldDefinitionValues Gets or sets the field definition properties of the connection. ConnectionCreateOrUpdatePropertiesFieldDefinitionValues

ConnectionTypeAssociationProperty

Name Description Value
name Gets or sets the name of the connection type. string

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Automation/automationAccounts/connections@2022-08-08"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      connectionType = {
        name = "string"
      }
      description = "string"
      fieldDefinitionValues = {
        {customized property} = "string"
      }
    }
  }
}

Property Values

Microsoft.Automation/automationAccounts/connections

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 connection. ConnectionCreateOrUpdatePropertiesOrConnectionProperties (required)
type The resource type "Microsoft.Automation/automationAccounts/connections@2022-08-08"

ConnectionCreateOrUpdatePropertiesFieldDefinitionValues

Name Description Value

ConnectionCreateOrUpdatePropertiesOrConnectionProperties

Name Description Value
connectionType Gets or sets the connectionType of the connection. ConnectionTypeAssociationProperty (required)
description Gets or sets the description of the connection. string
fieldDefinitionValues Gets or sets the field definition properties of the connection. ConnectionCreateOrUpdatePropertiesFieldDefinitionValues

ConnectionTypeAssociationProperty

Name Description Value
name Gets or sets the name of the connection type. string