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

2025/01/30 • 22 new methods

Operations_List (new)
Description List the operations for the provider
Reference Link ¶

⚼ Request

GET:  /providers/Microsoft.Sovereign/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
isDataAction: boolean ,
display:
{
provider: string ,
resource: string ,
operation: string ,
description: string ,
}
,
origin: enum ,
actionType: enum ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneAccountOperations_ListBySubscription (new)
Description Lists the landing zone accounts within a subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sovereign/landingZoneAccounts
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
storageAccount: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_ListBySubscription (new)
Description Lists the landing zone configurations within a subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations
{
api-version: string ,
subscriptionId: string ,
landingZoneAccountName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
authoringStatus: enum ,
ddosProtectionCreationOption: enum ,
existingDdosProtectionId: string ,
logAnalyticsWorkspaceCreationOption: enum ,
existingLogAnalyticsWorkspaceId: string ,
tags:
[
{
name: string ,
value: string ,
}
,
]
,
firewallCreationOption: enum ,
firewallSubnetCidrBlock: string ,
gatewaySubnetCidrBlock: string ,
logRetentionInDays: integer ,
hubNetworkCidrBlock: string ,
azureBastionCreationOption: enum ,
existingAzureBastionId: string ,
azureBastionSubnetCidrBlock: string ,
landingZonesMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
topLevelMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
sandboxMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
managedIdentity:
{
type: enum ,
userAssignedIdentityResourceId: string ,
}
,
platformMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
namingConventionFormula: string ,
customNamingConvention:
[
{
resourceType: enum ,
formula: string ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_ListBySubscription (new)
Description Lists the landing zone registrations within a subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations
{
api-version: string ,
subscriptionId: string ,
landingZoneAccountName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
existingTopLevelMgId: string ,
existingLandingZoneConfigurationId: string ,
managedIdentity:
{
type: enum ,
userAssignedIdentityResourceId: string ,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
storageAccount: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneAccountOperations_Get (new)
Description Gets the landing zone account.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
storageAccount: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneAccountOperations_Create (new)
Description Creates the landing zone account.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
resource:
{
properties:
{
provisioningState: enum ,
storageAccount: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
storageAccount: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
retry-after: integer ,
}
,
$schema:
{
properties:
{
provisioningState: enum ,
storageAccount: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneAccountOperations_Update (new)
Description Updates the landing zone account.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
properties:
{
properties:
{
storageAccount: string ,
}
,
identity:
{
type: enum ,
userAssignedIdentities: object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
storageAccount: string ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneAccountOperations_Delete (new)
Description Deletes the landing zone account.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
authoringStatus: enum ,
ddosProtectionCreationOption: enum ,
existingDdosProtectionId: string ,
logAnalyticsWorkspaceCreationOption: enum ,
existingLogAnalyticsWorkspaceId: string ,
tags:
[
{
name: string ,
value: string ,
}
,
]
,
firewallCreationOption: enum ,
firewallSubnetCidrBlock: string ,
gatewaySubnetCidrBlock: string ,
logRetentionInDays: integer ,
hubNetworkCidrBlock: string ,
azureBastionCreationOption: enum ,
existingAzureBastionId: string ,
azureBastionSubnetCidrBlock: string ,
landingZonesMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
topLevelMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
sandboxMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
managedIdentity:
{
type: enum ,
userAssignedIdentityResourceId: string ,
}
,
platformMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
namingConventionFormula: string ,
customNamingConvention:
[
{
resourceType: enum ,
formula: string ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_Get (new)
Description Gets the landing zone configuration.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
landingZoneConfigurationName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
authoringStatus: enum ,
ddosProtectionCreationOption: enum ,
existingDdosProtectionId: string ,
logAnalyticsWorkspaceCreationOption: enum ,
existingLogAnalyticsWorkspaceId: string ,
tags:
[
{
name: string ,
value: string ,
}
,
]
,
firewallCreationOption: enum ,
firewallSubnetCidrBlock: string ,
gatewaySubnetCidrBlock: string ,
logRetentionInDays: integer ,
hubNetworkCidrBlock: string ,
azureBastionCreationOption: enum ,
existingAzureBastionId: string ,
azureBastionSubnetCidrBlock: string ,
landingZonesMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
topLevelMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
sandboxMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
managedIdentity:
{
type: enum ,
userAssignedIdentityResourceId: string ,
}
,
platformMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
namingConventionFormula: string ,
customNamingConvention:
[
{
resourceType: enum ,
formula: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_Create (new)
Description Creates the landing zone configuration.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
landingZoneConfigurationName: string ,
resource:
{
properties:
{
provisioningState: enum ,
authoringStatus: enum ,
ddosProtectionCreationOption: enum ,
existingDdosProtectionId: string ,
logAnalyticsWorkspaceCreationOption: enum ,
existingLogAnalyticsWorkspaceId: string ,
tags:
[
{
name: string ,
value: string ,
}
,
]
,
firewallCreationOption: enum ,
firewallSubnetCidrBlock: string ,
gatewaySubnetCidrBlock: string ,
logRetentionInDays: integer ,
hubNetworkCidrBlock: string ,
azureBastionCreationOption: enum ,
existingAzureBastionId: string ,
azureBastionSubnetCidrBlock: string ,
landingZonesMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
topLevelMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
sandboxMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
managedIdentity:
{
type: enum ,
userAssignedIdentityResourceId: string ,
}
,
platformMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
namingConventionFormula: string ,
customNamingConvention:
[
{
resourceType: enum ,
formula: string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
authoringStatus: enum ,
ddosProtectionCreationOption: enum ,
existingDdosProtectionId: string ,
logAnalyticsWorkspaceCreationOption: enum ,
existingLogAnalyticsWorkspaceId: string ,
tags:
[
{
name: string ,
value: string ,
}
,
]
,
firewallCreationOption: enum ,
firewallSubnetCidrBlock: string ,
gatewaySubnetCidrBlock: string ,
logRetentionInDays: integer ,
hubNetworkCidrBlock: string ,
azureBastionCreationOption: enum ,
existingAzureBastionId: string ,
azureBastionSubnetCidrBlock: string ,
landingZonesMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
topLevelMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
sandboxMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
managedIdentity:
{
type: enum ,
userAssignedIdentityResourceId: string ,
}
,
platformMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
namingConventionFormula: string ,
customNamingConvention:
[
{
resourceType: enum ,
formula: string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
retry-after: integer ,
}
,
$schema:
{
properties:
{
provisioningState: enum ,
authoringStatus: enum ,
ddosProtectionCreationOption: enum ,
existingDdosProtectionId: string ,
logAnalyticsWorkspaceCreationOption: enum ,
existingLogAnalyticsWorkspaceId: string ,
tags:
[
{
name: string ,
value: string ,
}
,
]
,
firewallCreationOption: enum ,
firewallSubnetCidrBlock: string ,
gatewaySubnetCidrBlock: string ,
logRetentionInDays: integer ,
hubNetworkCidrBlock: string ,
azureBastionCreationOption: enum ,
existingAzureBastionId: string ,
azureBastionSubnetCidrBlock: string ,
landingZonesMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
topLevelMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
sandboxMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
managedIdentity:
{
type: enum ,
userAssignedIdentityResourceId: string ,
}
,
platformMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
namingConventionFormula: string ,
customNamingConvention:
[
{
resourceType: enum ,
formula: string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_Update (new)
Description Updates the landing zone configuration.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
landingZoneConfigurationName: string ,
properties:
{
properties:
{
ddosProtectionCreationOption: enum ,
existingDdosProtectionId: string ,
logAnalyticsWorkspaceCreationOption: enum ,
existingLogAnalyticsWorkspaceId: string ,
tags:
[
{
name: string ,
value: string ,
}
,
]
,
firewallCreationOption: enum ,
firewallSubnetCidrBlock: string ,
gatewaySubnetCidrBlock: string ,
logRetentionInDays: integer ,
hubNetworkCidrBlock: string ,
azureBastionCreationOption: enum ,
existingAzureBastionId: string ,
azureBastionSubnetCidrBlock: string ,
landingZonesMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
topLevelMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
sandboxMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
managedIdentity:
{
type: enum ,
userAssignedIdentityResourceId: string ,
}
,
platformMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
namingConventionFormula: string ,
customNamingConvention:
[
{
resourceType: enum ,
formula: string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
authoringStatus: enum ,
ddosProtectionCreationOption: enum ,
existingDdosProtectionId: string ,
logAnalyticsWorkspaceCreationOption: enum ,
existingLogAnalyticsWorkspaceId: string ,
tags:
[
{
name: string ,
value: string ,
}
,
]
,
firewallCreationOption: enum ,
firewallSubnetCidrBlock: string ,
gatewaySubnetCidrBlock: string ,
logRetentionInDays: integer ,
hubNetworkCidrBlock: string ,
azureBastionCreationOption: enum ,
existingAzureBastionId: string ,
azureBastionSubnetCidrBlock: string ,
landingZonesMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
topLevelMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
landingZonesMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformManagementMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformConnectivityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
platformIdentityMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
}
,
decommissionedMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
sandboxMgMetadata:
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
create: boolean ,
}
,
managedIdentity:
{
type: enum ,
userAssignedIdentityResourceId: string ,
}
,
platformMgChildren:
[
{
policyInitiativesAssignmentProperties:
[
{
policyInitiativeId: string ,
assignmentParameters: object ,
}
,
]
,
name: string ,
}
,
]
,
namingConventionFormula: string ,
customNamingConvention:
[
{
resourceType: enum ,
formula: string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_Delete (new)
Description Deletes the landing zone configuration.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
landingZoneConfigurationName: string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_CreateCopy (new)
Description Provides a mechanism to create a copy of the landing zone configuration.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}/createCopy
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
landingZoneConfigurationName: string ,
body:
{
name: string ,
}
,
}

⚐ Response (200)

{
copiedLandingZoneConfigurationId: string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_GenerateLandingZone (new)
Description Generate the landing zone.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}/generateLandingZone
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
landingZoneConfigurationName: string ,
body:
{
infrastructureAsCodeOutputOptions: enum ,
existingManagementSubscriptionId: string ,
existingIdentitySubscriptionId: string ,
existingConnectivitySubscriptionId: string ,
subscriptionBillingScope: string ,
existingTopLevelMgParentId: string ,
deploymentPrefix: string ,
deploymentSuffix: string ,
topLevelMgDisplayName: string ,
deploymentLocation: string ,
organization: string ,
environment: string ,
}
,
}

⚐ Response (200)

{
topLevelMgDisplayName: string ,
landingZoneConfigurationName: string ,
generatedCodeUrl: string ,
storageAccountName: string ,
containerName: string ,
blobName: string ,
generatedArmTemplate: string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneConfigurationOperations_UpdateAuthoringStatus (new)
Description Provides a mechanism to update the authoring status.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}/updateAuthoringStatus
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
landingZoneConfigurationName: string ,
body:
{
authoringStatus: enum ,
}
,
}

⚐ Response (200)

{
landingZoneConfigurationName: string ,
authoringStatus: enum ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
existingTopLevelMgId: string ,
existingLandingZoneConfigurationId: string ,
managedIdentity:
{
type: enum ,
userAssignedIdentityResourceId: string ,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_Get (new)
Description Gets the landing zone registration.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations/{landingZoneRegistrationName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
landingZoneAccountName: string ,
landingZoneRegistrationName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
existingTopLevelMgId: