Resource Type Editing

The Azure Naming was created to assist in the creation and administration of naming conventions for Azure resources. The tool relies heavily on specific resource type metadata to ensure generated names adhere to the varying standards and restrictions for Azure resources. The Azure Naming Tool team has continued to curate this metadata and ensure it was as up to date as possible.

As Resource Types are constantly changed and being added, the Azure Naming Tool has been updated with the ability to manually edit resource type metadata, if needed.

ATTENTION Resource Type settings are configured by the Azure Naming Tool team and match the Azure portal validation requirements. Overriding these values may result in invalid names for a resource.

This article details the Resource Type metadata and it's use within the Azure Naming Tool.

Resource

This field details the Azure service resourceProvider, service, and (sometimes) feature for the Resource Type. The feature value is not always present, as many Resource Types only have a resourceProvder and service specified.

All Resource Types contain a resourceProvider / service and the Aure Naming Tool requires the data in the following format:

[resourceProvider]/[service]/[feature]....

Example: ApiManagement/service/backends

Short Name

This field is the short name for the Resource Type that will be used for name generation.

Property

This field contains optional properties for the Resource Type. The Azure Naming Tool uses this for additional Resource Tpye names/classification.

Example: "property": "Linux"

Minimum Length

This field specifies the minimum length for generated names for the Resource Type name.

Maximum Length

This field specifies the maximum length for generated names for the Resource Type name.

Apply Delimiter

This setting determines if the current tool delimiter will be included in the name generation process.

Regex

This field contains the Regex formula used during the name generation process for the Resource Type name.

Example: ^[a-z][a-z0-9]{2,62}$

Scope

This field contains the scope of the Resource Type.

Example: global

Valid Text

This field provides guidance on what would qualify as valid text for the Resource Type name.

Example: "Alphanumerics, and hyphens. Start with letter, and end with alphanumeric."

Invalid Text

This field provides guidance on what would qualify as invalid text for the Resource Type name.

Example: "Asterisk, number sign, ampersand, plus, colon, angle brackets, question mark."

Invalid Text Characters

This field provides guidance on what would qualify as invalid characters for the Resource Type name.

Example: "*#&+:<>?"

Invalid Text Characters Start

This field provides guidance on what would qualify as invalid characters for the Resource Type name to start with.

Example: "%$&*#1~"

Invalid Text Characters End

This field provides guidance on what would qualify as invalid characters for the Resource Type name to end with.

Example: "."

Invalid Text Characters Consecutive

This field provides guidance on what would qualify as invalid consecutive characters for the Resource Type name.

Example: "-"

Static Values

This field contains static text that will be used for the name generation process for the Resource Type. This is often used in low-level resource types that should be a "standard" name for every resource.

Example: "staticValues": "ActiveDirectory"