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

2025/03/17 • 2 new methods

LandingZoneConfigurationOperations_List (new)
Description :  List the landing zone configurations within a landing zone account.
Reference :  Link ¶

⚼ 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 ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_List (new)
Description :  List the landing zone registrations within a landing zone account.
Reference :  Link ¶

⚼ 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: False ,
}
{
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 ,
}
,
]
,
}
,
}