Microsoft.Sovereign (preview:2025-02-27)

2025/02/11 • 21 updated methods

LandingZoneAccountOperations_ListBySubscription (updated)
Description :  List the landing zone accounts within a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneAccountOperations_ListBySubscription",
  "Description": {
    "new": "List the landing zone accounts within a subscription.",
    "old": "Lists the landing zone accounts within a subscription."
  },
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "The Landing zone account resource type. A Landing zone account is the container for configuring, deploying and managing multiple landing zones.",
            "old": "The Landing zone account parent resource type."
          },
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Description": {
                  "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account.",
                  "old": "The status of a user-initiated, control-plane operation on the landing zone account."
                }
              },
              {
                "#name": "storageAccount",
                "Description": {
                  "new": "The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment.",
                  "old": "The storage account that will host the generated slz code."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sovereign/landingZoneAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LandingZoneAccountResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_ListBySubscription (updated)
Description :  List the landing zone configurations within a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneConfigurationOperations_ListBySubscription",
  "Description": {
    "new": "List the landing zone configurations within a subscription.",
    "old": "Lists the landing zone configurations within a subscription."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Description": {
                  "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration.",
                  "old": "The status of a user-initiated, control-plane operation on the landing zone configuration."
                }
              },
              {
                "#name": "authoringStatus",
                "Description": {
                  "new": "The status that indicates the current phase of the configuration process for a deployment.",
                  "old": "The status for the landing zone configurations workflow."
                },
                "Enum": {
                  "new": [
                    [
                      "Authoring",
                      "'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified."
                    ],
                    [
                      "ReadyForUse",
                      "'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment."
                    ],
                    [
                      "Disabled",
                      "'Disabled' status is set when the landing zone configuration is no longer in use."
                    ]
                  ],
                  "old": [
                    [
                      "Authoring",
                      "This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated."
                    ],
                    [
                      "ReadyForUse",
                      "This status is set when the configuration changes are complete and the configuration is ready for code generation"
                    ],
                    [
                      "Disabled",
                      "This status is set when the landing zone configuration is no longer in use."
                    ]
                  ]
                }
              },
              {
                "#name": "ddosProtectionCreationOption",
                "Description": {
                  "new": "Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan.",
                  "old": "To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan."
                }
              },
              {
                "#name": "existingDdosProtectionId",
                "Description": {
                  "new": "The resource ID of the DDoS protection plan when reusing an existing one.",
                  "old": "The resource id of the ddos protection plan."
                }
              },
              {
                "#name": "logAnalyticsWorkspaceCreationOption",
                "Description": {
                  "new": "Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace.",
                  "old": "To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace."
                }
              },
              {
                "#name": "existingLogAnalyticsWorkspaceId",
                "Description": {
                  "new": "The resource ID of the log analytics workspace when reusing an existing one.",
                  "old": "The resource id of the log analytics workspace that was created to centralize log ingestion."
                }
              },
              {
                "#name": "tags",
                "Description": {
                  "new": "Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'}",
                  "old": "Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}."
                },
                "$items": {
                  "Description": {
                    "new": "Key-value pairs that can be assigned to this resource.",
                    "old": "The details associated with tags."
                  }
                }
              },
              {
                "#name": "firewallCreationOption",
                "Description": {
                  "new": "Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU.",
                  "old": "To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one."
                },
                "Enum": {
                  "new": [
                    [
                      "None",
                      "Select 'None' value to skip Firewall deployment."
                    ],
                    [
                      "Standard",
                      "Select 'Standard' value to deploy the Firewall Standard SKU."
                    ],
                    [
                      "Premium",
                      "Select 'Premium' value to deploy the Firewall Premium SKU."
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      "Value when a firewall resource is not created."
                    ],
                    [
                      "Standard",
                      "Value when the firewall creation is based on the standard SKU."
                    ],
                    [
                      "Premium",
                      "Value when the firewall creation is based on the premium SKU."
                    ]
                  ]
                }
              },
              {
                "#name": "firewallSubnetCidrBlock",
                "Description": {
                  "new": "The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation.",
                  "old": "Azure firewall subnet. IPv4 CIDR block."
                }
              },
              {
                "#name": "gatewaySubnetCidrBlock",
                "Description": {
                  "new": "The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation.",
                  "old": "Gateway subnet. IPv4 CIDR block."
                }
              },
              {
                "#name": "logRetentionInDays",
                "Description": {
                  "new": "Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days.",
                  "old": "Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730"
                }
              },
              {
                "#name": "hubNetworkCidrBlock",
                "Description": {
                  "new": "The Virtual Network address. Specify the address using IPv4 CIDR notation.",
                  "old": "The address space for the VNET. IPv4 CIDR block."
                }
              },
              {
                "#name": "azureBastionCreationOption",
                "Description": {
                  "new": "Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion.",
                  "old": "To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service."
                }
              },
              {
                "#name": "existingAzureBastionId",
                "Description": {
                  "new": "The resource ID of the Bastion when reusing an existing one.",
                  "old": "The resource id of azure bastion."
                }
              },
              {
                "#name": "azureBastionSubnetCidrBlock",
                "Description": {
                  "new": "The Bastion subnet address. Specify the address using IPv4 CIDR notation.",
                  "old": "Azure bastion subnet. IP v4 CIDR block."
                }
              },
              {
                "#name": "landingZonesMgChildren",
                "Description": {
                  "new": "The child management groups of 'Landing Zones' management group and their assigned policies.",
                  "old": "Landing zone children management group properties"
                },
                "$items": {
                  "Description": {
                    "new": "The 'Landing Zones' management group properties..",
                    "old": "Landing zone management group properties."
                  },
                  "$properties": [
                    {
                      "#name": "policyInitiativesAssignmentProperties",
                      "Description": {
                        "new": "Array of policy initiatives applied to the management group.",
                        "old": "Array of initiative assignments to be applied to the management group."
                      },
                      "$items": {
                        "Description": {
                          "new": "The properties of assigned policy initiatives.",
                          "old": "Details of policy assignments"
                        },
                        "$properties": [
                          {
                            "#name": "assignmentParameters",
                            "Description": {
                              "new": "The parameters of the assigned policy initiative.",
                              "old": "The parameters for the assignment of policy initiatives."
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "topLevelMgMetadata",
                "Description": {
                  "new": "The assigned policies of the parent management group.",
                  "old": "This will be applied to the root of the landing zone deployment."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "landingZonesMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Landing Zones' management group.",
                  "old": "This will be applied to the landing zone management groups."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "platformMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Platform' management group.",
                  "old": "This will be applied to the platform management group."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "platformManagementMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Management' management group under 'Platform' management group.",
                  "old": "This will be applied to the management management group under platform."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "platformConnectivityMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Connectivity' management group under 'Platform' management group.",
                  "old": "This will be applied to the connectivity management group under platform."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "platformIdentityMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Identity' management group under 'Platform' management group.",
                  "old": "This will be applied to the identity management group under platform."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "decommissionedMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Decommissioned' management group and indicator to create it or not.",
                  "old": "This will be applied to the decommissioned management group."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "#name": "create",
                    "Description": {
                      "new": "This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                      "old": "When set to false, this management group will not be created. The default value is false."
                    }
                  }
                ]
              },
              {
                "#name": "sandboxMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Sandbox' management group and indicator to create it or not.",
                  "old": "This will be applied to the sandbox management group."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "#name": "create",
                    "Description": {
                      "new": "This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                      "old": "When set to false this management group will not be created. The default value is false."
                    }
                  }
                ]
              },
              {
                "#name": "managedIdentity",
                "Description": {
                  "new": "The managed identity to be assigned to this landing zone configuration.",
                  "old": "The managed identity to be tied to this landing zone configuration"
                }
              },
              {
                "#name": "platformMgChildren",
                "Description": {
                  "new": "The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management'",
                  "old": "Platform children management group properties."
                },
                "$items": {
                  "Description": {
                    "new": "The 'Platform' management group properties.",
                    "old": "Platform management group properties."
                  },
                  "$properties": [
                    {
                      "#name": "policyInitiativesAssignmentProperties",
                      "Description": {
                        "new": "Array of policy initiatives applied to the management group.",
                        "old": "Array of initiative assignments to be applied to the management group."
                      },
                      "$items": {
                        "Description": {
                          "new": "The properties of assigned policy initiatives.",
                          "old": "Details of policy assignments"
                        },
                        "$properties": [
                          {
                            "#name": "assignmentParameters",
                            "Description": {
                              "new": "The parameters of the assigned policy initiative.",
                              "old": "The parameters for the assignment of policy initiatives."
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "namingConventionFormula",
                "Description": {
                  "new": "The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing",
                  "old": "The naming convention that's used by default for all resource types for this landing zone configuration"
                }
              },
              {
                "#name": "customNamingConvention",
                "Description": {
                  "new": "The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}]",
                  "old": "The customized naming convention for one or more resource types in this landing zone configuration"
                },
                "$items": {
                  "Description": {
                    "new": "The details for the custom naming convention override for a specific resource type.",
                    "old": "The details for the custom resource override."
                  },
                  "$properties": [
                    {
                      "#name": "resourceType",
                      "Enum": {
                        "new": [
                          [
                            "azureFirewalls",
                            "Value when customer wants to provide a custom naming convention for Azure Firewall."
                          ],
                          [
                            "workspaces",
                            "Value when customer wants to provide a custom naming convention for Log Analytics workspace."
                          ],
                          [
                            "automationAccounts",
                            "Value when customer wants to provide a custom naming convention for automation account."
                          ],
                          [
                            "dashboards",
                            "Value when customer wants to provide a custom naming convention for dashboard."
                          ],
                          [
                            "userAssignedIdentities",
                            "Value when customer wants to provide a custom naming convention for managed identity."
                          ],
                          [
                            "bastionHosts",
                            "Value when customer wants to provide a custom naming convention for Bastion."
                          ],
                          [
                            "ddosProtectionPlans",
                            "Value when customer wants to provide a custom naming convention for DDoS protection plan."
                          ],
                          [
                            "networkSecurityGroups",
                            "Value when customer wants to provide a custom naming convention for Bastion NSG."
                          ],
                          [
                            "virtualNetworks",
                            "Value when customer wants to provide a custom naming convention for virtual network."
                          ],
                          [
                            "routeTables",
                            "Value when customer wants to provide a custom naming convention for route table."
                          ]
                        ],
                        "old": [
                          [
                            "azureFirewalls",
                            "Value when customer wants to provide custom naming convention for Azure Firewall."
                          ],
                          [
                            "workspaces",
                            "Value when customer wants to provide custom naming convention for Log Analytics workspace."
                          ],
                          [
                            "automationAccounts",
                            "Value when customer wants to provide custom naming convention for automation account."
                          ],
                          [
                            "dashboards",
                            "Value when customer wants to provide custom naming convention for dashboard."
                          ],
                          [
                            "userAssignedIdentities",
                            "Value when customer wants to provide custom naming convention for managed identity."
                          ],
                          [
                            "bastionHosts",
                            "Value when customer wants to provide custom naming convention for Bastion."
                          ],
                          [
                            "ddosProtectionPlans",
                            "Value when customer wants to provide custom naming convention for DDoS protection plan."
                          ],
                          [
                            "networkSecurityGroups",
                            "Value when customer wants to provide custom naming convention for Bastion NSG."
                          ],
                          [
                            "virtualNetworks",
                            "Value when customer wants to provide custom naming convention for virtual network."
                          ],
                          [
                            "routeTables",
                            "Value when customer wants to provide custom naming convention for route table."
                          ]
                        ]
                      }
                    },
                    {
                      "#name": "formula",
                      "Description": {
                        "new": "The custom naming formula for the resource type.",
                        "old": "The custom formula for the resource type."
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LandingZoneConfigurationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
authoringStatus:
{
Description: The status that indicates the current phase of the configuration process for a deployment. ,
Enum:
{
Authoring: 'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified. ,
ReadyForUse: 'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment. ,
Disabled: 'Disabled' status is set when the landing zone configuration is no longer in use. ,
}
,
Required: False ,
}
enum ,
ddosProtectionCreationOption:
{
Description: Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingDdosProtectionId:
{
Description: The resource ID of the DDoS protection plan when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsWorkspaceCreationOption:
{
Description: Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingLogAnalyticsWorkspaceId:
{
Description: The resource ID of the log analytics workspace when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
tags:
{
Description: Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'} ,
Required: False ,
}
[
{
name:
{
Description: A tag name. ,
Required: True ,
}
string ,
value:
{
Description: A tag value. ,
Required: False ,
}
string ,
}
,
]
,
firewallCreationOption:
{
Description: Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU. ,
Enum:
{
None: Select 'None' value to skip Firewall deployment. ,
Standard: Select 'Standard' value to deploy the Firewall Standard SKU. ,
Premium: Select 'Premium' value to deploy the Firewall Premium SKU. ,
}
,
Required: True ,
}
enum ,
firewallSubnetCidrBlock:
{
Description: The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation. ,
Required: False ,
}
string ,
gatewaySubnetCidrBlock:
{
Description: The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation. ,
Required: True ,
}
string ,
logRetentionInDays:
{
Description: Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days. ,
Format: int64 ,
Required: True ,
}
integer ,
hubNetworkCidrBlock:
{
Description: The Virtual Network address. Specify the address using IPv4 CIDR notation. ,
Required: True ,
}
string ,
azureBastionCreationOption:
{
Description: Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingAzureBastionId:
{
Description: The resource ID of the Bastion when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
azureBastionSubnetCidrBlock:
{
Description: The Bastion subnet address. Specify the address using IPv4 CIDR notation. ,
Required: False ,
}
string ,
landingZonesMgChildren:
{
Description: The child management groups of 'Landing Zones' management group and their assigned policies. ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
topLevelMgMetadata:
{
Description: The assigned policies of the parent management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
Description: The assigned policies of the 'Landing Zones' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformMgMetadata:
{
Description: The assigned policies of the 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
Description: The assigned policies of the 'Management' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
Description: The assigned policies of the 'Connectivity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
Description: The assigned policies of the 'Identity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
Description: The assigned policies of the 'Decommissioned' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
sandboxMgMetadata:
{
Description: The assigned policies of the 'Sandbox' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone configuration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
platformMgChildren:
{
Description: The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management' ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
namingConventionFormula:
{
Description: The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing ,
Required: False ,
}
string ,
customNamingConvention:
{
Description: The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}] ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Enum:
{
azureFirewalls: Value when customer wants to provide a custom naming convention for Azure Firewall. ,
workspaces: Value when customer wants to provide a custom naming convention for Log Analytics workspace. ,
automationAccounts: Value when customer wants to provide a custom naming convention for automation account. ,
dashboards: Value when customer wants to provide a custom naming convention for dashboard. ,
userAssignedIdentities: Value when customer wants to provide a custom naming convention for managed identity. ,
bastionHosts: Value when customer wants to provide a custom naming convention for Bastion. ,
ddosProtectionPlans: Value when customer wants to provide a custom naming convention for DDoS protection plan. ,
networkSecurityGroups: Value when customer wants to provide a custom naming convention for Bastion NSG. ,
virtualNetworks: Value when customer wants to provide a custom naming convention for virtual network. ,
routeTables: Value when customer wants to provide a custom naming convention for route table. ,
}
,
Required: True ,
}
enum ,
formula:
{
Description: The custom naming formula for the resource type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_ListBySubscription (updated)
Description :  List the landing zone registrations within a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneRegistrationOperations_ListBySubscription",
  "Description": {
    "new": "List the landing zone registrations within a subscription.",
    "old": "Lists the landing zone registrations within a subscription."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "The Landing zone registration resource type.",
            "old": "The Landing Zone registration resource type"
          },
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Description": {
                  "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type.",
                  "old": "The status of a user-initiated, control-plane operation on the landing Zone registration resource type."
                }
              },
              {
                "#name": "managedIdentity",
                "Description": {
                  "new": "The managed identity to be assigned to this landing zone registration.",
                  "old": "The managed identity to be tied to this landing zone registration"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LandingZoneRegistrationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
existingTopLevelMgId:
{
Description: The resource id of the top level management group ,
Format: arm-id ,
Required: True ,
}
string ,
existingLandingZoneConfigurationId:
{
Description: The resource id of the associated landing zone configuration. ,
Format: arm-id ,
Required: True ,
}
string ,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone registration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneAccountOperations_ListByResourceGroup (updated)
Description :  List the landing zone accounts within a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneAccountOperations_ListByResourceGroup",
  "Description": {
    "new": "List the landing zone accounts within a resource group.",
    "old": "Lists the landing zone accounts within a resource group."
  },
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "The Landing zone account resource type. A Landing zone account is the container for configuring, deploying and managing multiple landing zones.",
            "old": "The Landing zone account parent resource type."
          },
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Description": {
                  "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account.",
                  "old": "The status of a user-initiated, control-plane operation on the landing zone account."
                }
              },
              {
                "#name": "storageAccount",
                "Description": {
                  "new": "The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment.",
                  "old": "The storage account that will host the generated slz code."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LandingZoneAccountResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneAccountOperations_Get (updated)
Description :  Get a landing zone account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneAccountOperations_Get",
  "Description": {
    "new": "Get a landing zone account.",
    "old": "Gets the landing zone account."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The Landing zone account resource type. A Landing zone account is the container for configuring, deploying and managing multiple landing zones.",
        "old": "The Landing zone account parent resource type."
      },
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account.",
              "old": "The status of a user-initiated, control-plane operation on the landing zone account."
            }
          },
          {
            "#name": "storageAccount",
            "Description": {
              "new": "The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment.",
              "old": "The storage account that will host the generated slz code."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneAccountOperations_Create (updated)
Description :  Create a landing zone account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneAccountOperations_Create",
  "Description": {
    "new": "Create a landing zone account.",
    "old": "Creates the landing zone account."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "resource": {
        "Description": {
          "new": "The Landing zone account resource type. A Landing zone account is the container for configuring, deploying and managing multiple landing zones.",
          "old": "The Landing zone account parent resource type."
        },
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account.",
                "old": "The status of a user-initiated, control-plane operation on the landing zone account."
              }
            },
            {
              "#name": "storageAccount",
              "Description": {
                "new": "The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment.",
                "old": "The storage account that will host the generated slz code."
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The Landing zone account resource type. A Landing zone account is the container for configuring, deploying and managing multiple landing zones.",
        "old": "The Landing zone account parent resource type."
      },
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account.",
              "old": "The status of a user-initiated, control-plane operation on the landing zone account."
            }
          },
          {
            "#name": "storageAccount",
            "Description": {
              "new": "The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment.",
              "old": "The storage account that will host the generated slz code."
            }
          }
        ]
      }
    },
    "201": {
      "Description": {
        "new": "The Landing zone account resource type. A Landing zone account is the container for configuring, deploying and managing multiple landing zones.",
        "old": "The Landing zone account parent resource type."
      },
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account.",
              "old": "The status of a user-initiated, control-plane operation on the landing zone account."
            }
          },
          {
            "#name": "storageAccount",
            "Description": {
              "new": "The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment.",
              "old": "The storage account that will host the generated slz code."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Landing zone account resource type. A Landing zone account is the container for configuring, deploying and managing multiple landing zones. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneAccountOperations_Update (updated)
Description :  Update a landing zone account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneAccountOperations_Update",
  "Description": {
    "new": "Update a landing zone account.",
    "old": "Updates the landing zone account."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "properties": {
        "Description": {
          "new": "The Landing zone account resource type. A Landing zone account is the container for configuring, deploying and managing multiple landing zones.",
          "old": "The Landing zone account parent resource type."
        },
        "$properties": {
          "properties": [
            {
              "#name": "storageAccount",
              "Description": {
                "new": "The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment.",
                "old": "The storage account that will host the generated slz code."
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The Landing zone account resource type. A Landing zone account is the container for configuring, deploying and managing multiple landing zones.",
        "old": "The Landing zone account parent resource type."
      },
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account.",
              "old": "The status of a user-initiated, control-plane operation on the landing zone account."
            }
          },
          {
            "#name": "storageAccount",
            "Description": {
              "new": "The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment.",
              "old": "The storage account that will host the generated slz code."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storageAccount:
{
Description: The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity assigned to this resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The identities assigned to this resource by the user. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
storageAccount:
{
Description: The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneAccountOperations_Delete (updated)
Description :  Deletes a landing zone account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneAccountOperations_Delete",
  "Description": {
    "new": "Deletes a landing zone account.",
    "old": "Deletes the landing zone account."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_ListByResourceGroup (updated)
Description :  List the landing zone configurations within a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneConfigurationOperations_ListByResourceGroup",
  "Description": {
    "new": "List the landing zone configurations within a resource group.",
    "old": "Lists the landing zone configurations within a resource group."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Description": {
                  "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration.",
                  "old": "The status of a user-initiated, control-plane operation on the landing zone configuration."
                }
              },
              {
                "#name": "authoringStatus",
                "Description": {
                  "new": "The status that indicates the current phase of the configuration process for a deployment.",
                  "old": "The status for the landing zone configurations workflow."
                },
                "Enum": {
                  "new": [
                    [
                      "Authoring",
                      "'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified."
                    ],
                    [
                      "ReadyForUse",
                      "'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment."
                    ],
                    [
                      "Disabled",
                      "'Disabled' status is set when the landing zone configuration is no longer in use."
                    ]
                  ],
                  "old": [
                    [
                      "Authoring",
                      "This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated."
                    ],
                    [
                      "ReadyForUse",
                      "This status is set when the configuration changes are complete and the configuration is ready for code generation"
                    ],
                    [
                      "Disabled",
                      "This status is set when the landing zone configuration is no longer in use."
                    ]
                  ]
                }
              },
              {
                "#name": "ddosProtectionCreationOption",
                "Description": {
                  "new": "Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan.",
                  "old": "To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan."
                }
              },
              {
                "#name": "existingDdosProtectionId",
                "Description": {
                  "new": "The resource ID of the DDoS protection plan when reusing an existing one.",
                  "old": "The resource id of the ddos protection plan."
                }
              },
              {
                "#name": "logAnalyticsWorkspaceCreationOption",
                "Description": {
                  "new": "Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace.",
                  "old": "To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace."
                }
              },
              {
                "#name": "existingLogAnalyticsWorkspaceId",
                "Description": {
                  "new": "The resource ID of the log analytics workspace when reusing an existing one.",
                  "old": "The resource id of the log analytics workspace that was created to centralize log ingestion."
                }
              },
              {
                "#name": "tags",
                "Description": {
                  "new": "Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'}",
                  "old": "Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}."
                },
                "$items": {
                  "Description": {
                    "new": "Key-value pairs that can be assigned to this resource.",
                    "old": "The details associated with tags."
                  }
                }
              },
              {
                "#name": "firewallCreationOption",
                "Description": {
                  "new": "Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU.",
                  "old": "To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one."
                },
                "Enum": {
                  "new": [
                    [
                      "None",
                      "Select 'None' value to skip Firewall deployment."
                    ],
                    [
                      "Standard",
                      "Select 'Standard' value to deploy the Firewall Standard SKU."
                    ],
                    [
                      "Premium",
                      "Select 'Premium' value to deploy the Firewall Premium SKU."
                    ]
                  ],
                  "old": [
                    [
                      "None",
                      "Value when a firewall resource is not created."
                    ],
                    [
                      "Standard",
                      "Value when the firewall creation is based on the standard SKU."
                    ],
                    [
                      "Premium",
                      "Value when the firewall creation is based on the premium SKU."
                    ]
                  ]
                }
              },
              {
                "#name": "firewallSubnetCidrBlock",
                "Description": {
                  "new": "The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation.",
                  "old": "Azure firewall subnet. IPv4 CIDR block."
                }
              },
              {
                "#name": "gatewaySubnetCidrBlock",
                "Description": {
                  "new": "The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation.",
                  "old": "Gateway subnet. IPv4 CIDR block."
                }
              },
              {
                "#name": "logRetentionInDays",
                "Description": {
                  "new": "Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days.",
                  "old": "Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730"
                }
              },
              {
                "#name": "hubNetworkCidrBlock",
                "Description": {
                  "new": "The Virtual Network address. Specify the address using IPv4 CIDR notation.",
                  "old": "The address space for the VNET. IPv4 CIDR block."
                }
              },
              {
                "#name": "azureBastionCreationOption",
                "Description": {
                  "new": "Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion.",
                  "old": "To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service."
                }
              },
              {
                "#name": "existingAzureBastionId",
                "Description": {
                  "new": "The resource ID of the Bastion when reusing an existing one.",
                  "old": "The resource id of azure bastion."
                }
              },
              {
                "#name": "azureBastionSubnetCidrBlock",
                "Description": {
                  "new": "The Bastion subnet address. Specify the address using IPv4 CIDR notation.",
                  "old": "Azure bastion subnet. IP v4 CIDR block."
                }
              },
              {
                "#name": "landingZonesMgChildren",
                "Description": {
                  "new": "The child management groups of 'Landing Zones' management group and their assigned policies.",
                  "old": "Landing zone children management group properties"
                },
                "$items": {
                  "Description": {
                    "new": "The 'Landing Zones' management group properties..",
                    "old": "Landing zone management group properties."
                  },
                  "$properties": [
                    {
                      "#name": "policyInitiativesAssignmentProperties",
                      "Description": {
                        "new": "Array of policy initiatives applied to the management group.",
                        "old": "Array of initiative assignments to be applied to the management group."
                      },
                      "$items": {
                        "Description": {
                          "new": "The properties of assigned policy initiatives.",
                          "old": "Details of policy assignments"
                        },
                        "$properties": [
                          {
                            "#name": "assignmentParameters",
                            "Description": {
                              "new": "The parameters of the assigned policy initiative.",
                              "old": "The parameters for the assignment of policy initiatives."
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "topLevelMgMetadata",
                "Description": {
                  "new": "The assigned policies of the parent management group.",
                  "old": "This will be applied to the root of the landing zone deployment."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "landingZonesMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Landing Zones' management group.",
                  "old": "This will be applied to the landing zone management groups."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "platformMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Platform' management group.",
                  "old": "This will be applied to the platform management group."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "platformManagementMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Management' management group under 'Platform' management group.",
                  "old": "This will be applied to the management management group under platform."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "platformConnectivityMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Connectivity' management group under 'Platform' management group.",
                  "old": "This will be applied to the connectivity management group under platform."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "platformIdentityMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Identity' management group under 'Platform' management group.",
                  "old": "This will be applied to the identity management group under platform."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "decommissionedMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Decommissioned' management group and indicator to create it or not.",
                  "old": "This will be applied to the decommissioned management group."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "#name": "create",
                    "Description": {
                      "new": "This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                      "old": "When set to false, this management group will not be created. The default value is false."
                    }
                  }
                ]
              },
              {
                "#name": "sandboxMgMetadata",
                "Description": {
                  "new": "The assigned policies of the 'Sandbox' management group and indicator to create it or not.",
                  "old": "This will be applied to the sandbox management group."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "#name": "create",
                    "Description": {
                      "new": "This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                      "old": "When set to false this management group will not be created. The default value is false."
                    }
                  }
                ]
              },
              {
                "#name": "managedIdentity",
                "Description": {
                  "new": "The managed identity to be assigned to this landing zone configuration.",
                  "old": "The managed identity to be tied to this landing zone configuration"
                }
              },
              {
                "#name": "platformMgChildren",
                "Description": {
                  "new": "The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management'",
                  "old": "Platform children management group properties."
                },
                "$items": {
                  "Description": {
                    "new": "The 'Platform' management group properties.",
                    "old": "Platform management group properties."
                  },
                  "$properties": [
                    {
                      "#name": "policyInitiativesAssignmentProperties",
                      "Description": {
                        "new": "Array of policy initiatives applied to the management group.",
                        "old": "Array of initiative assignments to be applied to the management group."
                      },
                      "$items": {
                        "Description": {
                          "new": "The properties of assigned policy initiatives.",
                          "old": "Details of policy assignments"
                        },
                        "$properties": [
                          {
                            "#name": "assignmentParameters",
                            "Description": {
                              "new": "The parameters of the assigned policy initiative.",
                              "old": "The parameters for the assignment of policy initiatives."
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              },
              {
                "#name": "namingConventionFormula",
                "Description": {
                  "new": "The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing",
                  "old": "The naming convention that's used by default for all resource types for this landing zone configuration"
                }
              },
              {
                "#name": "customNamingConvention",
                "Description": {
                  "new": "The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}]",
                  "old": "The customized naming convention for one or more resource types in this landing zone configuration"
                },
                "$items": {
                  "Description": {
                    "new": "The details for the custom naming convention override for a specific resource type.",
                    "old": "The details for the custom resource override."
                  },
                  "$properties": [
                    {
                      "#name": "resourceType",
                      "Enum": {
                        "new": [
                          [
                            "azureFirewalls",
                            "Value when customer wants to provide a custom naming convention for Azure Firewall."
                          ],
                          [
                            "workspaces",
                            "Value when customer wants to provide a custom naming convention for Log Analytics workspace."
                          ],
                          [
                            "automationAccounts",
                            "Value when customer wants to provide a custom naming convention for automation account."
                          ],
                          [
                            "dashboards",
                            "Value when customer wants to provide a custom naming convention for dashboard."
                          ],
                          [
                            "userAssignedIdentities",
                            "Value when customer wants to provide a custom naming convention for managed identity."
                          ],
                          [
                            "bastionHosts",
                            "Value when customer wants to provide a custom naming convention for Bastion."
                          ],
                          [
                            "ddosProtectionPlans",
                            "Value when customer wants to provide a custom naming convention for DDoS protection plan."
                          ],
                          [
                            "networkSecurityGroups",
                            "Value when customer wants to provide a custom naming convention for Bastion NSG."
                          ],
                          [
                            "virtualNetworks",
                            "Value when customer wants to provide a custom naming convention for virtual network."
                          ],
                          [
                            "routeTables",
                            "Value when customer wants to provide a custom naming convention for route table."
                          ]
                        ],
                        "old": [
                          [
                            "azureFirewalls",
                            "Value when customer wants to provide custom naming convention for Azure Firewall."
                          ],
                          [
                            "workspaces",
                            "Value when customer wants to provide custom naming convention for Log Analytics workspace."
                          ],
                          [
                            "automationAccounts",
                            "Value when customer wants to provide custom naming convention for automation account."
                          ],
                          [
                            "dashboards",
                            "Value when customer wants to provide custom naming convention for dashboard."
                          ],
                          [
                            "userAssignedIdentities",
                            "Value when customer wants to provide custom naming convention for managed identity."
                          ],
                          [
                            "bastionHosts",
                            "Value when customer wants to provide custom naming convention for Bastion."
                          ],
                          [
                            "ddosProtectionPlans",
                            "Value when customer wants to provide custom naming convention for DDoS protection plan."
                          ],
                          [
                            "networkSecurityGroups",
                            "Value when customer wants to provide custom naming convention for Bastion NSG."
                          ],
                          [
                            "virtualNetworks",
                            "Value when customer wants to provide custom naming convention for virtual network."
                          ],
                          [
                            "routeTables",
                            "Value when customer wants to provide custom naming convention for route table."
                          ]
                        ]
                      }
                    },
                    {
                      "#name": "formula",
                      "Description": {
                        "new": "The custom naming formula for the resource type.",
                        "old": "The custom formula for the resource type."
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LandingZoneConfigurationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
authoringStatus:
{
Description: The status that indicates the current phase of the configuration process for a deployment. ,
Enum:
{
Authoring: 'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified. ,
ReadyForUse: 'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment. ,
Disabled: 'Disabled' status is set when the landing zone configuration is no longer in use. ,
}
,
Required: False ,
}
enum ,
ddosProtectionCreationOption:
{
Description: Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingDdosProtectionId:
{
Description: The resource ID of the DDoS protection plan when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsWorkspaceCreationOption:
{
Description: Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingLogAnalyticsWorkspaceId:
{
Description: The resource ID of the log analytics workspace when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
tags:
{
Description: Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'} ,
Required: False ,
}
[
{
name:
{
Description: A tag name. ,
Required: True ,
}
string ,
value:
{
Description: A tag value. ,
Required: False ,
}
string ,
}
,
]
,
firewallCreationOption:
{
Description: Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU. ,
Enum:
{
None: Select 'None' value to skip Firewall deployment. ,
Standard: Select 'Standard' value to deploy the Firewall Standard SKU. ,
Premium: Select 'Premium' value to deploy the Firewall Premium SKU. ,
}
,
Required: True ,
}
enum ,
firewallSubnetCidrBlock:
{
Description: The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation. ,
Required: False ,
}
string ,
gatewaySubnetCidrBlock:
{
Description: The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation. ,
Required: True ,
}
string ,
logRetentionInDays:
{
Description: Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days. ,
Format: int64 ,
Required: True ,
}
integer ,
hubNetworkCidrBlock:
{
Description: The Virtual Network address. Specify the address using IPv4 CIDR notation. ,
Required: True ,
}
string ,
azureBastionCreationOption:
{
Description: Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingAzureBastionId:
{
Description: The resource ID of the Bastion when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
azureBastionSubnetCidrBlock:
{
Description: The Bastion subnet address. Specify the address using IPv4 CIDR notation. ,
Required: False ,
}
string ,
landingZonesMgChildren:
{
Description: The child management groups of 'Landing Zones' management group and their assigned policies. ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
topLevelMgMetadata:
{
Description: The assigned policies of the parent management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
Description: The assigned policies of the 'Landing Zones' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformMgMetadata:
{
Description: The assigned policies of the 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
Description: The assigned policies of the 'Management' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
Description: The assigned policies of the 'Connectivity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
Description: The assigned policies of the 'Identity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
Description: The assigned policies of the 'Decommissioned' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
sandboxMgMetadata:
{
Description: The assigned policies of the 'Sandbox' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone configuration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
platformMgChildren:
{
Description: The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management' ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
namingConventionFormula:
{
Description: The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing ,
Required: False ,
}
string ,
customNamingConvention:
{
Description: The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}] ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Enum:
{
azureFirewalls: Value when customer wants to provide a custom naming convention for Azure Firewall. ,
workspaces: Value when customer wants to provide a custom naming convention for Log Analytics workspace. ,
automationAccounts: Value when customer wants to provide a custom naming convention for automation account. ,
dashboards: Value when customer wants to provide a custom naming convention for dashboard. ,
userAssignedIdentities: Value when customer wants to provide a custom naming convention for managed identity. ,
bastionHosts: Value when customer wants to provide a custom naming convention for Bastion. ,
ddosProtectionPlans: Value when customer wants to provide a custom naming convention for DDoS protection plan. ,
networkSecurityGroups: Value when customer wants to provide a custom naming convention for Bastion NSG. ,
virtualNetworks: Value when customer wants to provide a custom naming convention for virtual network. ,
routeTables: Value when customer wants to provide a custom naming convention for route table. ,
}
,
Required: True ,
}
enum ,
formula:
{
Description: The custom naming formula for the resource type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_Get (updated)
Description :  Get a landing zone configuration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneConfigurationOperations_Get",
  "Description": {
    "new": "Get a landing zone configuration.",
    "old": "Gets the landing zone configuration."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration.",
              "old": "The status of a user-initiated, control-plane operation on the landing zone configuration."
            }
          },
          {
            "#name": "authoringStatus",
            "Description": {
              "new": "The status that indicates the current phase of the configuration process for a deployment.",
              "old": "The status for the landing zone configurations workflow."
            },
            "Enum": {
              "new": [
                [
                  "Authoring",
                  "'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified."
                ],
                [
                  "ReadyForUse",
                  "'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment."
                ],
                [
                  "Disabled",
                  "'Disabled' status is set when the landing zone configuration is no longer in use."
                ]
              ],
              "old": [
                [
                  "Authoring",
                  "This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated."
                ],
                [
                  "ReadyForUse",
                  "This status is set when the configuration changes are complete and the configuration is ready for code generation"
                ],
                [
                  "Disabled",
                  "This status is set when the landing zone configuration is no longer in use."
                ]
              ]
            }
          },
          {
            "#name": "ddosProtectionCreationOption",
            "Description": {
              "new": "Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan.",
              "old": "To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan."
            }
          },
          {
            "#name": "existingDdosProtectionId",
            "Description": {
              "new": "The resource ID of the DDoS protection plan when reusing an existing one.",
              "old": "The resource id of the ddos protection plan."
            }
          },
          {
            "#name": "logAnalyticsWorkspaceCreationOption",
            "Description": {
              "new": "Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace.",
              "old": "To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace."
            }
          },
          {
            "#name": "existingLogAnalyticsWorkspaceId",
            "Description": {
              "new": "The resource ID of the log analytics workspace when reusing an existing one.",
              "old": "The resource id of the log analytics workspace that was created to centralize log ingestion."
            }
          },
          {
            "#name": "tags",
            "Description": {
              "new": "Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'}",
              "old": "Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}."
            },
            "$items": {
              "Description": {
                "new": "Key-value pairs that can be assigned to this resource.",
                "old": "The details associated with tags."
              }
            }
          },
          {
            "#name": "firewallCreationOption",
            "Description": {
              "new": "Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU.",
              "old": "To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one."
            },
            "Enum": {
              "new": [
                [
                  "None",
                  "Select 'None' value to skip Firewall deployment."
                ],
                [
                  "Standard",
                  "Select 'Standard' value to deploy the Firewall Standard SKU."
                ],
                [
                  "Premium",
                  "Select 'Premium' value to deploy the Firewall Premium SKU."
                ]
              ],
              "old": [
                [
                  "None",
                  "Value when a firewall resource is not created."
                ],
                [
                  "Standard",
                  "Value when the firewall creation is based on the standard SKU."
                ],
                [
                  "Premium",
                  "Value when the firewall creation is based on the premium SKU."
                ]
              ]
            }
          },
          {
            "#name": "firewallSubnetCidrBlock",
            "Description": {
              "new": "The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation.",
              "old": "Azure firewall subnet. IPv4 CIDR block."
            }
          },
          {
            "#name": "gatewaySubnetCidrBlock",
            "Description": {
              "new": "The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation.",
              "old": "Gateway subnet. IPv4 CIDR block."
            }
          },
          {
            "#name": "logRetentionInDays",
            "Description": {
              "new": "Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days.",
              "old": "Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730"
            }
          },
          {
            "#name": "hubNetworkCidrBlock",
            "Description": {
              "new": "The Virtual Network address. Specify the address using IPv4 CIDR notation.",
              "old": "The address space for the VNET. IPv4 CIDR block."
            }
          },
          {
            "#name": "azureBastionCreationOption",
            "Description": {
              "new": "Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion.",
              "old": "To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service."
            }
          },
          {
            "#name": "existingAzureBastionId",
            "Description": {
              "new": "The resource ID of the Bastion when reusing an existing one.",
              "old": "The resource id of azure bastion."
            }
          },
          {
            "#name": "azureBastionSubnetCidrBlock",
            "Description": {
              "new": "The Bastion subnet address. Specify the address using IPv4 CIDR notation.",
              "old": "Azure bastion subnet. IP v4 CIDR block."
            }
          },
          {
            "#name": "landingZonesMgChildren",
            "Description": {
              "new": "The child management groups of 'Landing Zones' management group and their assigned policies.",
              "old": "Landing zone children management group properties"
            },
            "$items": {
              "Description": {
                "new": "The 'Landing Zones' management group properties..",
                "old": "Landing zone management group properties."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            }
          },
          {
            "#name": "topLevelMgMetadata",
            "Description": {
              "new": "The assigned policies of the parent management group.",
              "old": "This will be applied to the root of the landing zone deployment."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "landingZonesMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Landing Zones' management group.",
              "old": "This will be applied to the landing zone management groups."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Platform' management group.",
              "old": "This will be applied to the platform management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformManagementMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Management' management group under 'Platform' management group.",
              "old": "This will be applied to the management management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformConnectivityMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Connectivity' management group under 'Platform' management group.",
              "old": "This will be applied to the connectivity management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformIdentityMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Identity' management group under 'Platform' management group.",
              "old": "This will be applied to the identity management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "decommissionedMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Decommissioned' management group and indicator to create it or not.",
              "old": "This will be applied to the decommissioned management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              },
              {
                "#name": "create",
                "Description": {
                  "new": "This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                  "old": "When set to false, this management group will not be created. The default value is false."
                }
              }
            ]
          },
          {
            "#name": "sandboxMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Sandbox' management group and indicator to create it or not.",
              "old": "This will be applied to the sandbox management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              },
              {
                "#name": "create",
                "Description": {
                  "new": "This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                  "old": "When set to false this management group will not be created. The default value is false."
                }
              }
            ]
          },
          {
            "#name": "managedIdentity",
            "Description": {
              "new": "The managed identity to be assigned to this landing zone configuration.",
              "old": "The managed identity to be tied to this landing zone configuration"
            }
          },
          {
            "#name": "platformMgChildren",
            "Description": {
              "new": "The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management'",
              "old": "Platform children management group properties."
            },
            "$items": {
              "Description": {
                "new": "The 'Platform' management group properties.",
                "old": "Platform management group properties."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            }
          },
          {
            "#name": "namingConventionFormula",
            "Description": {
              "new": "The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing",
              "old": "The naming convention that's used by default for all resource types for this landing zone configuration"
            }
          },
          {
            "#name": "customNamingConvention",
            "Description": {
              "new": "The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}]",
              "old": "The customized naming convention for one or more resource types in this landing zone configuration"
            },
            "$items": {
              "Description": {
                "new": "The details for the custom naming convention override for a specific resource type.",
                "old": "The details for the custom resource override."
              },
              "$properties": [
                {
                  "#name": "resourceType",
                  "Enum": {
                    "new": [
                      [
                        "azureFirewalls",
                        "Value when customer wants to provide a custom naming convention for Azure Firewall."
                      ],
                      [
                        "workspaces",
                        "Value when customer wants to provide a custom naming convention for Log Analytics workspace."
                      ],
                      [
                        "automationAccounts",
                        "Value when customer wants to provide a custom naming convention for automation account."
                      ],
                      [
                        "dashboards",
                        "Value when customer wants to provide a custom naming convention for dashboard."
                      ],
                      [
                        "userAssignedIdentities",
                        "Value when customer wants to provide a custom naming convention for managed identity."
                      ],
                      [
                        "bastionHosts",
                        "Value when customer wants to provide a custom naming convention for Bastion."
                      ],
                      [
                        "ddosProtectionPlans",
                        "Value when customer wants to provide a custom naming convention for DDoS protection plan."
                      ],
                      [
                        "networkSecurityGroups",
                        "Value when customer wants to provide a custom naming convention for Bastion NSG."
                      ],
                      [
                        "virtualNetworks",
                        "Value when customer wants to provide a custom naming convention for virtual network."
                      ],
                      [
                        "routeTables",
                        "Value when customer wants to provide a custom naming convention for route table."
                      ]
                    ],
                    "old": [
                      [
                        "azureFirewalls",
                        "Value when customer wants to provide custom naming convention for Azure Firewall."
                      ],
                      [
                        "workspaces",
                        "Value when customer wants to provide custom naming convention for Log Analytics workspace."
                      ],
                      [
                        "automationAccounts",
                        "Value when customer wants to provide custom naming convention for automation account."
                      ],
                      [
                        "dashboards",
                        "Value when customer wants to provide custom naming convention for dashboard."
                      ],
                      [
                        "userAssignedIdentities",
                        "Value when customer wants to provide custom naming convention for managed identity."
                      ],
                      [
                        "bastionHosts",
                        "Value when customer wants to provide custom naming convention for Bastion."
                      ],
                      [
                        "ddosProtectionPlans",
                        "Value when customer wants to provide custom naming convention for DDoS protection plan."
                      ],
                      [
                        "networkSecurityGroups",
                        "Value when customer wants to provide custom naming convention for Bastion NSG."
                      ],
                      [
                        "virtualNetworks",
                        "Value when customer wants to provide custom naming convention for virtual network."
                      ],
                      [
                        "routeTables",
                        "Value when customer wants to provide custom naming convention for route table."
                      ]
                    ]
                  }
                },
                {
                  "#name": "formula",
                  "Description": {
                    "new": "The custom naming formula for the resource type.",
                    "old": "The custom formula for the resource type."
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneConfigurationName:
{
Description: The landing zone configuration name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
authoringStatus:
{
Description: The status that indicates the current phase of the configuration process for a deployment. ,
Enum:
{
Authoring: 'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified. ,
ReadyForUse: 'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment. ,
Disabled: 'Disabled' status is set when the landing zone configuration is no longer in use. ,
}
,
Required: False ,
}
enum ,
ddosProtectionCreationOption:
{
Description: Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingDdosProtectionId:
{
Description: The resource ID of the DDoS protection plan when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsWorkspaceCreationOption:
{
Description: Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingLogAnalyticsWorkspaceId:
{
Description: The resource ID of the log analytics workspace when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
tags:
{
Description: Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'} ,
Required: False ,
}
[
{
name:
{
Description: A tag name. ,
Required: True ,
}
string ,
value:
{
Description: A tag value. ,
Required: False ,
}
string ,
}
,
]
,
firewallCreationOption:
{
Description: Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU. ,
Enum:
{
None: Select 'None' value to skip Firewall deployment. ,
Standard: Select 'Standard' value to deploy the Firewall Standard SKU. ,
Premium: Select 'Premium' value to deploy the Firewall Premium SKU. ,
}
,
Required: True ,
}
enum ,
firewallSubnetCidrBlock:
{
Description: The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation. ,
Required: False ,
}
string ,
gatewaySubnetCidrBlock:
{
Description: The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation. ,
Required: True ,
}
string ,
logRetentionInDays:
{
Description: Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days. ,
Format: int64 ,
Required: True ,
}
integer ,
hubNetworkCidrBlock:
{
Description: The Virtual Network address. Specify the address using IPv4 CIDR notation. ,
Required: True ,
}
string ,
azureBastionCreationOption:
{
Description: Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingAzureBastionId:
{
Description: The resource ID of the Bastion when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
azureBastionSubnetCidrBlock:
{
Description: The Bastion subnet address. Specify the address using IPv4 CIDR notation. ,
Required: False ,
}
string ,
landingZonesMgChildren:
{
Description: The child management groups of 'Landing Zones' management group and their assigned policies. ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
topLevelMgMetadata:
{
Description: The assigned policies of the parent management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
Description: The assigned policies of the 'Landing Zones' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformMgMetadata:
{
Description: The assigned policies of the 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
Description: The assigned policies of the 'Management' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
Description: The assigned policies of the 'Connectivity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
Description: The assigned policies of the 'Identity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
Description: The assigned policies of the 'Decommissioned' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
sandboxMgMetadata:
{
Description: The assigned policies of the 'Sandbox' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone configuration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
platformMgChildren:
{
Description: The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management' ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
namingConventionFormula:
{
Description: The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing ,
Required: False ,
}
string ,
customNamingConvention:
{
Description: The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}] ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Enum:
{
azureFirewalls: Value when customer wants to provide a custom naming convention for Azure Firewall. ,
workspaces: Value when customer wants to provide a custom naming convention for Log Analytics workspace. ,
automationAccounts: Value when customer wants to provide a custom naming convention for automation account. ,
dashboards: Value when customer wants to provide a custom naming convention for dashboard. ,
userAssignedIdentities: Value when customer wants to provide a custom naming convention for managed identity. ,
bastionHosts: Value when customer wants to provide a custom naming convention for Bastion. ,
ddosProtectionPlans: Value when customer wants to provide a custom naming convention for DDoS protection plan. ,
networkSecurityGroups: Value when customer wants to provide a custom naming convention for Bastion NSG. ,
virtualNetworks: Value when customer wants to provide a custom naming convention for virtual network. ,
routeTables: Value when customer wants to provide a custom naming convention for route table. ,
}
,
Required: True ,
}
enum ,
formula:
{
Description: The custom naming formula for the resource type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_Create (updated)
Description :  Create a landing zone configuration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneConfigurationOperations_Create",
  "Description": {
    "new": "Create a landing zone configuration.",
    "old": "Creates the landing zone configuration."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "resource": {
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration.",
                "old": "The status of a user-initiated, control-plane operation on the landing zone configuration."
              }
            },
            {
              "#name": "authoringStatus",
              "Description": {
                "new": "The status that indicates the current phase of the configuration process for a deployment.",
                "old": "The status for the landing zone configurations workflow."
              },
              "Enum": {
                "new": [
                  [
                    "Authoring",
                    "'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified."
                  ],
                  [
                    "ReadyForUse",
                    "'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment."
                  ],
                  [
                    "Disabled",
                    "'Disabled' status is set when the landing zone configuration is no longer in use."
                  ]
                ],
                "old": [
                  [
                    "Authoring",
                    "This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated."
                  ],
                  [
                    "ReadyForUse",
                    "This status is set when the configuration changes are complete and the configuration is ready for code generation"
                  ],
                  [
                    "Disabled",
                    "This status is set when the landing zone configuration is no longer in use."
                  ]
                ]
              }
            },
            {
              "#name": "ddosProtectionCreationOption",
              "Description": {
                "new": "Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan.",
                "old": "To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan."
              }
            },
            {
              "#name": "existingDdosProtectionId",
              "Description": {
                "new": "The resource ID of the DDoS protection plan when reusing an existing one.",
                "old": "The resource id of the ddos protection plan."
              }
            },
            {
              "#name": "logAnalyticsWorkspaceCreationOption",
              "Description": {
                "new": "Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace.",
                "old": "To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace."
              }
            },
            {
              "#name": "existingLogAnalyticsWorkspaceId",
              "Description": {
                "new": "The resource ID of the log analytics workspace when reusing an existing one.",
                "old": "The resource id of the log analytics workspace that was created to centralize log ingestion."
              }
            },
            {
              "#name": "tags",
              "Description": {
                "new": "Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'}",
                "old": "Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}."
              },
              "$items": {
                "Description": {
                  "new": "Key-value pairs that can be assigned to this resource.",
                  "old": "The details associated with tags."
                }
              }
            },
            {
              "#name": "firewallCreationOption",
              "Description": {
                "new": "Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU.",
                "old": "To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one."
              },
              "Enum": {
                "new": [
                  [
                    "None",
                    "Select 'None' value to skip Firewall deployment."
                  ],
                  [
                    "Standard",
                    "Select 'Standard' value to deploy the Firewall Standard SKU."
                  ],
                  [
                    "Premium",
                    "Select 'Premium' value to deploy the Firewall Premium SKU."
                  ]
                ],
                "old": [
                  [
                    "None",
                    "Value when a firewall resource is not created."
                  ],
                  [
                    "Standard",
                    "Value when the firewall creation is based on the standard SKU."
                  ],
                  [
                    "Premium",
                    "Value when the firewall creation is based on the premium SKU."
                  ]
                ]
              }
            },
            {
              "#name": "firewallSubnetCidrBlock",
              "Description": {
                "new": "The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation.",
                "old": "Azure firewall subnet. IPv4 CIDR block."
              }
            },
            {
              "#name": "gatewaySubnetCidrBlock",
              "Description": {
                "new": "The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation.",
                "old": "Gateway subnet. IPv4 CIDR block."
              }
            },
            {
              "#name": "logRetentionInDays",
              "Description": {
                "new": "Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days.",
                "old": "Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730"
              }
            },
            {
              "#name": "hubNetworkCidrBlock",
              "Description": {
                "new": "The Virtual Network address. Specify the address using IPv4 CIDR notation.",
                "old": "The address space for the VNET. IPv4 CIDR block."
              }
            },
            {
              "#name": "azureBastionCreationOption",
              "Description": {
                "new": "Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion.",
                "old": "To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service."
              }
            },
            {
              "#name": "existingAzureBastionId",
              "Description": {
                "new": "The resource ID of the Bastion when reusing an existing one.",
                "old": "The resource id of azure bastion."
              }
            },
            {
              "#name": "azureBastionSubnetCidrBlock",
              "Description": {
                "new": "The Bastion subnet address. Specify the address using IPv4 CIDR notation.",
                "old": "Azure bastion subnet. IP v4 CIDR block."
              }
            },
            {
              "#name": "landingZonesMgChildren",
              "Description": {
                "new": "The child management groups of 'Landing Zones' management group and their assigned policies.",
                "old": "Landing zone children management group properties"
              },
              "$items": {
                "Description": {
                  "new": "The 'Landing Zones' management group properties..",
                  "old": "Landing zone management group properties."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "topLevelMgMetadata",
              "Description": {
                "new": "The assigned policies of the parent management group.",
                "old": "This will be applied to the root of the landing zone deployment."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "landingZonesMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Landing Zones' management group.",
                "old": "This will be applied to the landing zone management groups."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "platformMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Platform' management group.",
                "old": "This will be applied to the platform management group."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "platformManagementMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Management' management group under 'Platform' management group.",
                "old": "This will be applied to the management management group under platform."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "platformConnectivityMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Connectivity' management group under 'Platform' management group.",
                "old": "This will be applied to the connectivity management group under platform."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "platformIdentityMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Identity' management group under 'Platform' management group.",
                "old": "This will be applied to the identity management group under platform."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "decommissionedMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Decommissioned' management group and indicator to create it or not.",
                "old": "This will be applied to the decommissioned management group."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                },
                {
                  "#name": "create",
                  "Description": {
                    "new": "This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                    "old": "When set to false, this management group will not be created. The default value is false."
                  }
                }
              ]
            },
            {
              "#name": "sandboxMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Sandbox' management group and indicator to create it or not.",
                "old": "This will be applied to the sandbox management group."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                },
                {
                  "#name": "create",
                  "Description": {
                    "new": "This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                    "old": "When set to false this management group will not be created. The default value is false."
                  }
                }
              ]
            },
            {
              "#name": "managedIdentity",
              "Description": {
                "new": "The managed identity to be assigned to this landing zone configuration.",
                "old": "The managed identity to be tied to this landing zone configuration"
              }
            },
            {
              "#name": "platformMgChildren",
              "Description": {
                "new": "The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management'",
                "old": "Platform children management group properties."
              },
              "$items": {
                "Description": {
                  "new": "The 'Platform' management group properties.",
                  "old": "Platform management group properties."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "namingConventionFormula",
              "Description": {
                "new": "The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing",
                "old": "The naming convention that's used by default for all resource types for this landing zone configuration"
              }
            },
            {
              "#name": "customNamingConvention",
              "Description": {
                "new": "The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}]",
                "old": "The customized naming convention for one or more resource types in this landing zone configuration"
              },
              "$items": {
                "Description": {
                  "new": "The details for the custom naming convention override for a specific resource type.",
                  "old": "The details for the custom resource override."
                },
                "$properties": [
                  {
                    "#name": "resourceType",
                    "Enum": {
                      "new": [
                        [
                          "azureFirewalls",
                          "Value when customer wants to provide a custom naming convention for Azure Firewall."
                        ],
                        [
                          "workspaces",
                          "Value when customer wants to provide a custom naming convention for Log Analytics workspace."
                        ],
                        [
                          "automationAccounts",
                          "Value when customer wants to provide a custom naming convention for automation account."
                        ],
                        [
                          "dashboards",
                          "Value when customer wants to provide a custom naming convention for dashboard."
                        ],
                        [
                          "userAssignedIdentities",
                          "Value when customer wants to provide a custom naming convention for managed identity."
                        ],
                        [
                          "bastionHosts",
                          "Value when customer wants to provide a custom naming convention for Bastion."
                        ],
                        [
                          "ddosProtectionPlans",
                          "Value when customer wants to provide a custom naming convention for DDoS protection plan."
                        ],
                        [
                          "networkSecurityGroups",
                          "Value when customer wants to provide a custom naming convention for Bastion NSG."
                        ],
                        [
                          "virtualNetworks",
                          "Value when customer wants to provide a custom naming convention for virtual network."
                        ],
                        [
                          "routeTables",
                          "Value when customer wants to provide a custom naming convention for route table."
                        ]
                      ],
                      "old": [
                        [
                          "azureFirewalls",
                          "Value when customer wants to provide custom naming convention for Azure Firewall."
                        ],
                        [
                          "workspaces",
                          "Value when customer wants to provide custom naming convention for Log Analytics workspace."
                        ],
                        [
                          "automationAccounts",
                          "Value when customer wants to provide custom naming convention for automation account."
                        ],
                        [
                          "dashboards",
                          "Value when customer wants to provide custom naming convention for dashboard."
                        ],
                        [
                          "userAssignedIdentities",
                          "Value when customer wants to provide custom naming convention for managed identity."
                        ],
                        [
                          "bastionHosts",
                          "Value when customer wants to provide custom naming convention for Bastion."
                        ],
                        [
                          "ddosProtectionPlans",
                          "Value when customer wants to provide custom naming convention for DDoS protection plan."
                        ],
                        [
                          "networkSecurityGroups",
                          "Value when customer wants to provide custom naming convention for Bastion NSG."
                        ],
                        [
                          "virtualNetworks",
                          "Value when customer wants to provide custom naming convention for virtual network."
                        ],
                        [
                          "routeTables",
                          "Value when customer wants to provide custom naming convention for route table."
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "formula",
                    "Description": {
                      "new": "The custom naming formula for the resource type.",
                      "old": "The custom formula for the resource type."
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration.",
              "old": "The status of a user-initiated, control-plane operation on the landing zone configuration."
            }
          },
          {
            "#name": "authoringStatus",
            "Description": {
              "new": "The status that indicates the current phase of the configuration process for a deployment.",
              "old": "The status for the landing zone configurations workflow."
            },
            "Enum": {
              "new": [
                [
                  "Authoring",
                  "'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified."
                ],
                [
                  "ReadyForUse",
                  "'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment."
                ],
                [
                  "Disabled",
                  "'Disabled' status is set when the landing zone configuration is no longer in use."
                ]
              ],
              "old": [
                [
                  "Authoring",
                  "This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated."
                ],
                [
                  "ReadyForUse",
                  "This status is set when the configuration changes are complete and the configuration is ready for code generation"
                ],
                [
                  "Disabled",
                  "This status is set when the landing zone configuration is no longer in use."
                ]
              ]
            }
          },
          {
            "#name": "ddosProtectionCreationOption",
            "Description": {
              "new": "Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan.",
              "old": "To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan."
            }
          },
          {
            "#name": "existingDdosProtectionId",
            "Description": {
              "new": "The resource ID of the DDoS protection plan when reusing an existing one.",
              "old": "The resource id of the ddos protection plan."
            }
          },
          {
            "#name": "logAnalyticsWorkspaceCreationOption",
            "Description": {
              "new": "Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace.",
              "old": "To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace."
            }
          },
          {
            "#name": "existingLogAnalyticsWorkspaceId",
            "Description": {
              "new": "The resource ID of the log analytics workspace when reusing an existing one.",
              "old": "The resource id of the log analytics workspace that was created to centralize log ingestion."
            }
          },
          {
            "#name": "tags",
            "Description": {
              "new": "Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'}",
              "old": "Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}."
            },
            "$items": {
              "Description": {
                "new": "Key-value pairs that can be assigned to this resource.",
                "old": "The details associated with tags."
              }
            }
          },
          {
            "#name": "firewallCreationOption",
            "Description": {
              "new": "Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU.",
              "old": "To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one."
            },
            "Enum": {
              "new": [
                [
                  "None",
                  "Select 'None' value to skip Firewall deployment."
                ],
                [
                  "Standard",
                  "Select 'Standard' value to deploy the Firewall Standard SKU."
                ],
                [
                  "Premium",
                  "Select 'Premium' value to deploy the Firewall Premium SKU."
                ]
              ],
              "old": [
                [
                  "None",
                  "Value when a firewall resource is not created."
                ],
                [
                  "Standard",
                  "Value when the firewall creation is based on the standard SKU."
                ],
                [
                  "Premium",
                  "Value when the firewall creation is based on the premium SKU."
                ]
              ]
            }
          },
          {
            "#name": "firewallSubnetCidrBlock",
            "Description": {
              "new": "The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation.",
              "old": "Azure firewall subnet. IPv4 CIDR block."
            }
          },
          {
            "#name": "gatewaySubnetCidrBlock",
            "Description": {
              "new": "The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation.",
              "old": "Gateway subnet. IPv4 CIDR block."
            }
          },
          {
            "#name": "logRetentionInDays",
            "Description": {
              "new": "Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days.",
              "old": "Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730"
            }
          },
          {
            "#name": "hubNetworkCidrBlock",
            "Description": {
              "new": "The Virtual Network address. Specify the address using IPv4 CIDR notation.",
              "old": "The address space for the VNET. IPv4 CIDR block."
            }
          },
          {
            "#name": "azureBastionCreationOption",
            "Description": {
              "new": "Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion.",
              "old": "To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service."
            }
          },
          {
            "#name": "existingAzureBastionId",
            "Description": {
              "new": "The resource ID of the Bastion when reusing an existing one.",
              "old": "The resource id of azure bastion."
            }
          },
          {
            "#name": "azureBastionSubnetCidrBlock",
            "Description": {
              "new": "The Bastion subnet address. Specify the address using IPv4 CIDR notation.",
              "old": "Azure bastion subnet. IP v4 CIDR block."
            }
          },
          {
            "#name": "landingZonesMgChildren",
            "Description": {
              "new": "The child management groups of 'Landing Zones' management group and their assigned policies.",
              "old": "Landing zone children management group properties"
            },
            "$items": {
              "Description": {
                "new": "The 'Landing Zones' management group properties..",
                "old": "Landing zone management group properties."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            }
          },
          {
            "#name": "topLevelMgMetadata",
            "Description": {
              "new": "The assigned policies of the parent management group.",
              "old": "This will be applied to the root of the landing zone deployment."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "landingZonesMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Landing Zones' management group.",
              "old": "This will be applied to the landing zone management groups."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Platform' management group.",
              "old": "This will be applied to the platform management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformManagementMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Management' management group under 'Platform' management group.",
              "old": "This will be applied to the management management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformConnectivityMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Connectivity' management group under 'Platform' management group.",
              "old": "This will be applied to the connectivity management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformIdentityMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Identity' management group under 'Platform' management group.",
              "old": "This will be applied to the identity management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "decommissionedMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Decommissioned' management group and indicator to create it or not.",
              "old": "This will be applied to the decommissioned management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              },
              {
                "#name": "create",
                "Description": {
                  "new": "This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                  "old": "When set to false, this management group will not be created. The default value is false."
                }
              }
            ]
          },
          {
            "#name": "sandboxMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Sandbox' management group and indicator to create it or not.",
              "old": "This will be applied to the sandbox management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              },
              {
                "#name": "create",
                "Description": {
                  "new": "This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                  "old": "When set to false this management group will not be created. The default value is false."
                }
              }
            ]
          },
          {
            "#name": "managedIdentity",
            "Description": {
              "new": "The managed identity to be assigned to this landing zone configuration.",
              "old": "The managed identity to be tied to this landing zone configuration"
            }
          },
          {
            "#name": "platformMgChildren",
            "Description": {
              "new": "The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management'",
              "old": "Platform children management group properties."
            },
            "$items": {
              "Description": {
                "new": "The 'Platform' management group properties.",
                "old": "Platform management group properties."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            }
          },
          {
            "#name": "namingConventionFormula",
            "Description": {
              "new": "The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing",
              "old": "The naming convention that's used by default for all resource types for this landing zone configuration"
            }
          },
          {
            "#name": "customNamingConvention",
            "Description": {
              "new": "The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}]",
              "old": "The customized naming convention for one or more resource types in this landing zone configuration"
            },
            "$items": {
              "Description": {
                "new": "The details for the custom naming convention override for a specific resource type.",
                "old": "The details for the custom resource override."
              },
              "$properties": [
                {
                  "#name": "resourceType",
                  "Enum": {
                    "new": [
                      [
                        "azureFirewalls",
                        "Value when customer wants to provide a custom naming convention for Azure Firewall."
                      ],
                      [
                        "workspaces",
                        "Value when customer wants to provide a custom naming convention for Log Analytics workspace."
                      ],
                      [
                        "automationAccounts",
                        "Value when customer wants to provide a custom naming convention for automation account."
                      ],
                      [
                        "dashboards",
                        "Value when customer wants to provide a custom naming convention for dashboard."
                      ],
                      [
                        "userAssignedIdentities",
                        "Value when customer wants to provide a custom naming convention for managed identity."
                      ],
                      [
                        "bastionHosts",
                        "Value when customer wants to provide a custom naming convention for Bastion."
                      ],
                      [
                        "ddosProtectionPlans",
                        "Value when customer wants to provide a custom naming convention for DDoS protection plan."
                      ],
                      [
                        "networkSecurityGroups",
                        "Value when customer wants to provide a custom naming convention for Bastion NSG."
                      ],
                      [
                        "virtualNetworks",
                        "Value when customer wants to provide a custom naming convention for virtual network."
                      ],
                      [
                        "routeTables",
                        "Value when customer wants to provide a custom naming convention for route table."
                      ]
                    ],
                    "old": [
                      [
                        "azureFirewalls",
                        "Value when customer wants to provide custom naming convention for Azure Firewall."
                      ],
                      [
                        "workspaces",
                        "Value when customer wants to provide custom naming convention for Log Analytics workspace."
                      ],
                      [
                        "automationAccounts",
                        "Value when customer wants to provide custom naming convention for automation account."
                      ],
                      [
                        "dashboards",
                        "Value when customer wants to provide custom naming convention for dashboard."
                      ],
                      [
                        "userAssignedIdentities",
                        "Value when customer wants to provide custom naming convention for managed identity."
                      ],
                      [
                        "bastionHosts",
                        "Value when customer wants to provide custom naming convention for Bastion."
                      ],
                      [
                        "ddosProtectionPlans",
                        "Value when customer wants to provide custom naming convention for DDoS protection plan."
                      ],
                      [
                        "networkSecurityGroups",
                        "Value when customer wants to provide custom naming convention for Bastion NSG."
                      ],
                      [
                        "virtualNetworks",
                        "Value when customer wants to provide custom naming convention for virtual network."
                      ],
                      [
                        "routeTables",
                        "Value when customer wants to provide custom naming convention for route table."
                      ]
                    ]
                  }
                },
                {
                  "#name": "formula",
                  "Description": {
                    "new": "The custom naming formula for the resource type.",
                    "old": "The custom formula for the resource type."
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration.",
              "old": "The status of a user-initiated, control-plane operation on the landing zone configuration."
            }
          },
          {
            "#name": "authoringStatus",
            "Description": {
              "new": "The status that indicates the current phase of the configuration process for a deployment.",
              "old": "The status for the landing zone configurations workflow."
            },
            "Enum": {
              "new": [
                [
                  "Authoring",
                  "'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified."
                ],
                [
                  "ReadyForUse",
                  "'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment."
                ],
                [
                  "Disabled",
                  "'Disabled' status is set when the landing zone configuration is no longer in use."
                ]
              ],
              "old": [
                [
                  "Authoring",
                  "This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated."
                ],
                [
                  "ReadyForUse",
                  "This status is set when the configuration changes are complete and the configuration is ready for code generation"
                ],
                [
                  "Disabled",
                  "This status is set when the landing zone configuration is no longer in use."
                ]
              ]
            }
          },
          {
            "#name": "ddosProtectionCreationOption",
            "Description": {
              "new": "Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan.",
              "old": "To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan."
            }
          },
          {
            "#name": "existingDdosProtectionId",
            "Description": {
              "new": "The resource ID of the DDoS protection plan when reusing an existing one.",
              "old": "The resource id of the ddos protection plan."
            }
          },
          {
            "#name": "logAnalyticsWorkspaceCreationOption",
            "Description": {
              "new": "Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace.",
              "old": "To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace."
            }
          },
          {
            "#name": "existingLogAnalyticsWorkspaceId",
            "Description": {
              "new": "The resource ID of the log analytics workspace when reusing an existing one.",
              "old": "The resource id of the log analytics workspace that was created to centralize log ingestion."
            }
          },
          {
            "#name": "tags",
            "Description": {
              "new": "Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'}",
              "old": "Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}."
            },
            "$items": {
              "Description": {
                "new": "Key-value pairs that can be assigned to this resource.",
                "old": "The details associated with tags."
              }
            }
          },
          {
            "#name": "firewallCreationOption",
            "Description": {
              "new": "Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU.",
              "old": "To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one."
            },
            "Enum": {
              "new": [
                [
                  "None",
                  "Select 'None' value to skip Firewall deployment."
                ],
                [
                  "Standard",
                  "Select 'Standard' value to deploy the Firewall Standard SKU."
                ],
                [
                  "Premium",
                  "Select 'Premium' value to deploy the Firewall Premium SKU."
                ]
              ],
              "old": [
                [
                  "None",
                  "Value when a firewall resource is not created."
                ],
                [
                  "Standard",
                  "Value when the firewall creation is based on the standard SKU."
                ],
                [
                  "Premium",
                  "Value when the firewall creation is based on the premium SKU."
                ]
              ]
            }
          },
          {
            "#name": "firewallSubnetCidrBlock",
            "Description": {
              "new": "The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation.",
              "old": "Azure firewall subnet. IPv4 CIDR block."
            }
          },
          {
            "#name": "gatewaySubnetCidrBlock",
            "Description": {
              "new": "The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation.",
              "old": "Gateway subnet. IPv4 CIDR block."
            }
          },
          {
            "#name": "logRetentionInDays",
            "Description": {
              "new": "Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days.",
              "old": "Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730"
            }
          },
          {
            "#name": "hubNetworkCidrBlock",
            "Description": {
              "new": "The Virtual Network address. Specify the address using IPv4 CIDR notation.",
              "old": "The address space for the VNET. IPv4 CIDR block."
            }
          },
          {
            "#name": "azureBastionCreationOption",
            "Description": {
              "new": "Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion.",
              "old": "To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service."
            }
          },
          {
            "#name": "existingAzureBastionId",
            "Description": {
              "new": "The resource ID of the Bastion when reusing an existing one.",
              "old": "The resource id of azure bastion."
            }
          },
          {
            "#name": "azureBastionSubnetCidrBlock",
            "Description": {
              "new": "The Bastion subnet address. Specify the address using IPv4 CIDR notation.",
              "old": "Azure bastion subnet. IP v4 CIDR block."
            }
          },
          {
            "#name": "landingZonesMgChildren",
            "Description": {
              "new": "The child management groups of 'Landing Zones' management group and their assigned policies.",
              "old": "Landing zone children management group properties"
            },
            "$items": {
              "Description": {
                "new": "The 'Landing Zones' management group properties..",
                "old": "Landing zone management group properties."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            }
          },
          {
            "#name": "topLevelMgMetadata",
            "Description": {
              "new": "The assigned policies of the parent management group.",
              "old": "This will be applied to the root of the landing zone deployment."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "landingZonesMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Landing Zones' management group.",
              "old": "This will be applied to the landing zone management groups."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Platform' management group.",
              "old": "This will be applied to the platform management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformManagementMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Management' management group under 'Platform' management group.",
              "old": "This will be applied to the management management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformConnectivityMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Connectivity' management group under 'Platform' management group.",
              "old": "This will be applied to the connectivity management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformIdentityMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Identity' management group under 'Platform' management group.",
              "old": "This will be applied to the identity management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "decommissionedMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Decommissioned' management group and indicator to create it or not.",
              "old": "This will be applied to the decommissioned management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              },
              {
                "#name": "create",
                "Description": {
                  "new": "This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                  "old": "When set to false, this management group will not be created. The default value is false."
                }
              }
            ]
          },
          {
            "#name": "sandboxMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Sandbox' management group and indicator to create it or not.",
              "old": "This will be applied to the sandbox management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              },
              {
                "#name": "create",
                "Description": {
                  "new": "This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                  "old": "When set to false this management group will not be created. The default value is false."
                }
              }
            ]
          },
          {
            "#name": "managedIdentity",
            "Description": {
              "new": "The managed identity to be assigned to this landing zone configuration.",
              "old": "The managed identity to be tied to this landing zone configuration"
            }
          },
          {
            "#name": "platformMgChildren",
            "Description": {
              "new": "The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management'",
              "old": "Platform children management group properties."
            },
            "$items": {
              "Description": {
                "new": "The 'Platform' management group properties.",
                "old": "Platform management group properties."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            }
          },
          {
            "#name": "namingConventionFormula",
            "Description": {
              "new": "The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing",
              "old": "The naming convention that's used by default for all resource types for this landing zone configuration"
            }
          },
          {
            "#name": "customNamingConvention",
            "Description": {
              "new": "The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}]",
              "old": "The customized naming convention for one or more resource types in this landing zone configuration"
            },
            "$items": {
              "Description": {
                "new": "The details for the custom naming convention override for a specific resource type.",
                "old": "The details for the custom resource override."
              },
              "$properties": [
                {
                  "#name": "resourceType",
                  "Enum": {
                    "new": [
                      [
                        "azureFirewalls",
                        "Value when customer wants to provide a custom naming convention for Azure Firewall."
                      ],
                      [
                        "workspaces",
                        "Value when customer wants to provide a custom naming convention for Log Analytics workspace."
                      ],
                      [
                        "automationAccounts",
                        "Value when customer wants to provide a custom naming convention for automation account."
                      ],
                      [
                        "dashboards",
                        "Value when customer wants to provide a custom naming convention for dashboard."
                      ],
                      [
                        "userAssignedIdentities",
                        "Value when customer wants to provide a custom naming convention for managed identity."
                      ],
                      [
                        "bastionHosts",
                        "Value when customer wants to provide a custom naming convention for Bastion."
                      ],
                      [
                        "ddosProtectionPlans",
                        "Value when customer wants to provide a custom naming convention for DDoS protection plan."
                      ],
                      [
                        "networkSecurityGroups",
                        "Value when customer wants to provide a custom naming convention for Bastion NSG."
                      ],
                      [
                        "virtualNetworks",
                        "Value when customer wants to provide a custom naming convention for virtual network."
                      ],
                      [
                        "routeTables",
                        "Value when customer wants to provide a custom naming convention for route table."
                      ]
                    ],
                    "old": [
                      [
                        "azureFirewalls",
                        "Value when customer wants to provide custom naming convention for Azure Firewall."
                      ],
                      [
                        "workspaces",
                        "Value when customer wants to provide custom naming convention for Log Analytics workspace."
                      ],
                      [
                        "automationAccounts",
                        "Value when customer wants to provide custom naming convention for automation account."
                      ],
                      [
                        "dashboards",
                        "Value when customer wants to provide custom naming convention for dashboard."
                      ],
                      [
                        "userAssignedIdentities",
                        "Value when customer wants to provide custom naming convention for managed identity."
                      ],
                      [
                        "bastionHosts",
                        "Value when customer wants to provide custom naming convention for Bastion."
                      ],
                      [
                        "ddosProtectionPlans",
                        "Value when customer wants to provide custom naming convention for DDoS protection plan."
                      ],
                      [
                        "networkSecurityGroups",
                        "Value when customer wants to provide custom naming convention for Bastion NSG."
                      ],
                      [
                        "virtualNetworks",
                        "Value when customer wants to provide custom naming convention for virtual network."
                      ],
                      [
                        "routeTables",
                        "Value when customer wants to provide custom naming convention for route table."
                      ]
                    ]
                  }
                },
                {
                  "#name": "formula",
                  "Description": {
                    "new": "The custom naming formula for the resource type.",
                    "old": "The custom formula for the resource type."
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneConfigurationName:
{
Description: The landing zone configuration name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
authoringStatus:
{
Description: The status that indicates the current phase of the configuration process for a deployment. ,
Enum:
{
Authoring: 'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified. ,
ReadyForUse: 'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment. ,
Disabled: 'Disabled' status is set when the landing zone configuration is no longer in use. ,
}
,
Required: False ,
}
enum ,
ddosProtectionCreationOption:
{
Description: Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingDdosProtectionId:
{
Description: The resource ID of the DDoS protection plan when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsWorkspaceCreationOption:
{
Description: Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingLogAnalyticsWorkspaceId:
{
Description: The resource ID of the log analytics workspace when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
tags:
{
Description: Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'} ,
Required: False ,
}
[
{
name:
{
Description: A tag name. ,
Required: True ,
}
string ,
value:
{
Description: A tag value. ,
Required: False ,
}
string ,
}
,
]
,
firewallCreationOption:
{
Description: Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU. ,
Enum:
{
None: Select 'None' value to skip Firewall deployment. ,
Standard: Select 'Standard' value to deploy the Firewall Standard SKU. ,
Premium: Select 'Premium' value to deploy the Firewall Premium SKU. ,
}
,
Required: True ,
}
enum ,
firewallSubnetCidrBlock:
{
Description: The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation. ,
Required: False ,
}
string ,
gatewaySubnetCidrBlock:
{
Description: The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation. ,
Required: True ,
}
string ,
logRetentionInDays:
{
Description: Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days. ,
Format: int64 ,
Required: True ,
}
integer ,
hubNetworkCidrBlock:
{
Description: The Virtual Network address. Specify the address using IPv4 CIDR notation. ,
Required: True ,
}
string ,
azureBastionCreationOption:
{
Description: Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingAzureBastionId:
{
Description: The resource ID of the Bastion when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
azureBastionSubnetCidrBlock:
{
Description: The Bastion subnet address. Specify the address using IPv4 CIDR notation. ,
Required: False ,
}
string ,
landingZonesMgChildren:
{
Description: The child management groups of 'Landing Zones' management group and their assigned policies. ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
topLevelMgMetadata:
{
Description: The assigned policies of the parent management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
Description: The assigned policies of the 'Landing Zones' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformMgMetadata:
{
Description: The assigned policies of the 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
Description: The assigned policies of the 'Management' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
Description: The assigned policies of the 'Connectivity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
Description: The assigned policies of the 'Identity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
Description: The assigned policies of the 'Decommissioned' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
sandboxMgMetadata:
{
Description: The assigned policies of the 'Sandbox' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone configuration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
platformMgChildren:
{
Description: The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management' ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
namingConventionFormula:
{
Description: The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing ,
Required: False ,
}
string ,
customNamingConvention:
{
Description: The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}] ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Enum:
{
azureFirewalls: Value when customer wants to provide a custom naming convention for Azure Firewall. ,
workspaces: Value when customer wants to provide a custom naming convention for Log Analytics workspace. ,
automationAccounts: Value when customer wants to provide a custom naming convention for automation account. ,
dashboards: Value when customer wants to provide a custom naming convention for dashboard. ,
userAssignedIdentities: Value when customer wants to provide a custom naming convention for managed identity. ,
bastionHosts: Value when customer wants to provide a custom naming convention for Bastion. ,
ddosProtectionPlans: Value when customer wants to provide a custom naming convention for DDoS protection plan. ,
networkSecurityGroups: Value when customer wants to provide a custom naming convention for Bastion NSG. ,
virtualNetworks: Value when customer wants to provide a custom naming convention for virtual network. ,
routeTables: Value when customer wants to provide a custom naming convention for route table. ,
}
,
Required: True ,
}
enum ,
formula:
{
Description: The custom naming formula for the resource type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
authoringStatus:
{
Description: The status that indicates the current phase of the configuration process for a deployment. ,
Enum:
{
Authoring: 'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified. ,
ReadyForUse: 'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment. ,
Disabled: 'Disabled' status is set when the landing zone configuration is no longer in use. ,
}
,
Required: False ,
}
enum ,
ddosProtectionCreationOption:
{
Description: Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingDdosProtectionId:
{
Description: The resource ID of the DDoS protection plan when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsWorkspaceCreationOption:
{
Description: Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingLogAnalyticsWorkspaceId:
{
Description: The resource ID of the log analytics workspace when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
tags:
{
Description: Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'} ,
Required: False ,
}
[
{
name:
{
Description: A tag name. ,
Required: True ,
}
string ,
value:
{
Description: A tag value. ,
Required: False ,
}
string ,
}
,
]
,
firewallCreationOption:
{
Description: Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU. ,
Enum:
{
None: Select 'None' value to skip Firewall deployment. ,
Standard: Select 'Standard' value to deploy the Firewall Standard SKU. ,
Premium: Select 'Premium' value to deploy the Firewall Premium SKU. ,
}
,
Required: True ,
}
enum ,
firewallSubnetCidrBlock:
{
Description: The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation. ,
Required: False ,
}
string ,
gatewaySubnetCidrBlock:
{
Description: The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation. ,
Required: True ,
}
string ,
logRetentionInDays:
{
Description: Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days. ,
Format: int64 ,
Required: True ,
}
integer ,
hubNetworkCidrBlock:
{
Description: The Virtual Network address. Specify the address using IPv4 CIDR notation. ,
Required: True ,
}
string ,
azureBastionCreationOption:
{
Description: Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingAzureBastionId:
{
Description: The resource ID of the Bastion when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
azureBastionSubnetCidrBlock:
{
Description: The Bastion subnet address. Specify the address using IPv4 CIDR notation. ,
Required: False ,
}
string ,
landingZonesMgChildren:
{
Description: The child management groups of 'Landing Zones' management group and their assigned policies. ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
topLevelMgMetadata:
{
Description: The assigned policies of the parent management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
Description: The assigned policies of the 'Landing Zones' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformMgMetadata:
{
Description: The assigned policies of the 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
Description: The assigned policies of the 'Management' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
Description: The assigned policies of the 'Connectivity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
Description: The assigned policies of the 'Identity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
Description: The assigned policies of the 'Decommissioned' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
sandboxMgMetadata:
{
Description: The assigned policies of the 'Sandbox' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone configuration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
platformMgChildren:
{
Description: The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management' ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
namingConventionFormula:
{
Description: The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing ,
Required: False ,
}
string ,
customNamingConvention:
{
Description: The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}] ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Enum:
{
azureFirewalls: Value when customer wants to provide a custom naming convention for Azure Firewall. ,
workspaces: Value when customer wants to provide a custom naming convention for Log Analytics workspace. ,
automationAccounts: Value when customer wants to provide a custom naming convention for automation account. ,
dashboards: Value when customer wants to provide a custom naming convention for dashboard. ,
userAssignedIdentities: Value when customer wants to provide a custom naming convention for managed identity. ,
bastionHosts: Value when customer wants to provide a custom naming convention for Bastion. ,
ddosProtectionPlans: Value when customer wants to provide a custom naming convention for DDoS protection plan. ,
networkSecurityGroups: Value when customer wants to provide a custom naming convention for Bastion NSG. ,
virtualNetworks: Value when customer wants to provide a custom naming convention for virtual network. ,
routeTables: Value when customer wants to provide a custom naming convention for route table. ,
}
,
Required: True ,
}
enum ,
formula:
{
Description: The custom naming formula for the resource type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Concrete proxy resource types can be created by aliasing this type using a specific property type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
authoringStatus:
{
Description: The status that indicates the current phase of the configuration process for a deployment. ,
Enum:
{
Authoring: 'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified. ,
ReadyForUse: 'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment. ,
Disabled: 'Disabled' status is set when the landing zone configuration is no longer in use. ,
}
,
Required: False ,
}
enum ,
ddosProtectionCreationOption:
{
Description: Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingDdosProtectionId:
{
Description: The resource ID of the DDoS protection plan when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsWorkspaceCreationOption:
{
Description: Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingLogAnalyticsWorkspaceId:
{
Description: The resource ID of the log analytics workspace when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
tags:
{
Description: Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'} ,
Required: False ,
}
[
{
name:
{
Description: A tag name. ,
Required: True ,
}
string ,
value:
{
Description: A tag value. ,
Required: False ,
}
string ,
}
,
]
,
firewallCreationOption:
{
Description: Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU. ,
Enum:
{
None: Select 'None' value to skip Firewall deployment. ,
Standard: Select 'Standard' value to deploy the Firewall Standard SKU. ,
Premium: Select 'Premium' value to deploy the Firewall Premium SKU. ,
}
,
Required: True ,
}
enum ,
firewallSubnetCidrBlock:
{
Description: The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation. ,
Required: False ,
}
string ,
gatewaySubnetCidrBlock:
{
Description: The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation. ,
Required: True ,
}
string ,
logRetentionInDays:
{
Description: Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days. ,
Format: int64 ,
Required: True ,
}
integer ,
hubNetworkCidrBlock:
{
Description: The Virtual Network address. Specify the address using IPv4 CIDR notation. ,
Required: True ,
}
string ,
azureBastionCreationOption:
{
Description: Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingAzureBastionId:
{
Description: The resource ID of the Bastion when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
azureBastionSubnetCidrBlock:
{
Description: The Bastion subnet address. Specify the address using IPv4 CIDR notation. ,
Required: False ,
}
string ,
landingZonesMgChildren:
{
Description: The child management groups of 'Landing Zones' management group and their assigned policies. ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
topLevelMgMetadata:
{
Description: The assigned policies of the parent management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
Description: The assigned policies of the 'Landing Zones' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformMgMetadata:
{
Description: The assigned policies of the 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
Description: The assigned policies of the 'Management' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
Description: The assigned policies of the 'Connectivity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
Description: The assigned policies of the 'Identity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
Description: The assigned policies of the 'Decommissioned' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
sandboxMgMetadata:
{
Description: The assigned policies of the 'Sandbox' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone configuration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
platformMgChildren:
{
Description: The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management' ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
namingConventionFormula:
{
Description: The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing ,
Required: False ,
}
string ,
customNamingConvention:
{
Description: The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}] ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Enum:
{
azureFirewalls: Value when customer wants to provide a custom naming convention for Azure Firewall. ,
workspaces: Value when customer wants to provide a custom naming convention for Log Analytics workspace. ,
automationAccounts: Value when customer wants to provide a custom naming convention for automation account. ,
dashboards: Value when customer wants to provide a custom naming convention for dashboard. ,
userAssignedIdentities: Value when customer wants to provide a custom naming convention for managed identity. ,
bastionHosts: Value when customer wants to provide a custom naming convention for Bastion. ,
ddosProtectionPlans: Value when customer wants to provide a custom naming convention for DDoS protection plan. ,
networkSecurityGroups: Value when customer wants to provide a custom naming convention for Bastion NSG. ,
virtualNetworks: Value when customer wants to provide a custom naming convention for virtual network. ,
routeTables: Value when customer wants to provide a custom naming convention for route table. ,
}
,
Required: True ,
}
enum ,
formula:
{
Description: The custom naming formula for the resource type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_Update (updated)
Description :  Update a landing zone configuration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneConfigurationOperations_Update",
  "Description": {
    "new": "Update a landing zone configuration.",
    "old": "Updates the landing zone configuration."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "properties": {
        "$properties": {
          "properties": [
            {
              "#name": "ddosProtectionCreationOption",
              "Description": {
                "new": "Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan.",
                "old": "To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan."
              }
            },
            {
              "#name": "existingDdosProtectionId",
              "Description": {
                "new": "The resource ID of the DDoS protection plan when reusing an existing one.",
                "old": "The resource id of the ddos protection plan."
              }
            },
            {
              "#name": "logAnalyticsWorkspaceCreationOption",
              "Description": {
                "new": "Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace.",
                "old": "To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace."
              }
            },
            {
              "#name": "existingLogAnalyticsWorkspaceId",
              "Description": {
                "new": "The resource ID of the log analytics workspace when reusing an existing one.",
                "old": "The resource id of the log analytics workspace that was created to centralize log ingestion."
              }
            },
            {
              "#name": "tags",
              "Description": {
                "new": "Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'}",
                "old": "Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}."
              },
              "$items": {
                "Description": {
                  "new": "Key-value pairs that can be assigned to this resource.",
                  "old": "The details associated with tags."
                }
              }
            },
            {
              "#name": "firewallCreationOption",
              "Description": {
                "new": "Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU.",
                "old": "To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one."
              },
              "Enum": {
                "new": [
                  [
                    "None",
                    "Select 'None' value to skip Firewall deployment."
                  ],
                  [
                    "Standard",
                    "Select 'Standard' value to deploy the Firewall Standard SKU."
                  ],
                  [
                    "Premium",
                    "Select 'Premium' value to deploy the Firewall Premium SKU."
                  ]
                ],
                "old": [
                  [
                    "None",
                    "Value when a firewall resource is not created."
                  ],
                  [
                    "Standard",
                    "Value when the firewall creation is based on the standard SKU."
                  ],
                  [
                    "Premium",
                    "Value when the firewall creation is based on the premium SKU."
                  ]
                ]
              }
            },
            {
              "#name": "firewallSubnetCidrBlock",
              "Description": {
                "new": "The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation.",
                "old": "Azure firewall subnet. IPv4 CIDR block."
              }
            },
            {
              "#name": "gatewaySubnetCidrBlock",
              "Description": {
                "new": "The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation.",
                "old": "Gateway subnet. IPv4 CIDR block."
              }
            },
            {
              "#name": "logRetentionInDays",
              "Description": {
                "new": "Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days.",
                "old": "Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730"
              }
            },
            {
              "#name": "hubNetworkCidrBlock",
              "Description": {
                "new": "The Virtual Network address. Specify the address using IPv4 CIDR notation.",
                "old": "The address space for the VNET. IPv4 CIDR block."
              }
            },
            {
              "#name": "azureBastionCreationOption",
              "Description": {
                "new": "Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion.",
                "old": "To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service."
              }
            },
            {
              "#name": "existingAzureBastionId",
              "Description": {
                "new": "The resource ID of the Bastion when reusing an existing one.",
                "old": "The resource id of azure bastion."
              }
            },
            {
              "#name": "azureBastionSubnetCidrBlock",
              "Description": {
                "new": "The Bastion subnet address. Specify the address using IPv4 CIDR notation.",
                "old": "Azure bastion subnet. IP v4 CIDR block."
              }
            },
            {
              "#name": "landingZonesMgChildren",
              "Description": {
                "new": "The child management groups of 'Landing Zones' management group and their assigned policies.",
                "old": "Landing zone children management group properties"
              },
              "$items": {
                "Description": {
                  "new": "The 'Landing Zones' management group properties..",
                  "old": "Landing zone management group properties."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "topLevelMgMetadata",
              "Description": {
                "new": "The assigned policies of the parent management group.",
                "old": "This will be applied to the root of the landing zone deployment."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "landingZonesMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Landing Zones' management group.",
                "old": "This will be applied to the landing zone management groups."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "platformMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Platform' management group.",
                "old": "This will be applied to the platform management group."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "platformManagementMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Management' management group under 'Platform' management group.",
                "old": "This will be applied to the management management group under platform."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "platformConnectivityMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Connectivity' management group under 'Platform' management group.",
                "old": "This will be applied to the connectivity management group under platform."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "platformIdentityMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Identity' management group under 'Platform' management group.",
                "old": "This will be applied to the identity management group under platform."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "decommissionedMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Decommissioned' management group and indicator to create it or not.",
                "old": "This will be applied to the decommissioned management group."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                },
                {
                  "#name": "create",
                  "Description": {
                    "new": "This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                    "old": "When set to false, this management group will not be created. The default value is false."
                  }
                }
              ]
            },
            {
              "#name": "sandboxMgMetadata",
              "Description": {
                "new": "The assigned policies of the 'Sandbox' management group and indicator to create it or not.",
                "old": "This will be applied to the sandbox management group."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                },
                {
                  "#name": "create",
                  "Description": {
                    "new": "This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                    "old": "When set to false this management group will not be created. The default value is false."
                  }
                }
              ]
            },
            {
              "#name": "managedIdentity",
              "Description": {
                "new": "The managed identity to be assigned to this landing zone configuration.",
                "old": "The managed identity to be tied to this landing zone configuration"
              }
            },
            {
              "#name": "platformMgChildren",
              "Description": {
                "new": "The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management'",
                "old": "Platform children management group properties."
              },
              "$items": {
                "Description": {
                  "new": "The 'Platform' management group properties.",
                  "old": "Platform management group properties."
                },
                "$properties": [
                  {
                    "#name": "policyInitiativesAssignmentProperties",
                    "Description": {
                      "new": "Array of policy initiatives applied to the management group.",
                      "old": "Array of initiative assignments to be applied to the management group."
                    },
                    "$items": {
                      "Description": {
                        "new": "The properties of assigned policy initiatives.",
                        "old": "Details of policy assignments"
                      },
                      "$properties": [
                        {
                          "#name": "assignmentParameters",
                          "Description": {
                            "new": "The parameters of the assigned policy initiative.",
                            "old": "The parameters for the assignment of policy initiatives."
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "namingConventionFormula",
              "Description": {
                "new": "The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing",
                "old": "The naming convention that's used by default for all resource types for this landing zone configuration"
              }
            },
            {
              "#name": "customNamingConvention",
              "Description": {
                "new": "The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}]",
                "old": "The customized naming convention for one or more resource types in this landing zone configuration"
              },
              "$items": {
                "Description": {
                  "new": "The details for the custom naming convention override for a specific resource type.",
                  "old": "The details for the custom resource override."
                },
                "$properties": [
                  {
                    "#name": "resourceType",
                    "Enum": {
                      "new": [
                        [
                          "azureFirewalls",
                          "Value when customer wants to provide a custom naming convention for Azure Firewall."
                        ],
                        [
                          "workspaces",
                          "Value when customer wants to provide a custom naming convention for Log Analytics workspace."
                        ],
                        [
                          "automationAccounts",
                          "Value when customer wants to provide a custom naming convention for automation account."
                        ],
                        [
                          "dashboards",
                          "Value when customer wants to provide a custom naming convention for dashboard."
                        ],
                        [
                          "userAssignedIdentities",
                          "Value when customer wants to provide a custom naming convention for managed identity."
                        ],
                        [
                          "bastionHosts",
                          "Value when customer wants to provide a custom naming convention for Bastion."
                        ],
                        [
                          "ddosProtectionPlans",
                          "Value when customer wants to provide a custom naming convention for DDoS protection plan."
                        ],
                        [
                          "networkSecurityGroups",
                          "Value when customer wants to provide a custom naming convention for Bastion NSG."
                        ],
                        [
                          "virtualNetworks",
                          "Value when customer wants to provide a custom naming convention for virtual network."
                        ],
                        [
                          "routeTables",
                          "Value when customer wants to provide a custom naming convention for route table."
                        ]
                      ],
                      "old": [
                        [
                          "azureFirewalls",
                          "Value when customer wants to provide custom naming convention for Azure Firewall."
                        ],
                        [
                          "workspaces",
                          "Value when customer wants to provide custom naming convention for Log Analytics workspace."
                        ],
                        [
                          "automationAccounts",
                          "Value when customer wants to provide custom naming convention for automation account."
                        ],
                        [
                          "dashboards",
                          "Value when customer wants to provide custom naming convention for dashboard."
                        ],
                        [
                          "userAssignedIdentities",
                          "Value when customer wants to provide custom naming convention for managed identity."
                        ],
                        [
                          "bastionHosts",
                          "Value when customer wants to provide custom naming convention for Bastion."
                        ],
                        [
                          "ddosProtectionPlans",
                          "Value when customer wants to provide custom naming convention for DDoS protection plan."
                        ],
                        [
                          "networkSecurityGroups",
                          "Value when customer wants to provide custom naming convention for Bastion NSG."
                        ],
                        [
                          "virtualNetworks",
                          "Value when customer wants to provide custom naming convention for virtual network."
                        ],
                        [
                          "routeTables",
                          "Value when customer wants to provide custom naming convention for route table."
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "formula",
                    "Description": {
                      "new": "The custom naming formula for the resource type.",
                      "old": "The custom formula for the resource type."
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration.",
              "old": "The status of a user-initiated, control-plane operation on the landing zone configuration."
            }
          },
          {
            "#name": "authoringStatus",
            "Description": {
              "new": "The status that indicates the current phase of the configuration process for a deployment.",
              "old": "The status for the landing zone configurations workflow."
            },
            "Enum": {
              "new": [
                [
                  "Authoring",
                  "'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified."
                ],
                [
                  "ReadyForUse",
                  "'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment."
                ],
                [
                  "Disabled",
                  "'Disabled' status is set when the landing zone configuration is no longer in use."
                ]
              ],
              "old": [
                [
                  "Authoring",
                  "This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated."
                ],
                [
                  "ReadyForUse",
                  "This status is set when the configuration changes are complete and the configuration is ready for code generation"
                ],
                [
                  "Disabled",
                  "This status is set when the landing zone configuration is no longer in use."
                ]
              ]
            }
          },
          {
            "#name": "ddosProtectionCreationOption",
            "Description": {
              "new": "Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan.",
              "old": "To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan."
            }
          },
          {
            "#name": "existingDdosProtectionId",
            "Description": {
              "new": "The resource ID of the DDoS protection plan when reusing an existing one.",
              "old": "The resource id of the ddos protection plan."
            }
          },
          {
            "#name": "logAnalyticsWorkspaceCreationOption",
            "Description": {
              "new": "Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace.",
              "old": "To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace."
            }
          },
          {
            "#name": "existingLogAnalyticsWorkspaceId",
            "Description": {
              "new": "The resource ID of the log analytics workspace when reusing an existing one.",
              "old": "The resource id of the log analytics workspace that was created to centralize log ingestion."
            }
          },
          {
            "#name": "tags",
            "Description": {
              "new": "Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'}",
              "old": "Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}."
            },
            "$items": {
              "Description": {
                "new": "Key-value pairs that can be assigned to this resource.",
                "old": "The details associated with tags."
              }
            }
          },
          {
            "#name": "firewallCreationOption",
            "Description": {
              "new": "Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU.",
              "old": "To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one."
            },
            "Enum": {
              "new": [
                [
                  "None",
                  "Select 'None' value to skip Firewall deployment."
                ],
                [
                  "Standard",
                  "Select 'Standard' value to deploy the Firewall Standard SKU."
                ],
                [
                  "Premium",
                  "Select 'Premium' value to deploy the Firewall Premium SKU."
                ]
              ],
              "old": [
                [
                  "None",
                  "Value when a firewall resource is not created."
                ],
                [
                  "Standard",
                  "Value when the firewall creation is based on the standard SKU."
                ],
                [
                  "Premium",
                  "Value when the firewall creation is based on the premium SKU."
                ]
              ]
            }
          },
          {
            "#name": "firewallSubnetCidrBlock",
            "Description": {
              "new": "The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation.",
              "old": "Azure firewall subnet. IPv4 CIDR block."
            }
          },
          {
            "#name": "gatewaySubnetCidrBlock",
            "Description": {
              "new": "The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation.",
              "old": "Gateway subnet. IPv4 CIDR block."
            }
          },
          {
            "#name": "logRetentionInDays",
            "Description": {
              "new": "Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days.",
              "old": "Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730"
            }
          },
          {
            "#name": "hubNetworkCidrBlock",
            "Description": {
              "new": "The Virtual Network address. Specify the address using IPv4 CIDR notation.",
              "old": "The address space for the VNET. IPv4 CIDR block."
            }
          },
          {
            "#name": "azureBastionCreationOption",
            "Description": {
              "new": "Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion.",
              "old": "To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service."
            }
          },
          {
            "#name": "existingAzureBastionId",
            "Description": {
              "new": "The resource ID of the Bastion when reusing an existing one.",
              "old": "The resource id of azure bastion."
            }
          },
          {
            "#name": "azureBastionSubnetCidrBlock",
            "Description": {
              "new": "The Bastion subnet address. Specify the address using IPv4 CIDR notation.",
              "old": "Azure bastion subnet. IP v4 CIDR block."
            }
          },
          {
            "#name": "landingZonesMgChildren",
            "Description": {
              "new": "The child management groups of 'Landing Zones' management group and their assigned policies.",
              "old": "Landing zone children management group properties"
            },
            "$items": {
              "Description": {
                "new": "The 'Landing Zones' management group properties..",
                "old": "Landing zone management group properties."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            }
          },
          {
            "#name": "topLevelMgMetadata",
            "Description": {
              "new": "The assigned policies of the parent management group.",
              "old": "This will be applied to the root of the landing zone deployment."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "landingZonesMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Landing Zones' management group.",
              "old": "This will be applied to the landing zone management groups."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Platform' management group.",
              "old": "This will be applied to the platform management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformManagementMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Management' management group under 'Platform' management group.",
              "old": "This will be applied to the management management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformConnectivityMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Connectivity' management group under 'Platform' management group.",
              "old": "This will be applied to the connectivity management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "platformIdentityMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Identity' management group under 'Platform' management group.",
              "old": "This will be applied to the identity management group under platform."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              }
            ]
          },
          {
            "#name": "decommissionedMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Decommissioned' management group and indicator to create it or not.",
              "old": "This will be applied to the decommissioned management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              },
              {
                "#name": "create",
                "Description": {
                  "new": "This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                  "old": "When set to false, this management group will not be created. The default value is false."
                }
              }
            ]
          },
          {
            "#name": "sandboxMgMetadata",
            "Description": {
              "new": "The assigned policies of the 'Sandbox' management group and indicator to create it or not.",
              "old": "This will be applied to the sandbox management group."
            },
            "$properties": [
              {
                "#name": "policyInitiativesAssignmentProperties",
                "Description": {
                  "new": "Array of policy initiatives applied to the management group.",
                  "old": "Array of initiative assignments to be applied to the management group."
                },
                "$items": {
                  "Description": {
                    "new": "The properties of assigned policy initiatives.",
                    "old": "Details of policy assignments"
                  },
                  "$properties": [
                    {
                      "#name": "assignmentParameters",
                      "Description": {
                        "new": "The parameters of the assigned policy initiative.",
                        "old": "The parameters for the assignment of policy initiatives."
                      }
                    }
                  ]
                }
              },
              {
                "#name": "create",
                "Description": {
                  "new": "This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false.",
                  "old": "When set to false this management group will not be created. The default value is false."
                }
              }
            ]
          },
          {
            "#name": "managedIdentity",
            "Description": {
              "new": "The managed identity to be assigned to this landing zone configuration.",
              "old": "The managed identity to be tied to this landing zone configuration"
            }
          },
          {
            "#name": "platformMgChildren",
            "Description": {
              "new": "The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management'",
              "old": "Platform children management group properties."
            },
            "$items": {
              "Description": {
                "new": "The 'Platform' management group properties.",
                "old": "Platform management group properties."
              },
              "$properties": [
                {
                  "#name": "policyInitiativesAssignmentProperties",
                  "Description": {
                    "new": "Array of policy initiatives applied to the management group.",
                    "old": "Array of initiative assignments to be applied to the management group."
                  },
                  "$items": {
                    "Description": {
                      "new": "The properties of assigned policy initiatives.",
                      "old": "Details of policy assignments"
                    },
                    "$properties": [
                      {
                        "#name": "assignmentParameters",
                        "Description": {
                          "new": "The parameters of the assigned policy initiative.",
                          "old": "The parameters for the assignment of policy initiatives."
                        }
                      }
                    ]
                  }
                }
              ]
            }
          },
          {
            "#name": "namingConventionFormula",
            "Description": {
              "new": "The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing",
              "old": "The naming convention that's used by default for all resource types for this landing zone configuration"
            }
          },
          {
            "#name": "customNamingConvention",
            "Description": {
              "new": "The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}]",
              "old": "The customized naming convention for one or more resource types in this landing zone configuration"
            },
            "$items": {
              "Description": {
                "new": "The details for the custom naming convention override for a specific resource type.",
                "old": "The details for the custom resource override."
              },
              "$properties": [
                {
                  "#name": "resourceType",
                  "Enum": {
                    "new": [
                      [
                        "azureFirewalls",
                        "Value when customer wants to provide a custom naming convention for Azure Firewall."
                      ],
                      [
                        "workspaces",
                        "Value when customer wants to provide a custom naming convention for Log Analytics workspace."
                      ],
                      [
                        "automationAccounts",
                        "Value when customer wants to provide a custom naming convention for automation account."
                      ],
                      [
                        "dashboards",
                        "Value when customer wants to provide a custom naming convention for dashboard."
                      ],
                      [
                        "userAssignedIdentities",
                        "Value when customer wants to provide a custom naming convention for managed identity."
                      ],
                      [
                        "bastionHosts",
                        "Value when customer wants to provide a custom naming convention for Bastion."
                      ],
                      [
                        "ddosProtectionPlans",
                        "Value when customer wants to provide a custom naming convention for DDoS protection plan."
                      ],
                      [
                        "networkSecurityGroups",
                        "Value when customer wants to provide a custom naming convention for Bastion NSG."
                      ],
                      [
                        "virtualNetworks",
                        "Value when customer wants to provide a custom naming convention for virtual network."
                      ],
                      [
                        "routeTables",
                        "Value when customer wants to provide a custom naming convention for route table."
                      ]
                    ],
                    "old": [
                      [
                        "azureFirewalls",
                        "Value when customer wants to provide custom naming convention for Azure Firewall."
                      ],
                      [
                        "workspaces",
                        "Value when customer wants to provide custom naming convention for Log Analytics workspace."
                      ],
                      [
                        "automationAccounts",
                        "Value when customer wants to provide custom naming convention for automation account."
                      ],
                      [
                        "dashboards",
                        "Value when customer wants to provide custom naming convention for dashboard."
                      ],
                      [
                        "userAssignedIdentities",
                        "Value when customer wants to provide custom naming convention for managed identity."
                      ],
                      [
                        "bastionHosts",
                        "Value when customer wants to provide custom naming convention for Bastion."
                      ],
                      [
                        "ddosProtectionPlans",
                        "Value when customer wants to provide custom naming convention for DDoS protection plan."
                      ],
                      [
                        "networkSecurityGroups",
                        "Value when customer wants to provide custom naming convention for Bastion NSG."
                      ],
                      [
                        "virtualNetworks",
                        "Value when customer wants to provide custom naming convention for virtual network."
                      ],
                      [
                        "routeTables",
                        "Value when customer wants to provide custom naming convention for route table."
                      ]
                    ]
                  }
                },
                {
                  "#name": "formula",
                  "Description": {
                    "new": "The custom naming formula for the resource type.",
                    "old": "The custom formula for the resource type."
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneConfigurationName:
{
Description: The landing zone configuration name ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ddosProtectionCreationOption:
{
Description: Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: False ,
}
enum ,
existingDdosProtectionId:
{
Description: The resource ID of the DDoS protection plan when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsWorkspaceCreationOption:
{
Description: Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: False ,
}
enum ,
existingLogAnalyticsWorkspaceId:
{
Description: The resource ID of the log analytics workspace when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
tags:
{
Description: Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'} ,
Required: False ,
}
[
{
name:
{
Description: A tag name. ,
Required: True ,
}
string ,
value:
{
Description: A tag value. ,
Required: False ,
}
string ,
}
,
]
,
firewallCreationOption:
{
Description: Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU. ,
Enum:
{
None: Select 'None' value to skip Firewall deployment. ,
Standard: Select 'Standard' value to deploy the Firewall Standard SKU. ,
Premium: Select 'Premium' value to deploy the Firewall Premium SKU. ,
}
,
Required: False ,
}
enum ,
firewallSubnetCidrBlock:
{
Description: The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation. ,
Required: False ,
}
string ,
gatewaySubnetCidrBlock:
{
Description: The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation. ,
Required: False ,
}
string ,
logRetentionInDays:
{
Description: Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days. ,
Format: int64 ,
Required: False ,
}
integer ,
hubNetworkCidrBlock:
{
Description: The Virtual Network address. Specify the address using IPv4 CIDR notation. ,
Required: False ,
}
string ,
azureBastionCreationOption:
{
Description: Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: False ,
}
enum ,
existingAzureBastionId:
{
Description: The resource ID of the Bastion when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
azureBastionSubnetCidrBlock:
{
Description: The Bastion subnet address. Specify the address using IPv4 CIDR notation. ,
Required: False ,
}
string ,
landingZonesMgChildren:
{
Description: The child management groups of 'Landing Zones' management group and their assigned policies. ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
topLevelMgMetadata:
{
Description: The assigned policies of the parent management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: False ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
Description: The assigned policies of the 'Landing Zones' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: False ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformMgMetadata:
{
Description: The assigned policies of the 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: False ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
Description: The assigned policies of the 'Management' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: False ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
Description: The assigned policies of the 'Connectivity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: False ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
Description: The assigned policies of the 'Identity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: False ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
Description: The assigned policies of the 'Decommissioned' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: False ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: False ,
}
boolean ,
}
,
sandboxMgMetadata:
{
Description: The assigned policies of the 'Sandbox' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: False ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: False ,
}
boolean ,
}
,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone configuration. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
platformMgChildren:
{
Description: The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management' ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
namingConventionFormula:
{
Description: The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing ,
Required: False ,
}
string ,
customNamingConvention:
{
Description: The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}] ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Enum:
{
azureFirewalls: Value when customer wants to provide a custom naming convention for Azure Firewall. ,
workspaces: Value when customer wants to provide a custom naming convention for Log Analytics workspace. ,
automationAccounts: Value when customer wants to provide a custom naming convention for automation account. ,
dashboards: Value when customer wants to provide a custom naming convention for dashboard. ,
userAssignedIdentities: Value when customer wants to provide a custom naming convention for managed identity. ,
bastionHosts: Value when customer wants to provide a custom naming convention for Bastion. ,
ddosProtectionPlans: Value when customer wants to provide a custom naming convention for DDoS protection plan. ,
networkSecurityGroups: Value when customer wants to provide a custom naming convention for Bastion NSG. ,
virtualNetworks: Value when customer wants to provide a custom naming convention for virtual network. ,
routeTables: Value when customer wants to provide a custom naming convention for route table. ,
}
,
Required: True ,
}
enum ,
formula:
{
Description: The custom naming formula for the resource type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
authoringStatus:
{
Description: The status that indicates the current phase of the configuration process for a deployment. ,
Enum:
{
Authoring: 'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified. ,
ReadyForUse: 'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment. ,
Disabled: 'Disabled' status is set when the landing zone configuration is no longer in use. ,
}
,
Required: False ,
}
enum ,
ddosProtectionCreationOption:
{
Description: Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingDdosProtectionId:
{
Description: The resource ID of the DDoS protection plan when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsWorkspaceCreationOption:
{
Description: Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingLogAnalyticsWorkspaceId:
{
Description: The resource ID of the log analytics workspace when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
tags:
{
Description: Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'} ,
Required: False ,
}
[
{
name:
{
Description: A tag name. ,
Required: True ,
}
string ,
value:
{
Description: A tag value. ,
Required: False ,
}
string ,
}
,
]
,
firewallCreationOption:
{
Description: Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU. ,
Enum:
{
None: Select 'None' value to skip Firewall deployment. ,
Standard: Select 'Standard' value to deploy the Firewall Standard SKU. ,
Premium: Select 'Premium' value to deploy the Firewall Premium SKU. ,
}
,
Required: True ,
}
enum ,
firewallSubnetCidrBlock:
{
Description: The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation. ,
Required: False ,
}
string ,
gatewaySubnetCidrBlock:
{
Description: The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation. ,
Required: True ,
}
string ,
logRetentionInDays:
{
Description: Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days. ,
Format: int64 ,
Required: True ,
}
integer ,
hubNetworkCidrBlock:
{
Description: The Virtual Network address. Specify the address using IPv4 CIDR notation. ,
Required: True ,
}
string ,
azureBastionCreationOption:
{
Description: Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion. ,
Enum:
{
Yes: Value to create a new resource. ,
No: Value to not create a new resource. ,
UseExisting: Value to use an existing resource. ,
}
,
Required: True ,
}
enum ,
existingAzureBastionId:
{
Description: The resource ID of the Bastion when reusing an existing one. ,
Format: arm-id ,
Required: False ,
}
string ,
azureBastionSubnetCidrBlock:
{
Description: The Bastion subnet address. Specify the address using IPv4 CIDR notation. ,
Required: False ,
}
string ,
landingZonesMgChildren:
{
Description: The child management groups of 'Landing Zones' management group and their assigned policies. ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
topLevelMgMetadata:
{
Description: The assigned policies of the parent management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
Description: The assigned policies of the 'Landing Zones' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformMgMetadata:
{
Description: The assigned policies of the 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
Description: The assigned policies of the 'Management' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
Description: The assigned policies of the 'Connectivity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
Description: The assigned policies of the 'Identity' management group under 'Platform' management group. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
Description: The assigned policies of the 'Decommissioned' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
sandboxMgMetadata:
{
Description: The assigned policies of the 'Sandbox' management group and indicator to create it or not. ,
Required: False ,
}
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
create:
{
Description: This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. ,
Required: True ,
}
boolean ,
}
,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone configuration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
platformMgChildren:
{
Description: The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management' ,
Required: False ,
}
[
{
policyInitiativesAssignmentProperties:
{
Description: Array of policy initiatives applied to the management group. ,
Required: True ,
}
[
{
policyInitiativeId:
{
Description: The fully qualified id of the policy initiative. ,
Required: True ,
}
string ,
assignmentParameters:
{
Description: The parameters of the assigned policy initiative. ,
Required: True ,
}
object ,
}
,
]
,
name:
{
Description: Management group name. ,
Required: True ,
}
string ,
}
,
]
,
namingConventionFormula:
{
Description: The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing ,
Required: False ,
}
string ,
customNamingConvention:
{
Description: The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}] ,
Required: False ,
}
[
{
resourceType:
{
Description: The type of the resource. ,
Enum:
{
azureFirewalls: Value when customer wants to provide a custom naming convention for Azure Firewall. ,
workspaces: Value when customer wants to provide a custom naming convention for Log Analytics workspace. ,
automationAccounts: Value when customer wants to provide a custom naming convention for automation account. ,
dashboards: Value when customer wants to provide a custom naming convention for dashboard. ,
userAssignedIdentities: Value when customer wants to provide a custom naming convention for managed identity. ,
bastionHosts: Value when customer wants to provide a custom naming convention for Bastion. ,
ddosProtectionPlans: Value when customer wants to provide a custom naming convention for DDoS protection plan. ,
networkSecurityGroups: Value when customer wants to provide a custom naming convention for Bastion NSG. ,
virtualNetworks: Value when customer wants to provide a custom naming convention for virtual network. ,
routeTables: Value when customer wants to provide a custom naming convention for route table. ,
}
,
Required: True ,
}
enum ,
formula:
{
Description: The custom naming formula for the resource type. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_Delete (updated)
Description :  Delete a landing zone configuration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneConfigurationOperations_Delete",
  "Description": {
    "new": "Delete a landing zone configuration.",
    "old": "Deletes the landing zone configuration."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneConfigurationName:
{
Description: The landing zone configuration name ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_CreateCopy (updated)
Description :  Create a duplicate of the landing zone configuration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneConfigurationOperations_CreateCopy",
  "Description": {
    "new": "Create a duplicate of the landing zone configuration.",
    "old": "Provides a mechanism to create a copy of the landing zone configuration."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "body": {
        "Description": {
          "new": "The request for create duplicate landing zone configuration.",
          "old": "The request for the create copy action of landing zone configuration."
        },
        "$properties": [
          {
            "#name": "name",
            "Description": {
              "new": "The name of the duplicate landing zone configuration resource.",
              "old": "The name of the new landing zone configuration resource."
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of the create duplicate landing zone configuration.",
        "old": "The response of the create copy action of landing zone configuration."
      },
      "$properties": [
        {
          "#name": "copiedLandingZoneConfigurationId",
          "Description": {
            "new": "The ID of the duplicate landing zone configuration resource.",
            "old": "The id of the copied landing zone configuration resource."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}/createCopy
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneConfigurationName:
{
Description: The landing zone configuration name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
name:
{
Description: The name of the duplicate landing zone configuration resource. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
copiedLandingZoneConfigurationId:
{
Description: The ID of the duplicate landing zone configuration resource. ,
Format: arm-id ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_GenerateLandingZone (updated)
Description :  Generate infrastructure as code (IaC) for a landing zone deployment.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneConfigurationOperations_GenerateLandingZone",
  "Description": {
    "new": "Generate infrastructure as code (IaC) for a landing zone deployment.",
    "old": "Generate the landing zone."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "body": {
        "Description": {
          "new": "The request to generate Infrastructure as Code (IaC) for a landing zone.",
          "old": "The request to generate code for a landing zone."
        },
        "$properties": [
          {
            "#name": "infrastructureAsCodeOutputOptions",
            "Enum": {
              "new": [
                [
                  "Bicep",
                  "Value when generating Landing zone code in Bicep format."
                ],
                [
                  "ARM",
                  "Value when generating Landing zone code in ARM format."
                ]
              ],
              "old": [
                [
                  "Bicep",
                  "Value when generating Landing Zone code in Bicep."
                ],
                [
                  "ARM",
                  "Value when generating landing zone code in Arm."
                ]
              ]
            }
          },
          {
            "#name": "existingManagementSubscriptionId",
            "Description": {
              "new": "Existing 'Management' subscription ID to be linked with this deployment when reusing instead of creating a new subscription.",
              "old": "Management subscription fully qualified Id."
            }
          },
          {
            "#name": "existingIdentitySubscriptionId",
            "Description": {
              "new": "Existing 'Identity' subscription ID to be linked with this deployment when reusing instead of creating a new subscription.",
              "old": "Identity subscription fully qualified Id."
            }
          },
          {
            "#name": "existingConnectivitySubscriptionId",
            "Description": {
              "new": "Existing 'Connectivity' subscription ID to be linked with this deployment when reusing instead of creating a new subscription.",
              "old": "Connectivity subscription fully qualified Id."
            }
          },
          {
            "#name": "subscriptionBillingScope",
            "Description": {
              "new": "The complete resource ID of the billing scope linked to the EA, MCA, or MPA account where you want to create the subscription.",
              "old": "The full resource ID of billing scope associated to the EA, MCA or MPA account you wish to create the subscription in."
            }
          },
          {
            "#name": "existingTopLevelMgParentId",
            "Description": {
              "new": "Optional parent for the management group hierarchy, serving as an intermediate root management group parent if specified. If left empty, the default will be to deploy under the tenant root management group.",
              "old": "Optional parent for management group hierarchy, used as intermediate root management group parent, if specified. If empty, default will deploy beneath tenant toot management group."
            }
          },
          {
            "#name": "deploymentPrefix",
            "Description": {
              "new": "The prefix that will be added to all resources created by this deployment. Use between 2 and 5 characters, consisting only of letters, digits, '-', '.', or '_'. No other special characters are supported.",
              "old": "The prefix that will be added to all resources created by this deployment."
            }
          },
          {
            "#name": "deploymentSuffix",
            "Description": {
              "new": "The optional suffix that will be appended to all resources created by this deployment, maximum 5 characters.",
              "old": "The suffix that will be added to all resources created by this deployment."
            }
          },
          {
            "#name": "topLevelMgDisplayName",
            "Description": {
              "new": "The display name assigned to the top management group of the landing zone deployment hierarchy. It is recommended to use unique names for each landing zone deployment.",
              "old": "The top level management group display name."
            }
          },
          {
            "#name": "deploymentLocation",
            "Description": {
              "new": "The Azure region where the landing zone will be deployed. All Azure regions are supported.",
              "old": "Location to run deployment(s) from the list of azure regions."
            }
          },
          {
            "#name": "organization",
            "Description": {
              "new": "The name of the organization or agency for which the landing zone is being deployed. This is optional.",
              "old": "The name of the organization or agency the landing zone is being deployed for."
            }
          },
          {
            "#name": "environment",
            "Description": {
              "new": "The environment where the landing zone is being deployed, such as ppe, prod, test, etc.",
              "old": "The environment for which the landing zone is being deployed"
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response payload for generating infrastructure-as-code for the landing zone.",
        "old": "The response for the request to generate landing zone code."
      },
      "$properties": [
        {
          "#name": "topLevelMgDisplayName",
          "Description": {
            "new": "The parent management group name of the landing zone deployment.",
            "old": "The top level Management Group display name."
          }
        },
        {
          "#name": "landingZoneConfigurationName",
          "Description": {
            "new": "The name of the Landing zone configuration resource.",
            "old": "The name of the Landing Zone configuration resource."
          }
        },
        {
          "#name": "generatedCodeUrl",
          "Description": {
            "new": "The url to access the generated code.",
            "old": "The url to access the generated code.."
          }
        },
        {
          "#name": "generatedArmTemplate",
          "Description": {
            "new": "The generated code content in JSON string format.",
            "old": "The generated code content as a json string."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}/generateLandingZone
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneConfigurationName:
{
Description: The landing zone configuration name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
infrastructureAsCodeOutputOptions:
{
Description: The export options available for code generation. ,
Enum:
{
Bicep: Value when generating Landing zone code in Bicep format. ,
ARM: Value when generating Landing zone code in ARM format. ,
}
,
Required: True ,
}
enum ,
existingManagementSubscriptionId:
{
Description: Existing 'Management' subscription ID to be linked with this deployment when reusing instead of creating a new subscription. ,
Format: arm-id ,
Required: False ,
}
string ,
existingIdentitySubscriptionId:
{
Description: Existing 'Identity' subscription ID to be linked with this deployment when reusing instead of creating a new subscription. ,
Format: arm-id ,
Required: False ,
}
string ,
existingConnectivitySubscriptionId:
{
Description: Existing 'Connectivity' subscription ID to be linked with this deployment when reusing instead of creating a new subscription. ,
Format: arm-id ,
Required: False ,
}
string ,
subscriptionBillingScope:
{
Description: The complete resource ID of the billing scope linked to the EA, MCA, or MPA account where you want to create the subscription. ,
Required: False ,
}
string ,
existingTopLevelMgParentId:
{
Description: Optional parent for the management group hierarchy, serving as an intermediate root management group parent if specified. If left empty, the default will be to deploy under the tenant root management group. ,
Format: arm-id ,
Required: False ,
}
string ,
deploymentPrefix:
{
Description: The prefix that will be added to all resources created by this deployment. Use between 2 and 5 characters, consisting only of letters, digits, '-', '.', or '_'. No other special characters are supported. ,
Required: True ,
}
string ,
deploymentSuffix:
{
Description: The optional suffix that will be appended to all resources created by this deployment, maximum 5 characters. ,
Required: False ,
}
string ,
topLevelMgDisplayName:
{
Description: The display name assigned to the top management group of the landing zone deployment hierarchy. It is recommended to use unique names for each landing zone deployment. ,
Required: True ,
}
string ,
deploymentLocation:
{
Description: The Azure region where the landing zone will be deployed. All Azure regions are supported. ,
Required: True ,
}
string ,
organization:
{
Description: The name of the organization or agency for which the landing zone is being deployed. This is optional. ,
Required: False ,
}
string ,
environment:
{
Description: The environment where the landing zone is being deployed, such as ppe, prod, test, etc. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
topLevelMgDisplayName:
{
Description: The parent management group name of the landing zone deployment. ,
Required: True ,
}
string ,
landingZoneConfigurationName:
{
Description: The name of the Landing zone configuration resource. ,
Required: True ,
}
string ,
generatedCodeUrl:
{
Description: The url to access the generated code. ,
Format: password ,
Required: True ,
}
string ,
storageAccountName:
{
Description: The storage account name to access the generated code. ,
Format: password ,
Required: True ,
}
string ,
containerName:
{
Description: The storage account container to access the generated code. ,
Format: password ,
Required: True ,
}
string ,
blobName:
{
Description: The storage account blob name to access the generated code. ,
Format: password ,
Required: True ,
}
string ,
generatedArmTemplate:
{
Description: The generated code content in JSON string format. ,
Format: password ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_UpdateAuthoringStatus (updated)
Description :  Update the authoring status on a landing zone configuration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneConfigurationOperations_UpdateAuthoringStatus",
  "Description": {
    "new": "Update the authoring status on a landing zone configuration.",
    "old": "Provides a mechanism to update the authoring status."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "body": {
        "Description": {
          "new": "The request to update the authoring status of a configuration.",
          "old": "The request to update authoring status of a configuration."
        },
        "$properties": [
          {
            "#name": "authoringStatus",
            "Description": {
              "new": "The authoring status value to be updated. Possible values include: 'Authoring', 'ReadyForUse' and 'Disabled'.",
              "old": "The value of the authoring status to be updated."
            },
            "Enum": {
              "new": [
                [
                  "Authoring",
                  "'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified."
                ],
                [
                  "ReadyForUse",
                  "'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment."
                ],
                [
                  "Disabled",
                  "'Disabled' status is set when the landing zone configuration is no longer in use."
                ]
              ],
              "old": [
                [
                  "Authoring",
                  "This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated."
                ],
                [
                  "ReadyForUse",
                  "This status is set when the configuration changes are complete and the configuration is ready for code generation"
                ],
                [
                  "Disabled",
                  "This status is set when the landing zone configuration is no longer in use."
                ]
              ]
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The response for authoring status update request.",
        "old": "The response for the request to update authoring status."
      },
      "$properties": [
        {
          "#name": "authoringStatus",
          "Description": {
            "new": "The authoring status value to be updated.",
            "old": "The value of the authoring status to be updated."
          },
          "Enum": {
            "new": [
              [
                "Authoring",
                "'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified."
              ],
              [
                "ReadyForUse",
                "'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment."
              ],
              [
                "Disabled",
                "'Disabled' status is set when the landing zone configuration is no longer in use."
              ]
            ],
            "old": [
              [
                "Authoring",
                "This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated."
              ],
              [
                "ReadyForUse",
                "This status is set when the configuration changes are complete and the configuration is ready for code generation"
              ],
              [
                "Disabled",
                "This status is set when the landing zone configuration is no longer in use."
              ]
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}/updateAuthoringStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneConfigurationName:
{
Description: The landing zone configuration name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
authoringStatus:
{
Description: The authoring status value to be updated. Possible values include: 'Authoring', 'ReadyForUse' and 'Disabled'. ,
Enum:
{
Authoring: 'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified. ,
ReadyForUse: 'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment. ,
Disabled: 'Disabled' status is set when the landing zone configuration is no longer in use. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
landingZoneConfigurationName:
{
Description: The name of the landing zone configuration resource. ,
Required: True ,
}
string ,
authoringStatus:
{
Description: The authoring status value to be updated. ,
Enum:
{
Authoring: 'Authoring' is the default status when a create configuration request is made. In this state, the Landing zone configuration can be modified. ,
ReadyForUse: 'ReadyForUse' status is set when the configuration updates are finished, and the configuration is ready for code generation or deployment. ,
Disabled: 'Disabled' status is set when the landing zone configuration is no longer in use. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_ListByResourceGroup (updated)
Description :  List the landing zone registrations within a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneRegistrationOperations_ListByResourceGroup",
  "Description": {
    "new": "List the landing zone registrations within a resource group.",
    "old": "Lists the landing zone registrations within a resource group."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "The Landing zone registration resource type.",
            "old": "The Landing Zone registration resource type"
          },
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Description": {
                  "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type.",
                  "old": "The status of a user-initiated, control-plane operation on the landing Zone registration resource type."
                }
              },
              {
                "#name": "managedIdentity",
                "Description": {
                  "new": "The managed identity to be assigned to this landing zone registration.",
                  "old": "The managed identity to be tied to this landing zone registration"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The LandingZoneRegistrationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
existingTopLevelMgId:
{
Description: The resource id of the top level management group ,
Format: arm-id ,
Required: True ,
}
string ,
existingLandingZoneConfigurationId:
{
Description: The resource id of the associated landing zone configuration. ,
Format: arm-id ,
Required: True ,
}
string ,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone registration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_Get (updated)
Description :  Get a landing zone registration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneRegistrationOperations_Get",
  "Description": {
    "new": "Get a landing zone registration.",
    "old": "Gets the landing zone registration."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "#name": "landingZoneRegistrationName",
      "Description": {
        "new": "The name of the landing zone registration resource.",
        "old": "The name of the Landing Zone Registration resource."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The Landing zone registration resource type.",
        "old": "The Landing Zone registration resource type"
      },
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type.",
              "old": "The status of a user-initiated, control-plane operation on the landing Zone registration resource type."
            }
          },
          {
            "#name": "managedIdentity",
            "Description": {
              "new": "The managed identity to be assigned to this landing zone registration.",
              "old": "The managed identity to be tied to this landing zone registration"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations/{landingZoneRegistrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneRegistrationName:
{
Description: The name of the landing zone registration resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
existingTopLevelMgId:
{
Description: The resource id of the top level management group ,
Format: arm-id ,
Required: True ,
}
string ,
existingLandingZoneConfigurationId:
{
Description: The resource id of the associated landing zone configuration. ,
Format: arm-id ,
Required: True ,
}
string ,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone registration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_Create (updated)
Description :  Create a landing zone registration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneRegistrationOperations_Create",
  "Description": {
    "new": "Create a landing zone registration.",
    "old": "Creates the landing zone registration."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "#name": "landingZoneRegistrationName",
      "Description": {
        "new": "The name of the landing zone registration resource.",
        "old": "The name of the Landing Zone Registration resource."
      }
    },
    {
      "resource": {
        "Description": {
          "new": "The Landing zone registration resource type.",
          "old": "The Landing Zone registration resource type"
        },
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Description": {
                "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type.",
                "old": "The status of a user-initiated, control-plane operation on the landing Zone registration resource type."
              }
            },
            {
              "#name": "managedIdentity",
              "Description": {
                "new": "The managed identity to be assigned to this landing zone registration.",
                "old": "The managed identity to be tied to this landing zone registration"
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The Landing zone registration resource type.",
        "old": "The Landing Zone registration resource type"
      },
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type.",
              "old": "The status of a user-initiated, control-plane operation on the landing Zone registration resource type."
            }
          },
          {
            "#name": "managedIdentity",
            "Description": {
              "new": "The managed identity to be assigned to this landing zone registration.",
              "old": "The managed identity to be tied to this landing zone registration"
            }
          }
        ]
      }
    },
    "201": {
      "Description": {
        "new": "The Landing zone registration resource type.",
        "old": "The Landing Zone registration resource type"
      },
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type.",
              "old": "The status of a user-initiated, control-plane operation on the landing Zone registration resource type."
            }
          },
          {
            "#name": "managedIdentity",
            "Description": {
              "new": "The managed identity to be assigned to this landing zone registration.",
              "old": "The managed identity to be tied to this landing zone registration"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations/{landingZoneRegistrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneRegistrationName:
{
Description: The name of the landing zone registration resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
existingTopLevelMgId:
{
Description: The resource id of the top level management group ,
Format: arm-id ,
Required: True ,
}
string ,
existingLandingZoneConfigurationId:
{
Description: The resource id of the associated landing zone configuration. ,
Format: arm-id ,
Required: True ,
}
string ,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone registration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
existingTopLevelMgId:
{
Description: The resource id of the top level management group ,
Format: arm-id ,
Required: True ,
}
string ,
existingLandingZoneConfigurationId:
{
Description: The resource id of the associated landing zone configuration. ,
Format: arm-id ,
Required: True ,
}
string ,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone registration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Landing zone registration resource type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
existingTopLevelMgId:
{
Description: The resource id of the top level management group ,
Format: arm-id ,
Required: True ,
}
string ,
existingLandingZoneConfigurationId:
{
Description: The resource id of the associated landing zone configuration. ,
Format: arm-id ,
Required: True ,
}
string ,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone registration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_Update (updated)
Description :  Update a landing zone registration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneRegistrationOperations_Update",
  "Description": {
    "new": "Update a landing zone registration.",
    "old": "Updates the landing zone registration."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "#name": "landingZoneRegistrationName",
      "Description": {
        "new": "The name of the landing zone registration resource.",
        "old": "The name of the Landing Zone Registration resource."
      }
    },
    {
      "properties": {
        "Description": {
          "new": "The Landing zone registration resource type.",
          "old": "The Landing Zone registration resource type"
        },
        "$properties": {
          "properties": [
            {
              "#name": "managedIdentity",
              "Description": {
                "new": "The managed identity to be assigned to this landing zone registration.",
                "old": "The managed identity to be tied to this landing zone registration"
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "The Landing zone registration resource type.",
        "old": "The Landing Zone registration resource type"
      },
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Description": {
              "new": "The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type.",
              "old": "The status of a user-initiated, control-plane operation on the landing Zone registration resource type."
            }
          },
          {
            "#name": "managedIdentity",
            "Description": {
              "new": "The managed identity to be assigned to this landing zone registration.",
              "old": "The managed identity to be tied to this landing zone registration"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations/{landingZoneRegistrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneRegistrationName:
{
Description: The name of the landing zone registration resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
existingTopLevelMgId:
{
Description: The resource id of the top level management group ,
Format: arm-id ,
Required: False ,
}
string ,
existingLandingZoneConfigurationId:
{
Description: The resource id of the associated landing zone configuration. ,
Format: arm-id ,
Required: False ,
}
string ,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone registration. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: The state of the resource when creating ,
Updating: The state of the resource when updating ,
Deleting: The state of the resource when deleting ,
}
,
Required: False ,
}
enum ,
existingTopLevelMgId:
{
Description: The resource id of the top level management group ,
Format: arm-id ,
Required: True ,
}
string ,
existingLandingZoneConfigurationId:
{
Description: The resource id of the associated landing zone configuration. ,
Format: arm-id ,
Required: True ,
}
string ,
managedIdentity:
{
Description: The managed identity to be assigned to this landing zone registration. ,
Required: True ,
}
{
type:
{
Description: The type of managed identity. ,
Enum:
{
SystemAssigned: System assigned managed identity. ,
UserAssigned: User assigned managed identity. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: The resource id of the managed identity. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_Delete (updated)
Description :  Delete a landing zone registration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneRegistrationOperations_Delete",
  "Description": {
    "new": "Delete a landing zone registration.",
    "old": "Deletes the landing zone registration."
  },
  "$parameters": [
    {
      "#name": "landingZoneAccountName",
      "Description": {
        "new": "The landing zone account.",
        "old": "The parent landing zone account"
      }
    },
    {
      "#name": "landingZoneRegistrationName",
      "Description": {
        "new": "The name of the landing zone registration resource.",
        "old": "The name of the Landing Zone Registration resource."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations/{landingZoneRegistrationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
landingZoneAccountName:
{
Description: The landing zone account. ,
Required: True ,
}
string ,
landingZoneRegistrationName:
{
Description: The name of the landing zone registration resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}