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

2025/02/20 • 5 updated methods

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

⚶ Changes

{
  "#id": "LandingZoneRegistrationOperations_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "managedIdentity",
                "Required": {
                  "new": false,
                  "old": true
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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: 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 ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_ListByResourceGroup (updated)
Description :  List the landing zone registrations within a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneRegistrationOperations_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "managedIdentity",
                "Required": {
                  "new": false,
                  "old": true
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 ,
}
,
]
,
}
,
}
LandingZoneRegistrationOperations_Get (updated)
Description :  Get a landing zone registration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LandingZoneRegistrationOperations_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "managedIdentity",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

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

⚐ 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",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "#name": "managedIdentity",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "managedIdentity",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "managedIdentity",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

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

⚐ 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: 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 ,
}
,
}
,
}

⚐ 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: 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 ,
}
,
}
,
}
,
}

⚐ 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",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "managedIdentity",
            "Required": {
              "new": false,
              "old": true
            }
          }
        ]
      }
    }
  }
}

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

⚐ 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 ,
}
,
]
,
}
,
}