Microsoft.Automation/automationAccounts - registrationUrl property is not documented

[smthbh]

Reported here: Azure/bicep#784 (comment)

This property is used in the DSC template example here:
https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/dsc-template

It is also used in the quickstart here:
https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.automation/automation-configuration/nested/provisionServer.json

azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/account.json

Lines 592 to 619 in aa02377

	"AutomationAccountCreateOrUpdateParameters": {
	"properties": {
	"properties": {
	"$ref": "#/definitions/AutomationAccountCreateOrUpdateProperties",
	"x-ms-client-flatten": true,
	"description": "Gets or sets account create or update properties."
	},
	"name": {
	"type": "string",
	"description": "Gets or sets name of the resource."
	},
	"location": {
	"type": "string",
	"description": "Gets or sets the location of the resource."
	},
	"identity": {
	"type": "object",
	"$ref": "#/definitions/Identity",
	"description": "Sets the identity property for automation account"
	},
	"tags": {
	"type": "object",
	"additionalProperties": {
	"type": "string"
	},
	"description": "Gets or sets the tags attached to the resource."
	}
	},

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @jaspkaur28.

Issue Details

---

Reported here: Azure/bicep#784 (comment)

This property is used in the DSC template example here:
https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/dsc-template

It is also used in the quickstart here:
https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.automation/automation-configuration/nested/provisionServer.json

azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2021-06-22/account.json

Lines 592 to 619 in aa02377

	"AutomationAccountCreateOrUpdateParameters": {
	"properties": {
	"properties": {
	"$ref": "#/definitions/AutomationAccountCreateOrUpdateProperties",
	"x-ms-client-flatten": true,
	"description": "Gets or sets account create or update properties."
	},
	"name": {
	"type": "string",
	"description": "Gets or sets name of the resource."
	},
	"location": {
	"type": "string",
	"description": "Gets or sets the location of the resource."
	},
	"identity": {
	"type": "object",
	"$ref": "#/definitions/Identity",
	"description": "Sets the identity property for automation account"
	},
	"tags": {
	"type": "object",
	"additionalProperties": {
	"type": "string"
	},
	"description": "Gets or sets the tags attached to the resource."
	}
	},

Author:	smthbh
Assignees:	-
Labels:	question, Automation, Service Attention, customer-reported, needs-triage
Milestone:	-

[chsamala2]

In both examples , registrationUrl is read only property, This property can't be modified hence we can't keep in the "AutomationAccountCreateOrUpdateParameters"

[jmservera]

In both examples , registrationUrl is read only property, This property can't be modified hence we can't keep in the "AutomationAccountCreateOrUpdateParameters"

As commented in the bicep - missing type validation, this issue happens when reading the property from bicep. For example, the following code:

resource vmExtension 'Microsoft.Compute/virtualMachines/extensions@2021-11-01' = {
  parent: vm
  location: location

  name: 'Microsoft.Powershell.DSC'
  properties: {
    publisher: 'Microsoft.Powershell'
    type: 'DSC'
    typeHandlerVersion: '2.76'
    autoUpgradeMinorVersion: true
    protectedSettings: {
      Items: {
        registrationKeyPrivate: listKeys(automationAccount.id, '2021-06-22').Keys[0].value
      }
    }
    settings: {
      Properties: [
        {
          Name: 'RegistrationKey'
          Value: {
            UserName: 'PLACEHOLDER_DONOTUSE'
            Password: 'PrivateSettingsRef:registrationKeyPrivate'
          }
          TypeName: 'System.Management.Automation.PSCredential'
        }
        {
          Name: 'RegistrationUrl'
          Value: automationAccount.properties.registrationUrl
          TypeName: 'System.String'
        }
        {
          Name: 'NodeConfigurationName'
          Value: nodeConfigurationName
          TypeName: 'System.String'
        }
        {
          Name: 'ConfigurationMode'
          Value: 'ApplyandAutoCorrect'
          TypeName: 'System.String'
        }
        {
          Name: 'RebootNodeIfNeeded'
          Value: true
          TypeName: 'System.Boolean'
        }
        {
          Name: 'ActionAfterReboot'
          Value: 'ContinueConfiguration'
          TypeName: 'System.String'
        }
      ]
    }
  }
  dependsOn: [
    provisionConfiguration
  ]
}

Gives this warning:

Warning BCP053: The type "AutomationAccountCreateOrUpdateProperties" does not contain property "registrationUrl". Available properties include "automationHybridServiceUrl", "creationTime", "description", "disableLocalAuth", "encryption", "lastModifiedBy", "lastModifiedTime", "privateEndpointConnections", "publicNetworkAccess", "sku", "state".

[bdanse]

Should registrationUrl be part of AutomationAccountProperties. like automationHybridServiceUrl also a readonly property.

azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2022-08-08/account.json

Lines 495 to 559 in 7824f04

	"AutomationAccountProperties": {
	"properties": {
	"sku": {
	"$ref": "#/definitions/Sku",
	"description": "Gets or sets the SKU of account."
	},
	"lastModifiedBy": {
	"type": "string",
	"description": "Gets or sets the last modified by."
	},
	"state": {
	"type": "string",
	"readOnly": true,
	"description": "Gets status of account.",
	"enum": [
	"Ok",
	"Unavailable",
	"Suspended"
	],
	"x-ms-enum": {
	"name": "AutomationAccountState",
	"modelAsString": true
	}
	},
	"creationTime": {
	"type": "string",
	"format": "date-time",
	"readOnly": true,
	"description": "Gets the creation time.",
	"x-nullable": false
	},
	"lastModifiedTime": {
	"type": "string",
	"format": "date-time",
	"readOnly": true,
	"description": "Gets the last modified time.",
	"x-nullable": false
	},
	"description": {
	"type": "string",
	"description": "Gets or sets the description."
	},
	"encryption": {
	"$ref": "#/definitions/EncryptionProperties",
	"description": "Encryption properties for the automation account"
	},
	"privateEndpointConnections": {
	"type": "array",
	"items": {
	"$ref": "../../common/v1/definitions.json#/definitions/PrivateEndpointConnection"
	},
	"description": "List of Automation operations supported by the Automation resource provider."
	},
	"publicNetworkAccess": {
	"type": "boolean",
	"description": "Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet"
	},
	"disableLocalAuth": {
	"type": "boolean",
	"description": "Indicates whether requests using non-AAD authentication are blocked"
	},
	"automationHybridServiceUrl": {
	"type": "string",
	"description": "URL of automation hybrid service which is used for hybrid worker on-boarding."
	}