Generated code configuration

Run dotnet build /t:GenerateCode to generate code.

yaml

azure-arm: true
arm-core: true
clear-output-folder: true
skip-csproj: true
model-namespace: false
public-clients: false
head-as-boolean: false
modelerfour:
  lenient-model-deduplication: true
use-model-reader-writer: true
deserialize-null-collection-as-null-value: true
enable-bicep-serialization: true

#mgmt-debug:
#  show-serialized-names: true

batch:
  - tag: package-common-type
  - tag: package-resources
  - tag: package-management

Tag: package-common-type

These settings apply only when --tag=package-common-type is specified on the command line.

yaml

output-folder: $(this-folder)/Common/Generated
sample-gen:
  output-folder: $(this-folder)/../samples/Generated
  clear-output-folder: true
namespace: Azure.ResourceManager
input-file:
  - https://github.com/Azure/azure-rest-api-specs/blob/78eac0bd58633028293cb1ec1709baa200bed9e2/specification/common-types/resource-management/v3/types.json
  - https://github.com/Azure/azure-rest-api-specs/blob/78eac0bd58633028293cb1ec1709baa200bed9e2/specification/common-types/resource-management/v4/managedidentity.json

format-by-name-rules:
  'tenantId': 'uuid'
  'etag': 'etag'
  'location': 'azure-location'
  '*Uri': 'Uri'
  '*Uris': 'Uri'

acronym-mapping:
  CPU: Cpu
  CPUs: Cpus
  Os: OS
  Ip: IP
  Ips: IPs
  ID: Id
  IDs: Ids
  VM: Vm
  VMs: Vms
  Vmos: VmOS
  VMScaleSet: VmScaleSet
  DNS: Dns
  VPN: Vpn
  NAT: Nat
  WAN: Wan
  Ipv4: IPv4
  Ipv6: IPv6
  Ipsec: IPsec
  SSO: Sso
  URI: Uri

directive:
  - from: types.json
    where: $.definitions.Resource
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-ms-client-name"] = "ResourceData";
      $["x-accessibility"] = "public";
      $["x-csharp-formats"] = "json";
      $["x-csharp-usage"] = "model,input,output";
  - from: types.json
    where: $.definitions.TrackedResource
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-ms-client-name"] = "TrackedResourceData";
      $["x-accessibility"] = "public";
      $["x-csharp-formats"] = "json";
      $["x-csharp-usage"] = "model,input,output";
  - from: types.json
    where: $.definitions.Plan
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-accessibility"] = "public";
      $["x-csharp-formats"] = "json";
      $["x-csharp-usage"] = "model,input,output";
  - from: types.json
    where: $.definitions.Sku
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-accessibility"] = "public";
      $["x-csharp-formats"] = "json";
      $["x-csharp-usage"] = "model,input,output";
  - from: types.json
    where: $.definitions.systemData
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-accessibility"] = "public";
      $["x-csharp-formats"] = "json";
      $["x-csharp-usage"] = "model,input,output";
# Workaround for the issue that SystemData lost readonly attribute: https://github.com/Azure/autorest/issues/4269
  - from: types.json
    where: $.definitions.systemData.properties.*
    transform: >
      $["readOnly"] = true;
  - from: types.json
    where: $.definitions.encryptionProperties
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-accessibility"] = "public";
      $["x-csharp-formats"] = "json";
      $["x-csharp-usage"] = "model,input,output";
  - from: types.json
    where: $.definitions.KeyVaultProperties
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-accessibility"] = "public";
      $["x-csharp-formats"] = "json";
      $["x-csharp-usage"] = "model,input,output";
  - from: types.json
    where: $.definitions.*.properties[?(@.enum)]
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-accessibility"] = "public";
  - from: types.json
    where: $.definitions.OperationStatusResult
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-csharp-formats"] = "json";
      $["x-csharp-usage"] = "model,input,output";
  - from: types.json
    where: $.definitions.OperationStatusResult.properties.*
    transform: >
      $["readOnly"] = true;
  - from: managedidentity.json
    where: $.definitions.SystemAssignedServiceIdentity
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-accessibility"] = "public";
      $["x-csharp-formats"] = "json";
      $["x-csharp-usage"] = "model,input,output";
      $.properties.type["x-ms-client-name"] = "SystemAssignedServiceIdentityType";
  - from: managedidentity.json
    where: $.definitions.UserAssignedIdentity
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Models";
      $["x-accessibility"] = "public";
      $["x-csharp-formats"] = "json";
      $["x-csharp-usage"] = "model,input,output";

Tag: package-resources

These settings apply only when --tag=package-resources is specified on the command line.

yaml

output-folder: $(this-folder)/Resources/Generated
sample-gen:
  output-folder: $(this-folder)/../samples/Generated
  clear-output-folder: false
namespace: Azure.ResourceManager.Resources
title: ResourceManagementClient
input-file:
    - https://github.com/Azure/azure-rest-api-specs/blob/817861452040bf29d14b57ac7418560e4680e06e/specification/resources/resource-manager/Microsoft.Authorization/stable/2022-06-01/policyAssignments.json
    - https://github.com/Azure/azure-rest-api-specs/blob/90a65cb3135d42438a381eb8bb5461a2b99b199f/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/policyDefinitions.json
    - https://github.com/Azure/azure-rest-api-specs/blob/90a65cb3135d42438a381eb8bb5461a2b99b199f/specification/resources/resource-manager/Microsoft.Authorization/stable/2021-06-01/policySetDefinitions.json
    - https://github.com/Azure/azure-rest-api-specs/blob/78eac0bd58633028293cb1ec1709baa200bed9e2/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-09-01/dataPolicyManifests.json
    - https://github.com/Azure/azure-rest-api-specs/blob/78eac0bd58633028293cb1ec1709baa200bed9e2/specification/resources/resource-manager/Microsoft.Authorization/stable/2020-05-01/locks.json
    - https://github.com/Azure/azure-rest-api-specs/blob/90a65cb3135d42438a381eb8bb5461a2b99b199f/specification/resources/resource-manager/Microsoft.Resources/stable/2022-09-01/resources.json
    - https://github.com/Azure/azure-rest-api-specs/blob/78eac0bd58633028293cb1ec1709baa200bed9e2/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
    - https://github.com/Azure/azure-rest-api-specs/blob/78eac0bd58633028293cb1ec1709baa200bed9e2/specification/resources/resource-manager/Microsoft.Features/stable/2021-07-01/features.json

list-exception:
  - /{resourceId}

request-path-to-resource-data:
  # subscription does not have name and type
  /subscriptions/{subscriptionId}: Subscription
  # tenant does not have name and type
  /: Tenant
  # provider does not have name and type
  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}: ResourceProvider

request-path-is-non-resource:
  - /subscriptions/{subscriptionId}/locations

request-path-to-parent:
  /subscriptions: /subscriptions/{subscriptionId}
  /tenants: /
  /subscriptions/{subscriptionId}/locations: /subscriptions/{subscriptionId}
  /subscriptions/{subscriptionId}/providers: /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
  /subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}: /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}

request-path-to-resource-type:
  /subscriptions/{subscriptionId}/locations: Microsoft.Resources/locations
  /tenants: Microsoft.Resources/tenants
  /: Microsoft.Resources/tenants
  /subscriptions: Microsoft.Resources/subscriptions
  /subscriptions/{subscriptionId}/resourcegroups: Microsoft.Resources/resourceGroups
  /subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}: Microsoft.Resources/features
  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}: Microsoft.Resources/providers
  /providers: Microsoft.Resources/providers

request-path-to-scope-resource-types:
  /{scope}/providers/Microsoft.Authorization/locks/{lockName}:
    - subscriptions
    - resourceGroups
    - "*"
operation-positions:
  CheckResourceName: collection

operation-groups-to-omit:
  - Deployments
  - DeploymentOperations
  - AuthorizationOperations

override-operation-name:
  Tags_List: GetAllPredefinedTags
  Tags_DeleteValue: DeletePredefinedTagValue
  Tags_CreateOrUpdateValue: CreateOrUpdatePredefinedTagValue
  Tags_CreateOrUpdate: CreateOrUpdatePredefinedTag
  Tags_Delete: DeletePredefinedTag
  Providers_ListAtTenantScope: GetTenantResourceProviders
  Providers_GetAtTenantScope: GetTenantResourceProvider
  Resources_List: GetGenericResources
  Resources_ListByResourceGroup: GetGenericResources
  Resources_MoveResources: MoveResources
  Resources_ValidateMoveResources: ValidateMoveResources

no-property-type-replacement: ResourceProviderData;ResourceProvider

operations-to-skip-lro-api-version-override:
- Tags_CreateOrUpdateAtScope
- Tags_UpdateAtScope
- Tags_DeleteAtScope

generate-arm-resource-extensions:
- /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
- /{scope}/providers/Microsoft.Authorization/locks/{lockName}

format-by-name-rules:
  'tenantId': 'uuid'
  'etag': 'etag'
  'location': 'azure-location'
  '*Uri': 'Uri'
  '*Uris': 'Uri'

keep-plural-enums:
  - ResourceTypeAliasPathAttributes

acronym-mapping:
  CPU: Cpu
  CPUs: Cpus
  Os: OS
  Ip: IP
  Ips: IPs
  ID: Id
  IDs: Ids
  VM: Vm
  VMs: Vms
  Vmos: VmOS
  VMScaleSet: VmScaleSet
  DNS: Dns
  VPN: Vpn
  NAT: Nat
  WAN: Wan
  Ipv4: IPv4
  Ipv6: IPv6
  Ipsec: IPsec
  SSO: Sso
  URI: Uri

rename-mapping:
  PolicyAssignment.identity: ManagedIdentity
  Override: PolicyOverride
  OverrideKind: PolicyOverrideKind
  Selector: ResourceSelectorExpression
  SelectorKind: ResourceSelectorKind
  Location: LocationExpanded
  ResourcesMoveContent.targetResourceGroup: targetResourceGroupId|arm-id
  LocationMetadata.pairedRegion: PairedRegions
  CheckResourceNameResult: ResourceNameValidationResult
  CheckResourceNameResult.type: ResourceType|resource-type
  ResourceName: ResourceNameValidationContent
  ResourceName.type: ResourceType|resource-type
  ResourceNameStatus: ResourceNameValidationStatus
  Resource: ResourceData
  TrackedResource: TrackedResourceData

directive:
  # These methods can be replaced by using other methods in the same operation group, remove for Preview.
  - remove-operation: PolicyAssignments_UpdateById
  - remove-operation: PolicyAssignments_DeleteById
  - remove-operation: PolicyAssignments_CreateById
  - remove-operation: PolicyAssignments_GetById
  - remove-operation: ManagementLocks_CreateOrUpdateAtResourceGroupLevel
  - remove-operation: ManagementLocks_CreateOrUpdateAtResourceLevel
  - remove-operation: ManagementLocks_CreateOrUpdateAtSubscriptionLevel
  - remove-operation: ManagementLocks_DeleteAtResourceGroupLevel
  - remove-operation: ManagementLocks_DeleteAtResourceLevel
  - remove-operation: ManagementLocks_DeleteAtSubscriptionLevel
  - remove-operation: ManagementLocks_GetAtResourceGroupLevel
  - remove-operation: ManagementLocks_GetAtResourceLevel
  - remove-operation: ManagementLocks_GetAtSubscriptionLevel
  - remove-operation: ManagementLocks_ListAtResourceGroupLevel
  - remove-operation: ManagementLocks_ListAtResourceLevel
  - remove-operation: ManagementLocks_ListAtSubscriptionLevel
  # These methods was not in the previous manual code, remove them for the first generation and can add them back later.
  - remove-operation: ResourceGroups_CheckExistence
  - remove-operation: Resources_CheckExistenceById
  - remove-operation: Resources_CheckExistence
  - remove-operation: Resources_CreateOrUpdate
  - remove-operation: Resources_Update
  - remove-operation: Resources_Get
  - remove-operation: Resources_Delete
  - remove-operation: Providers_RegisterAtManagementGroupScope
  - remove-operation: Subscriptions_CheckZonePeers
  - remove-operation: AuthorizationOperations_List
  # Deduplicate
  - from: subscriptions.json
    where: '$.paths["/providers/Microsoft.Resources/operations"].get'
    transform: >
      $["operationId"] = "Operations_ListSubscriptionOperations";
    reason: Rename duplicate operation Id.
  - from: resources.json
    where: '$.paths["/providers/Microsoft.Resources/operations"].get'
    transform: >
      $["operationId"] = "Operations_ListResourcesOperations";
    reason: Rename duplicate operation Id.
  - from: features.json
    where: '$.paths["/providers/Microsoft.Features/operations"].get'
    transform: >
      $["operationId"] = "Operations_ListFeaturesOperations";
    reason: Add operation group so that we can omit related models by the operation group.
  - from: links.json
    where: $.definitions
    transform: >
      $["OperationListResult"]["x-ms-client-name"] = "ResourceLinkOperationListResult";
      $["Operation"]["x-ms-client-name"] = "ResourceLinksOperation";
  - from: subscriptions.json
    where: $.definitions
    transform: >
      $["OperationListResult"] = undefined;
      $["Operation"] = undefined;
  - from: features.json
    where: $.definitions
    transform: >
      $["OperationListResult"]["x-ms-client-name"] = "FeatureOperationListResult";
      $["Operation"]["x-ms-client-name"] = "FeatureOperation";
      $["Operation"]["properties"]["displayOfFeature"] = $["Operation"]["properties"]["display"];
      $["Operation"]["properties"]["display"] = undefined;
  - from: features.json
    where: $.definitions.ErrorResponse
    transform: >
      $["x-ms-client-name"] = "FeatureErrorResponse";
  # remove the systemData property because we already included this property in its base class and the type replacement somehow does not work in resourcemanager
  - from: policyAssignments.json
    where: $.definitions.PolicyAssignment.properties.systemData
    transform: return undefined;
  - from: policyDefinitions.json
    where: $.definitions.PolicyDefinition.properties.systemData
    transform: return undefined;
  - from: policySetDefinitions.json
    where: $.definitions.PolicySetDefinition.properties.systemData
    transform: return undefined;
  - from: resources.json
    where: $.definitions.ExtendedLocation
    transform: >
      $["x-namespace"] = "Azure.ResourceManager.Resources.Models";

  - rename-model:
      from: Provider
      to: ResourceProvider
  - rename-model:
      from: ProviderListResult
      to: ResourceProviderListResult
  - rename-model:
      from: TenantIdDescription
      to: Tenant
  - rename-model:
      from: Tags
      to: Tag
  - rename-model:
      from: TagsResource
      to: TagResource
  - rename-model:
      from: TagsPatchResource
      to: TagPatchResource
  - rename-model:
      from: TagCount
      to: PredefinedTagCount
  - rename-model:
      from: TagValue
      to: PredefinedTagValue
  - rename-model:
      from: TagDetails
      to: PredefinedTag
  - rename-model:
      from: TagsListResult
      to: PredefinedTagsListResult
  - rename-model:
      from: FeatureResult
      to: Feature
  - rename-model:
      from: Resource
      to: TrackedResourceExtendedData
  - rename-model:
      from: ResourcesMoveInfo
      to: ResourcesMoveContent
  - from: resources.json
    where: $.definitions.Provider
    transform:
      $["x-ms-client-name"] = "ResourceProvider";
  - from: resources.json
    where: $.definitions.Alias
    transform:
      $["x-ms-client-name"] = "ResourceTypeAlias";
  - from: resources.json
    where: $.definitions.AliasPath
    transform:
      $["x-ms-client-name"] = "ResourceTypeAliasPath";
  - from: resources.json
    where: $.definitions.AliasPathMetadata.properties.attributes["x-ms-enum"]
    transform:
      $["name"] = "ResourceTypeAliasPathAttributes";
  - from: resources.json
    where: $.definitions.AliasPathMetadata
    transform:
      $["x-ms-client-name"] = "ResourceTypeAliasPathMetadata";
  - from: resources.json
    where: $.definitions.AliasPathMetadata.properties.type["x-ms-enum"]
    transform:
      $["name"] = "ResourceTypeAliasPathTokenType";
  - from: resources.json
    where: $.definitions.AliasPattern
    transform:
      $["x-ms-client-name"] = "ResourceTypeAliasPattern";
  - from: resources.json
    where: $.definitions.AliasPattern.properties.type["x-ms-enum"]
    transform:
      $["name"] = "ResourceTypeAliasPatternType";
  - from: resources.json
    where: $.definitions.Alias.properties.type["x-ms-enum"]
    transform:
      $["name"] = "ResourceTypeAliasType";
  - from: policyDefinitions.json
    where: $.definitions.ParameterDefinitionsValue
    transform:
      $["x-ms-client-name"] = "ArmPolicyParameter";
  - from: policyDefinitions.json
    where: $.definitions.ParameterDefinitionsValue.properties.type["x-ms-enum"]
    transform:
      $["name"] = "ArmPolicyParameterType";
  - from: policyAssignments.json
    where: $.definitions.ParameterValuesValue
    transform:
      $["x-ms-client-name"] = "ArmPolicyParameterValue";
  - remove-model: DeploymentExtendedFilter
  - remove-model: ResourceProviderOperationDisplayProperties
  - from: subscriptions.json
    where: $.paths
    transform: >
      $["/"] = {
        "get": {
          "tags": [
            "Tenants"
          ],
          "operationId": "Tenants_Get",
          "description": "Gets details about the default tenant.",
          "parameters": [
            {
              "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
            }
          ],
          "responses": {
            "200": {
              "description": "OK - Returns information about the tenant.",
              "schema": {
                "$ref": "#/definitions/Tenant"
              }
            },
            "default": {
              "description": "Error response describing why the operation failed.",
              "schema": {
                "$ref": "#/definitions/CloudError"
              }
            }
          }
        }
      }
    reason: add a fake tenant get operation so that we can generate a tenant where all the Get[TenantResources] operations can be autogen in it. The get operation will be removed with codegen suppress attributes.

  - from: resources.json
    where: $.definitions
    transform: >
      $["TenantResourceProvider"] = {
        "properties": {
          "namespace": {
            "type": "string",
            "description": "The namespace of the resource provider."
          },
          "resourceTypes": {
            "readOnly": true,
            "type": "array",
            "items": {
              "$ref": "#/definitions/ProviderResourceType"
            },
            "description": "The collection of provider resource types."
          }
        },
        "description": "Resource provider information."
      }
    reason: This is the real response for a tenant provider.
  - from: resources.json
    where: $.definitions
    transform: >
      $["TenantResourceProviderListResult"] = {
        "properties": {
          "value": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/TenantResourceProvider"
            },
            "description": "An array of resource providers."
          },
          "nextLink": {
            "readOnly": true,
            "type": "string",
            "description": "The URL to use for getting the next set of results."
          }
        },
        "description": "List of resource providers."
      }
  - from: resources.json
    where: $.definitions.TenantResourceProviderListResult.properties.value.items["$ref"]
    transform: return "#/definitions/TenantResourceProvider"
  - from: resources.json
    where: $.paths["/providers"].get.responses["200"].schema["$ref"]
    transform: return "#/definitions/TenantResourceProviderListResult"
  - from: resources.json
    where: $.paths["/providers/{resourceProviderNamespace}"].get.responses["200"].schema["$ref"]
    transform: return "#/definitions/TenantResourceProvider"

  - from: resources.json
    where: $.definitions.Identity.properties.type["x-ms-enum"]
    transform: >
      $["name"] = "GenericResourceIdentityType";
      $["modelAsString"] = true;
  - from: resources.json
    where: $.definitions.Identity
    transform: >
      $["required"] = ["type"]
  - from: resources.json
    where: $.definitions.Identity
    transform: >
      $["x-ms-client-name"] = "GenericResourceIdentity";
  - from: policyAssignments.json
    where: $.definitions.Identity.properties.type["x-ms-enum"]
    transform: $["name"] = "PolicyAssignmentIdentityType"
  - from: policyAssignments.json
    where: $.definitions.Identity
    transform: >
      $["x-ms-client-name"] = "PolicyAssignmentIdentity";
  - from: locks.json
    where: $.paths..parameters[?(@.name === "scope")]
    transform: >
      $["x-ms-skip-url-encoding"] = true
  # Rename GenericResourceExpanded to GenericResource and use it as the schema for both single resource operation and collection operation.
  - from: resources.json
    where: $.definitions.ResourceListResult.properties.value.items["$ref"]
    transform: >
      $ = "#/definitions/GenericResource"
  - from: resources.json
    where: $.definitions
    transform: >
      $.GenericResource.properties["createdTime"] = $.GenericResourceExpanded.properties["createdTime"];
      $.GenericResource.properties["changedTime"] = $.GenericResourceExpanded.properties["changedTime"];
      $.GenericResource.properties["provisioningState"] = $.GenericResourceExpanded.properties["provisioningState"];
      delete $.GenericResourceExpanded;
  - from: locks.json
    where: $.definitions.ManagementLockObject
    transform: $["x-ms-client-name"] = "ManagementLock"
  - from: links.json
    where: $.definitions.ResourceLink.properties.type
    transform: >
      $["x-ms-client-name"] = "ResourceType";
      $["type"] = "string";
  - from: dataPolicyManifests.json
    where: $.definitions.DataEffect
    transform: >
      $["x-ms-client-name"] = "DataPolicyManifestEffect";
  - from: locks.json
    where: $.definitions.ManagementLockProperties.properties.level["x-ms-enum"]
    transform: >
      $["name"] = "ManagementLockLevel"
  - from: subscriptions.json
    where: $.definitions.Subscription.properties.tenantId
    transform: >
      $['format'] = "uuid"
  - from: subscriptions.json
    where: $.definitions.Tenant.properties.tenantId
    transform: >
      $['format'] = "uuid"
  - from: subscriptions.json
    where: $.definitions.ManagedByTenant.properties.tenantId
    transform: >
      $['format'] = "uuid"
  - from: resources.json
    where: $.definitions.ResourcesMoveInfo.properties.resources.items
    transform: >
      $["x-ms-format"] = "arm-id"
  - from: resources.json
    where: $.definitions.RoleDefinition
    transform: >
      $["x-ms-client-name"] = "AzureRoleDefinition";
  - from: resources.json
    where: $.definitions.TagPatchResource.properties.operation["x-ms-enum"]
    transform: >
      $["name"] = "TagPatchMode"
  - from: resources.json
    where: $.definitions.TagPatchResource.properties.operation
    transform: >
      $["x-ms-client-name"] = "PatchMode"
  - from: dataPolicyManifests.json
    where: $.definitions.DataManifestResourceFunctionsDefinition.properties.custom
    transform: >
      $["x-ms-client-name"] = "CustomDefinitions"
  - from: policyAssignments.json
    where: $.definitions.PolicyAssignmentProperties.properties.notScopes
    transform: >
      $["x-ms-client-name"] = "ExcludedScopes"
  - from: resources.json
    where: $.definitions.ExportTemplateRequest
    transform: >
      $["x-ms-client-name"] = "ExportTemplate"
  - from: dataPolicyManifests.json
    where: $.definitions.DataManifestCustomResourceFunctionDefinition.properties.fullyQualifiedResourceType
    transform: >
      $["x-ms-format"] = "resource-type"
  - from: resources.json
    where: $.definitions.Permission.properties.actions
    transform: >
      $["x-ms-client-name"] = "AllowedActions"
  - from: resources.json
    where: $.definitions.Permission.properties.notActions
    transform: >
      $["x-ms-client-name"] = "DeniedActions"
  - from: resources.json
    where: $.definitions.Permission.properties.dataActions
    transform: >
      $["x-ms-client-name"] = "AllowedDataActions"
  - from: resources.json
    where: $.definitions.Permission.properties.notDataActions
    transform: >
      $["x-ms-client-name"] = "DeniedDataActions"
  - from: policyAssignments.json
    where: $.definitions.PolicyAssignment.properties.location
    transform: >
      $["x-ms-format"] = "azure-location"
  - from: resources.json
    where: $.definitions.ProviderExtendedLocation.properties.location
    transform: >
      $["x-ms-format"] = "azure-location"

Tag: package-management

These settings apply only when --tag=package-management is specified on the command line.

yaml

output-folder: $(this-folder)/ManagementGroup/Generated
sample-gen:
  output-folder: $(this-folder)/../samples/Generated
  clear-output-folder: false
namespace: Azure.ResourceManager.ManagementGroups
title: ManagementClient
input-file:
  - https://github.com/Azure/azure-rest-api-specs/blob/efa49a123da7ce3ffe093a13832258305f529711/specification/managementgroups/resource-manager/Microsoft.Management/ManagementGroups/stable/2023-04-01/management.json
request-path-to-parent:
  /providers/Microsoft.Management/checkNameAvailability: /providers/Microsoft.Management/managementGroups/{groupId}
  /providers/Microsoft.Management/getEntities: /providers/Microsoft.Management/managementGroups/{groupId}
operation-positions:
  ManagementGroups_CheckNameAvailability: collection
  Entities_List: collection
operation-groups-to-omit:
  - HierarchySettings
  - TenantBackfill
no-property-type-replacement: DescendantParentGroupInfo

format-by-name-rules:
  'tenantId': 'uuid'
  'etag': 'etag'
  'location': 'azure-location'
  '*Uri': 'Uri'
  '*Uris': 'Uri'

rename-mapping:
  EntityInfo: EntityData
  Permissions: EntityPermission
  Permissions.noaccess: NoAccess
  EntitySearchType: EntitySearchOption
  SubscriptionUnderManagementGroup: ManagementGroupSubscription
  EntityViewParameterType: EntityViewOption
  Reason: ManagementGroupNameUnavailableReason

override-operation-name:
  ManagementGroupSubscriptions_GetSubscription: GetManagementGroupSubscription

acronym-mapping:
  CPU: Cpu
  CPUs: Cpus
  Os: OS
  Ip: IP
  Ips: IPs
  ID: Id
  IDs: Ids
  VM: Vm
  VMs: Vms
  Vmos: VmOS
  VMScaleSet: VmScaleSet
  DNS: Dns
  VPN: Vpn
  NAT: Nat
  WAN: Wan
  Ipv4: IPv4
  Ipv6: IPv6
  Ipsec: IPsec
  SSO: Sso
  URI: Uri
directive:
  - rename-model:
      from: CreateManagementGroupChildInfo
      to: ManagementGroupChildOptions
  - rename-model:
      from: CreateParentGroupInfo
      to: ManagementGroupParentCreateOptions
  - rename-operation:
      from: CheckNameAvailability
      to: ManagementGroups_CheckNameAvailability
  - rename-operation:
      from: StartTenantBackfill
      to: TenantBackfill_Start
  - rename-operation:
      from: TenantBackfillStatus
      to: TenantBackfill_Status
  - from: management.json
    where: $.paths
    transform: >
      $['/providers/Microsoft.Management/getEntities'].post.parameters[1]['x-ms-client-name'] = 'SkipToken';
  - from: management.json
    where: $.paths
    transform: >
      $['/providers/Microsoft.Management/managementGroups'].get.parameters[2]['x-ms-client-name'] = 'SkipToken';
  - from: management.json
    where: $.paths
    transform: >
      $['/providers/Microsoft.Management/managementGroups/{groupId}/descendants'].get.parameters[2]['x-ms-client-name'] = 'SkipToken';
  - from: management.json
    where: $.paths
    transform: >
      $['/providers/Microsoft.Management/managementGroups/{groupId}/subscriptions'].get.parameters[2]['x-ms-client-name'] = 'SkipToken';
  - from: management.json
    where: $.parameters.ExpandParameter
    transform: >
      $['x-ms-enum'] = {
        name: "ManagementGroupExpandType",
        modelAsString: true
      }
  - from: management.json
    where: $.definitions.ManagementGroupListResult.properties.value.items
    transform: >
      $['$ref'] = "#/definitions/ManagementGroup"
  - from: management.json
    where: $.definitions.ManagementGroupInfo
    transform: 'return undefined'
  - remove-model: OperationResults
  - from: management.json
    where: $.definitions.ManagementGroupChildType
    transform: >
      $['x-ms-enum'].modelAsString = true
  - from: management.json
    where: $.definitions.CheckNameAvailabilityResult
    transform: >
      $['x-ms-client-name'] = "ManagementGroupNameAvailabilityResult"
  - from: management.json
    where: $.parameters.SearchParameter
    transform: >
      $['x-ms-enum'] = {
        name: "SearchOptions",
        modelAsString: true
      }
    reason: omit operation group does not clean this enum parameter, rename it and then suppress with codegen attribute.
  - from: management.json
    where: $.parameters.EntityViewParameter
    transform: >
      $['x-ms-enum'] = {
        name: "EntityViewOptions",
        modelAsString: true
      }
    reason: omit operation group does not clean this enum parameter, rename it and then suppress with codegen attribute.
  - remove-model: EntityHierarchyItem
  - remove-model: EntityHierarchyItemProperties
  - from: management.json
    where: $.definitions.CreateManagementGroupProperties.properties.tenantId
    transform: >
      $['format'] = "uuid"
  - from: management.json
    where: $.definitions.DescendantInfo
    transform: >
      $['x-ms-client-name'] = "DescendantData"
  - from: management.json
    where: $.definitions.DescendantParentGroupInfo.properties.id
    transform: >
      $["x-ms-format"] = "arm-id"
  - from: management.json
    where: $.definitions.ManagementGroupDetails.properties.managementGroupAncestorsChain
    transform: >
      $["x-ms-client-name"] = "managementGroupAncestorChain"
  - from: management.json
    where: $.definitions.ManagementGroupDetails
    transform: >
      $["x-ms-client-name"] = "ManagementGroupInfo"
  - from: management.json
    where: $.definitions.ParentGroupInfo
    transform: >
      $["x-ms-client-name"] = "ParentManagementGroupInfo"
  - from: management.json
    where: $.definitions.ManagementGroupProperties.properties.tenantId
    transform: >
      $['format'] = "uuid"
  - from: management.json
    where: $.definitions
    transform: >
      $.CreateManagementGroupRequest.properties.type['x-ms-format'] = 'resource-type';
      $.CheckNameAvailabilityRequest["x-ms-client-name"] = "ManagementGroupNameAvailabilityContent";
      $.CheckNameAvailabilityRequest.properties.type['x-ms-client-name'] = "ResourceType";
      $.CheckNameAvailabilityRequest.properties.type['x-ms-constant'] = true;
      $.CheckNameAvailabilityRequest.properties.type['x-ms-format'] = 'resource-type';