From 6cbd2dfeaee9a76e465af3ba2befc6026f0e7443 Mon Sep 17 00:00:00 2001 From: Siddhant Lahoti Date: Thu, 30 Jan 2025 13:01:57 -0800 Subject: [PATCH 1/3] Adds 2025-02-27-preview version for Microsoft.Sovereign (#32164) * Add the 2024-02-27-preview version for Microsoft.Sovereign * update the examples * updates for readonly property * updates to resource type enum * remove express route circuits from resource type * add spell check exception * add cspell yaml * removing extra comments --------- Co-authored-by: Sagar Nagarajan --- .../sovereign/Sovereign.Management/common.tsp | 32 + .../LandingZoneAccountOperations_Create.json | 83 + .../LandingZoneAccountOperations_Delete.json | 18 + .../LandingZoneAccountOperations_Get.json | 40 + ...AccountOperations_ListByResourceGroup.json | 44 + ...eAccountOperations_ListBySubscription.json | 43 + .../LandingZoneAccountOperations_Update.json | 56 + ...ingZoneConfigurationOperations_Create.json | 316 ++ ...oneConfigurationOperations_CreateCopy.json | 26 + ...ingZoneConfigurationOperations_Delete.json | 19 + ...urationOperations_GenerateLandingZone.json | 38 + ...andingZoneConfigurationOperations_Get.json | 118 + ...urationOperations_ListByResourceGroup.json | 122 + ...gurationOperations_ListBySubscription.json | 121 + ...ingZoneConfigurationOperations_Update.json | 213 ++ ...ationOperations_UpdateAuthoringStatus.json | 27 + ...dingZoneRegistrationOperations_Create.json | 71 + ...dingZoneRegistrationOperations_Delete.json | 15 + ...LandingZoneRegistrationOperations_Get.json | 36 + ...trationOperations_ListByResourceGroup.json | 40 + ...strationOperations_ListBySubscription.json | 39 + ...dingZoneRegistrationOperations_Update.json | 50 + .../2025-02-27-preview/Operations_List.json | 286 ++ .../landingZoneAccountResourceProperties.tsp | 20 + ...ingZoneConfigurationResourceProperties.tsp | 441 +++ ...dingZoneRegistrationResourceProperties.tsp | 31 + .../sovereign/Sovereign.Management/main.tsp | 163 + .../Sovereign.Management/tspconfig.yaml | 12 + specification/sovereign/cspell.yaml | 21 + .../resource-management/v3/types.json | 695 ++++ .../v4/managedidentity.json | 113 + .../v5/customermanagedkeys.json | 68 + .../v5/managedidentity.json | 114 + .../v5/managedidentitywithdelegation.json | 54 + .../resource-management/v5/mobo.json | 38 + .../resource-management/v5/privatelinks.json | 190 ++ .../resource-management/v5/types.json | 722 +++++ .../LandingZoneAccountOperations_Create.json | 83 + .../LandingZoneAccountOperations_Delete.json | 18 + .../LandingZoneAccountOperations_Get.json | 40 + ...AccountOperations_ListByResourceGroup.json | 44 + ...eAccountOperations_ListBySubscription.json | 43 + .../LandingZoneAccountOperations_Update.json | 56 + ...ingZoneConfigurationOperations_Create.json | 316 ++ ...oneConfigurationOperations_CreateCopy.json | 26 + ...ingZoneConfigurationOperations_Delete.json | 19 + ...urationOperations_GenerateLandingZone.json | 38 + ...andingZoneConfigurationOperations_Get.json | 118 + ...urationOperations_ListByResourceGroup.json | 122 + ...gurationOperations_ListBySubscription.json | 121 + ...ingZoneConfigurationOperations_Update.json | 213 ++ ...ationOperations_UpdateAuthoringStatus.json | 27 + ...dingZoneRegistrationOperations_Create.json | 71 + ...dingZoneRegistrationOperations_Delete.json | 15 + ...LandingZoneRegistrationOperations_Get.json | 36 + ...trationOperations_ListByResourceGroup.json | 40 + ...strationOperations_ListBySubscription.json | 39 + ...dingZoneRegistrationOperations_Update.json | 50 + .../examples/Operations_List.json | 286 ++ .../preview/2025-02-27-preview/sovereign.json | 2845 +++++++++++++++++ .../sovereign/resource-manager/readme.az.md | 28 + .../sovereign/resource-manager/readme.cli.md | 1 + .../resource-manager/readme.csharp.md | 15 + .../sovereign/resource-manager/readme.go.md | 11 + .../sovereign/resource-manager/readme.md | 82 + .../resource-manager/readme.python.md | 18 + .../resource-manager/readme.typescript.md | 14 + 67 files changed, 9370 insertions(+) create mode 100644 specification/sovereign/Sovereign.Management/common.tsp create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Create.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Delete.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Get.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_ListByResourceGroup.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_ListBySubscription.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Update.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Create.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_CreateCopy.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Delete.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_GenerateLandingZone.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Get.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_ListByResourceGroup.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_ListBySubscription.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Update.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_UpdateAuthoringStatus.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Create.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Delete.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Get.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_ListByResourceGroup.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_ListBySubscription.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Update.json create mode 100644 specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/Operations_List.json create mode 100644 specification/sovereign/Sovereign.Management/landingZoneAccountResourceProperties.tsp create mode 100644 specification/sovereign/Sovereign.Management/landingZoneConfigurationResourceProperties.tsp create mode 100644 specification/sovereign/Sovereign.Management/landingZoneRegistrationResourceProperties.tsp create mode 100644 specification/sovereign/Sovereign.Management/main.tsp create mode 100644 specification/sovereign/Sovereign.Management/tspconfig.yaml create mode 100644 specification/sovereign/cspell.yaml create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v3/types.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v4/managedidentity.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/customermanagedkeys.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/managedidentity.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/managedidentitywithdelegation.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/mobo.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/privatelinks.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/types.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Create.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Delete.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Get.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_ListByResourceGroup.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_ListBySubscription.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Update.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Create.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_CreateCopy.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Delete.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_GenerateLandingZone.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Get.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_ListByResourceGroup.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_ListBySubscription.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Update.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_UpdateAuthoringStatus.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Create.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Delete.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Get.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_ListByResourceGroup.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_ListBySubscription.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Update.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/Operations_List.json create mode 100644 specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/sovereign.json create mode 100644 specification/sovereign/resource-manager/readme.az.md create mode 100644 specification/sovereign/resource-manager/readme.cli.md create mode 100644 specification/sovereign/resource-manager/readme.csharp.md create mode 100644 specification/sovereign/resource-manager/readme.go.md create mode 100644 specification/sovereign/resource-manager/readme.md create mode 100644 specification/sovereign/resource-manager/readme.python.md create mode 100644 specification/sovereign/resource-manager/readme.typescript.md diff --git a/specification/sovereign/Sovereign.Management/common.tsp b/specification/sovereign/Sovereign.Management/common.tsp new file mode 100644 index 000000000000..d9f8e5532497 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/common.tsp @@ -0,0 +1,32 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/versioning"; + +using Azure.ResourceManager; +using Azure.Core; +using TypeSpec.Versioning; + +namespace Microsoft.Sovereign; + +@doc("The Microsoft Sovereign Provider version.") +enum Versions { + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("Public preview version.") + Preview20250227: "2025-02-27-preview", +} + +@added(Versions.Preview20250227) +@doc("The custom provisioning state.") +union provisioningState { + ResourceProvisioningState, + + @doc("The state of the resource when creating") + Creating: "Creating", + + @doc("The state of the resource when updating") + Updating: "Updating", + + @doc("The state of the resource when deleting") + Deleting: "Deleting", +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Create.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Create.json new file mode 100644 index 000000000000..90f3ca0dad56 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Create.json @@ -0,0 +1,83 @@ +{ + "title": "LandingZoneAccountOperations_Create", + "operationId": "LandingZoneAccountOperations_Create", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "resource": { + "properties": { + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestStorageAccount/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "location": "northeurope" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Delete.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Delete.json new file mode 100644 index 000000000000..691f5199332d --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LandingZoneAccountOperations_Delete", + "operationId": "LandingZoneAccountOperations_Delete", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Get.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Get.json new file mode 100644 index 000000000000..06f6203acad9 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Get.json @@ -0,0 +1,40 @@ +{ + "title": "LandingZoneAccountOperations_Get", + "operationId": "LandingZoneAccountOperations_Get", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_ListByResourceGroup.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_ListByResourceGroup.json new file mode 100644 index 000000000000..a34739adfaaa --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_ListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "title": "LandingZoneAccountOperations_ListByResourceGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "LandingZoneAccountOperations_ListByResourceGroup", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "rgsovereign" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_ListBySubscription.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_ListBySubscription.json new file mode 100644 index 000000000000..a3fdeb4bfccc --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "title": "LandingZoneAccountOperations_ListBySubscription", + "operationId": "LandingZoneAccountOperations_ListBySubscription", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Update.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Update.json new file mode 100644 index 000000000000..3d18831dae36 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneAccountOperations_Update.json @@ -0,0 +1,56 @@ +{ + "title": "LandingZoneAccountOperations_Update", + "operationId": "LandingZoneAccountOperations_Update", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "properties": { + "properties": { + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestStorageAccount/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "type": "SystemAssigned" + } + }, + "tags": { + "tag1": "MCFS" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Create.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Create.json new file mode 100644 index 000000000000..0631fa7d86f9 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Create.json @@ -0,0 +1,316 @@ +{ + "title": "LandingZoneConfigurationOperations_Create", + "operationId": "LandingZoneConfigurationOperations_Create", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC", + "resource": { + "properties": { + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_CreateCopy.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_CreateCopy.json new file mode 100644 index 000000000000..e7c04f7b2c5b --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_CreateCopy.json @@ -0,0 +1,26 @@ +{ + "title": "LandingZoneConfigurationOperations_CreateCopy", + "operationId": "LandingZoneConfigurationOperations_CreateCopy", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC", + "body": { + "name": "LandingZoneConfiguration" + } + }, + "responses": { + "200": { + "body": { + "copiedLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/Copy-ExampleLZC" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Delete.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Delete.json new file mode 100644 index 000000000000..c637d9048b45 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "LandingZoneConfigurationOperations_Delete", + "operationId": "LandingZoneConfigurationOperations_Delete", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_GenerateLandingZone.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_GenerateLandingZone.json new file mode 100644 index 000000000000..88c8c6c6db7a --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_GenerateLandingZone.json @@ -0,0 +1,38 @@ +{ + "title": "LandingZoneConfigurationOperations_GenerateLandingZone", + "operationId": "LandingZoneConfigurationOperations_GenerateLandingZone", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC", + "body": { + "infrastructureAsCodeOutputOptions": "Bicep", + "deploymentPrefix": "mcfs", + "topLevelMgDisplayName": "TestMG", + "deploymentLocation": "eastus", + "existingManagementSubscriptionId": "/subscriptions/49804ded-c8b8-43b2-8dba-bab9dd7d81e1", + "existingIdentitySubscriptionId": "/subscriptions/26211934-4ed9-4c30-b139-13bd61286867", + "existingConnectivitySubscriptionId": "/subscriptions/08a376df-4789-4920-9de8-cf6900b55968", + "subscriptionBillingScope": null, + "existingTopLevelMgParentId": null, + "deploymentSuffix": "test", + "organization": "test", + "environment": "QA" + } + }, + "responses": { + "200": { + "body": { + "topLevelMgDisplayName": "MCFS", + "landingZoneConfigurationName": "ExampleLZC" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Get.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Get.json new file mode 100644 index 000000000000..b0e2cbea75a6 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Get.json @@ -0,0 +1,118 @@ +{ + "title": "LandingZoneConfigurationOperations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "LandingZoneConfigurationOperations_Get", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "rgsovereign", + "landingZoneAccountName": "a-K18-78P-2c-33WD3e47yNxD5iwJ3-gB1C-PqU-6748-y85-c-Wu8", + "landingZoneConfigurationName": "Sj4K5xH1SJ-Ym35--O5-c8WGV7" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_ListByResourceGroup.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_ListByResourceGroup.json new file mode 100644 index 000000000000..9176f06c80a1 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_ListByResourceGroup.json @@ -0,0 +1,122 @@ +{ + "title": "LandingZoneConfigurationOperations_ListByResourceGroup", + "operationId": "LandingZoneConfigurationOperations_ListByResourceGroup", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_ListBySubscription.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_ListBySubscription.json new file mode 100644 index 000000000000..609d4d68f8f2 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_ListBySubscription.json @@ -0,0 +1,121 @@ +{ + "title": "LandingZoneConfigurationOperations_ListBySubscription", + "operationId": "LandingZoneConfigurationOperations_ListBySubscription", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Update.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Update.json new file mode 100644 index 000000000000..6360f3ee3bb1 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_Update.json @@ -0,0 +1,213 @@ +{ + "title": "LandingZoneConfigurationOperations_Update", + "operationId": "LandingZoneConfigurationOperations_Update", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC", + "properties": { + "properties": { + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_UpdateAuthoringStatus.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_UpdateAuthoringStatus.json new file mode 100644 index 000000000000..3850a08c7a3e --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneConfigurationOperations_UpdateAuthoringStatus.json @@ -0,0 +1,27 @@ +{ + "title": "LandingZoneConfigurationOperations_UpdateAuthoringStatus", + "operationId": "LandingZoneConfigurationOperations_UpdateAuthoringStatus", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC", + "body": { + "authoringStatus": "Authoring" + } + }, + "responses": { + "200": { + "body": { + "landingZoneConfigurationName": "ExampleLZC", + "authoringStatus": "Authoring" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Create.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Create.json new file mode 100644 index 000000000000..fe42f2f85516 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Create.json @@ -0,0 +1,71 @@ +{ + "title": "LandingZoneRegistrationOperations_Create", + "operationId": "LandingZoneRegistrationOperations_Create", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneRegistrationName": "ExampleLZR", + "resource": { + "properties": { + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Delete.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Delete.json new file mode 100644 index 000000000000..21c85ca59382 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Delete.json @@ -0,0 +1,15 @@ +{ + "title": "LandingZoneRegistrationOperations_Delete", + "operationId": "LandingZoneRegistrationOperations_Delete", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneRegistrationName": "ExampleLZR" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Get.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Get.json new file mode 100644 index 000000000000..99d49492053b --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Get.json @@ -0,0 +1,36 @@ +{ + "title": "LandingZoneRegistrationOperations_Get", + "operationId": "LandingZoneRegistrationOperations_Get", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneRegistrationName": "ExampleLZR" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_ListByResourceGroup.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_ListByResourceGroup.json new file mode 100644 index 000000000000..10531be009bb --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_ListByResourceGroup.json @@ -0,0 +1,40 @@ +{ + "title": "LandingZoneRegistrationOperations_ListByResourceGroup", + "operationId": "LandingZoneRegistrationOperations_ListByResourceGroup", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_ListBySubscription.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_ListBySubscription.json new file mode 100644 index 000000000000..a7f6a391f546 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_ListBySubscription.json @@ -0,0 +1,39 @@ +{ + "title": "LandingZoneRegistrationOperations_ListBySubscription", + "operationId": "LandingZoneRegistrationOperations_ListBySubscription", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Update.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Update.json new file mode 100644 index 000000000000..aaf47ed5be3c --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/LandingZoneRegistrationOperations_Update.json @@ -0,0 +1,50 @@ +{ + "title": "LandingZoneRegistrationOperations_Update", + "operationId": "LandingZoneRegistrationOperations_Update", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneRegistrationName": "ExampleLZR", + "properties": { + "properties": { + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/Operations_List.json b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/Operations_List.json new file mode 100644 index 000000000000..3a9f0ebb0bff --- /dev/null +++ b/specification/sovereign/Sovereign.Management/examples/2025-02-27-preview/Operations_List.json @@ -0,0 +1,286 @@ +{ + "title": "Operations_List_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-02-27-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Sovereign/Locations/operationstatuses/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "Locations/operationstatuses", + "operation": "read_operationstatuses", + "description": "read operationstatuses" + } + }, + { + "name": "Microsoft.Sovereign/Locations/operationstatuses/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "Locations/operationstatuses", + "operation": "write_operationstatuses", + "description": "write operationstatuses" + } + }, + { + "name": "Microsoft.Sovereign/checkNameAvailability/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "checkNameAvailability", + "operation": "action_checkNameAvailability", + "description": "action checkNameAvailability" + } + }, + { + "name": "Microsoft.Sovereign/Operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "Operations", + "operation": "read_Operations", + "description": "read Operations" + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_ListBySubscription", + "description": "Lists the landing zone accounts within a subscription." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_ListByResourceGroup", + "description": "Lists the landing zone accounts within a resource group." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_Get", + "description": "Gets the landing zone account." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_Create", + "description": "Creates the landing zone account." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_Delete", + "description": "Deletes the landing zone account." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_Update", + "description": "Updates the landing zone account." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_ListBySubscription", + "description": "Lists the landing zone configurations within a subscription." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_ListByResourceGroup", + "description": "Lists the landing zone configurations within a resource group." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_Get", + "description": "Gets the landing zone configuration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_Create", + "description": "Creates the landing zone configuration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_Delete", + "description": "Deletes the landing zone configuration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_Update", + "description": "Updates the landing zone configuration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/createCopy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations/createCopy", + "operation": "LandingZoneConfigurationOperations_CreateCopy", + "description": "Provides a mechanism to create a copy of the landing zone configuration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/generateLandingZone/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations/generateLandingZone", + "operation": "LandingZoneConfigurationOperations_GenerateLandingZone", + "description": "Generate the landing zone." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/updateAuthoringStatus/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations/updateAuthoringStatus", + "operation": "LandingZoneConfigurationOperations_UpdateAuthoringStatus", + "description": "Provides a mechanism to update the authoring status." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_ListBySubscription", + "description": "Lists the landing zone registrations within a subscription." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_ListByResourceGroup", + "description": "Lists the landing zone registrations within a resource group." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_Get", + "description": "Gets the landing zone registration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_Create", + "description": "Creates the landing zone registration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_Delete", + "description": "Deletes the landing zone registration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_Update", + "description": "Updates the landing zone registration." + } + }, + { + "name": "Microsoft.Sovereign/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "Microsoft.Sovereign", + "operation": "Register the Microsoft.Sovereign", + "description": "Register the subscription for Microsoft.Sovereign" + } + }, + { + "name": "Microsoft.Sovereign/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "Microsoft.Sovereign", + "operation": "Unregister the Microsoft.Sovereign", + "description": "Unregister the subscription for Microsoft.Sovereign" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/Sovereign.Management/landingZoneAccountResourceProperties.tsp b/specification/sovereign/Sovereign.Management/landingZoneAccountResourceProperties.tsp new file mode 100644 index 000000000000..a7b0120aba3d --- /dev/null +++ b/specification/sovereign/Sovereign.Management/landingZoneAccountResourceProperties.tsp @@ -0,0 +1,20 @@ +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.Core; + +namespace Microsoft.Sovereign; + +@added(Versions.Preview20250227) +@doc("The properties of landing zone account resource type.") +model LandingZoneAccountResourceProperties { + @visibility("read") + @doc("The status of a user-initiated, control-plane operation on the landing zone account.") + provisioningState?: provisioningState; + + @doc("The storage account that will host the generated slz code.") + storageAccount: armResourceIdentifier<[ + { + type: "Microsoft.Storage/storageAccounts"; + } + ]>; +} diff --git a/specification/sovereign/Sovereign.Management/landingZoneConfigurationResourceProperties.tsp b/specification/sovereign/Sovereign.Management/landingZoneConfigurationResourceProperties.tsp new file mode 100644 index 000000000000..3182240838d7 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/landingZoneConfigurationResourceProperties.tsp @@ -0,0 +1,441 @@ +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.Core; + +namespace Microsoft.Sovereign; + +@added(Versions.Preview20250227) +@doc("The properties of landing zone configuration resource type.") +model LandingZoneConfigurationResourceProperties { + @visibility("read") + @doc("The status of a user-initiated, control-plane operation on the landing zone configuration.") + provisioningState?: provisioningState; + + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "Handled in code." + @visibility("read") + @doc("The status for the landing zone configurations workflow.") + authoringStatus?: AuthoringStatus; + + @doc("To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan.") + ddosProtectionCreationOption: ResourceCreationOptions; + + @doc("The resource id of the ddos protection plan.") + existingDdosProtectionId?: armResourceIdentifier<[ + { + type: "Microsoft.Network/ddosProtectionPlans"; + } + ]>; + + @doc("To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace.") + logAnalyticsWorkspaceCreationOption: ResourceCreationOptions; + + @doc("The resource id of the log analytics workspace that was created to centralize log ingestion.") + existingLogAnalyticsWorkspaceId?: armResourceIdentifier<[ + { + type: "Microsoft.OperationalInsights/workspaces"; + } + ]>; + + @doc("Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}.") + @OpenAPI.extension("x-ms-identifiers", []) + tags?: Tags[]; + + @doc("To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one.") + firewallCreationOption: FirewallCreationOptions; + + @doc("Azure firewall subnet. IPv4 CIDR block.") + firewallSubnetCidrBlock?: string; + + @doc("Gateway subnet. IPv4 CIDR block.") + gatewaySubnetCidrBlock: string; + + @doc("Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730") + @minValue(30) + @maxValue(730) + logRetentionInDays: int64; + + @doc("The address space for the VNET. IPv4 CIDR block.") + hubNetworkCidrBlock: string; + + @doc("To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service.") + azureBastionCreationOption: ResourceCreationOptions; + + @doc("The resource id of azure bastion.") + existingAzureBastionId?: armResourceIdentifier<[ + { + type: "Microsoft.Network/bastionHosts"; + } + ]>; + + @doc("Azure bastion subnet. IP v4 CIDR block.") + azureBastionSubnetCidrBlock?: string; + + @doc("Landing zone children management group properties") + @OpenAPI.extension("x-ms-identifiers", []) + landingZonesMgChildren?: LandingZoneManagementGroupProperties[]; + + @doc("This will be applied to the root of the landing zone deployment.") + topLevelMgMetadata?: ManagementGroupProperties; + + @doc("This will be applied to the landing zone management groups.") + landingZonesMgMetadata?: ManagementGroupProperties; + + @doc("This will be applied to the platform management group.") + platformMgMetadata?: ManagementGroupProperties; + + @doc("This will be applied to the management management group under platform.") + platformManagementMgMetadata?: ManagementGroupProperties; + + @doc("This will be applied to the connectivity management group under platform.") + platformConnectivityMgMetadata?: ManagementGroupProperties; + + @doc("This will be applied to the identity management group under platform.") + platformIdentityMgMetadata?: ManagementGroupProperties; + + @doc("This will be applied to the decommissioned management group.") + decommissionedMgMetadata?: DecommissionedManagementGroupProperties; + + @doc("This will be applied to the sandbox management group.") + sandboxMgMetadata?: SandboxManagementGroupProperties; + + @doc("The managed identity to be tied to this landing zone configuration") + managedIdentity: ManagedIdentityProperties; + + @doc("Platform children management group properties.") + @OpenAPI.extension("x-ms-identifiers", []) + platformMgChildren?: PlatformManagementGroupProperties[]; + + @doc("The naming convention that's used by default for all resource types for this landing zone configuration") + namingConventionFormula?: string; + + @doc("The customized naming convention for one or more resource types in this landing zone configuration") + @OpenAPI.extension("x-ms-identifiers", []) + customNamingConvention?: CustomNamingConvention[]; +} + +@added(Versions.Preview20250227) +@doc("The properties of managed identity.") +model ManagedIdentityProperties { + @doc("The type of managed identity.") + type: ManagedIdentityResourceType; + + @doc("The resource id of the managed identity.") + userAssignedIdentityResourceId?: armResourceIdentifier<[ + { + type: "Microsoft.ManagedIdentity/userAssignedIdentities"; + } + ]>; +} + +@added(Versions.Preview20250227) +@doc("The authoring status for a landing zone configuration.") +union ManagedIdentityResourceType { + @doc("System assigned managed identity.") + SystemAssigned: "SystemAssigned", + + @doc("User assigned managed identity.") + UserAssigned: "UserAssigned", + + string, +} + +@doc("The details associated with tags.") +model Tags { + @doc("A tag name.") + name: string; + + @doc("A tag value.") + @madeOptional(Versions.Preview20250227) + value?: string; +} + +@doc("Landing zone management group properties.") +model LandingZoneManagementGroupProperties { + ...ManagementGroupProperties; + + @doc("Management group name.") + name: string; +} + +@doc("Details of the policy and initiatives associated with the management group.") +model ManagementGroupProperties { + @doc("Array of initiative assignments to be applied to the management group.") + @OpenAPI.extension("x-ms-identifiers", []) + policyInitiativesAssignmentProperties: PolicyInitiativeAssignmentProperties[]; +} + +@doc("Details of policy assignments") +model PolicyInitiativeAssignmentProperties { + @doc("The fully qualified id of the policy initiative.") + policyInitiativeId: string; + + #suppress "@azure-tools/typespec-azure-core/bad-record-type" "This would be customer defined parameter based on the policy initiatives to be assigned. Hence we need to use Record as it will differ per initiative." + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Model properties or operation parameters should not be of type Record. ARM requires Resource provider teams to define types explicitly." + @doc("The parameters for the assignment of policy initiatives.") + assignmentParameters: Record; +} + +@doc("Decommissioned management group properties.") +model DecommissionedManagementGroupProperties { + ...ManagementGroupProperties; + + @doc("When set to false, this management group will not be created. The default value is false.") + create: boolean; +} + +@doc("Sandbox management group properties.") +model SandboxManagementGroupProperties { + ...ManagementGroupProperties; + + @doc("When set to false this management group will not be created. The default value is false.") + create: boolean; +} + +@doc("The request to generate code for a landing zone.") +model GenerateLandingZoneRequest { + @doc("The export options available for code generation.") + infrastructureAsCodeOutputOptions: InfrastructureAsCodeOutputOptions; + + @doc("Management subscription fully qualified Id.") + existingManagementSubscriptionId?: armResourceIdentifier<[ + { + type: "Microsoft.Subscription/aliases"; + } + ]>; + + @doc("Identity subscription fully qualified Id.") + existingIdentitySubscriptionId?: armResourceIdentifier<[ + { + type: "Microsoft.Subscription/aliases"; + } + ]>; + + @doc("Connectivity subscription fully qualified Id.") + existingConnectivitySubscriptionId?: armResourceIdentifier<[ + { + type: "Microsoft.Subscription/aliases"; + } + ]>; + + @doc("The full resource ID of billing scope associated to the EA, MCA or MPA account you wish to create the subscription in.") + subscriptionBillingScope?: string; + + @doc("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.") + existingTopLevelMgParentId?: armResourceIdentifier<[ + { + type: "Microsoft.Management/managementGroups"; + } + ]>; + + @doc("The prefix that will be added to all resources created by this deployment.") + @minLength(2) + @maxLength(5) + @pattern("^([a-zA-Z0-9-]*)$") + deploymentPrefix: string; + + @doc("The suffix that will be added to all resources created by this deployment.") + @minLength(2) + @maxLength(5) + deploymentSuffix?: string; + + @doc("The top level management group display name.") + @minLength(1) + @maxLength(90) + topLevelMgDisplayName: string; + + @doc("Location to run deployment(s) from the list of azure regions.") + @pattern("^([a-zA-Z0-9]+)$") + deploymentLocation: string; + + @doc("The name of the organization or agency the landing zone is being deployed for.") + organization?: string; + + @doc("The environment for which the landing zone is being deployed") + environment?: string; +} + +@doc("The response for the request to generate landing zone code.") +model GenerateLandingZoneResponse { + @doc("The top level Management Group display name.") + topLevelMgDisplayName: string; + + @doc("The name of the Landing Zone configuration resource.") + landingZoneConfigurationName: string; + + @doc("The url to access the generated code..") + @secret + generatedCodeUrl: url; + + @doc("The storage account name to access the generated code.") + @secret + storageAccountName: string; + + @doc("The storage account container to access the generated code.") + @secret + containerName: string; + + @doc("The storage account blob name to access the generated code.") + @secret + blobName: string; + + @doc("The generated code content as a json string.") + @secret + generatedArmTemplate?: string; +} + +@doc("The request to update authoring status of a configuration.") +model UpdateAuthoringStatusRequest { + @doc("The value of the authoring status to be updated.") + authoringStatus: AuthoringStatus; +} + +@doc("The response for the request to update authoring status.") +model UpdateAuthoringStatusResponse { + @doc("The name of the landing zone configuration resource.") + landingZoneConfigurationName: string; + + @doc("The value of the authoring status to be updated.") + authoringStatus: AuthoringStatus; +} + +@doc("The authoring status for a landing zone configuration.") +union AuthoringStatus { + @doc("This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated.") + Authoring: "Authoring", + + @doc("This status is set when the configuration changes are complete and the configuration is ready for code generation") + ReadyForUse: "ReadyForUse", + + @doc("This status is set when the landing zone configuration is no longer in use.") + Disabled: "Disabled", + + string, +} + +@doc("Output options for landing zone code generation.") +union InfrastructureAsCodeOutputOptions { + @doc("Value when generating Landing Zone code in Bicep.") + Bicep: "Bicep", + + @doc("Value when generating landing zone code in Arm.") + ARM: "ARM", + + string, +} + +@doc("The input values for creating or using an existing firewall resource.") +union FirewallCreationOptions { + @doc("Value when a firewall resource is not created.") + None: "None", + + @doc("Value when the firewall creation is based on the standard SKU.") + Standard: "Standard", + + @doc("Value when the firewall creation is based on the premium SKU.") + Premium: "Premium", + + string, +} + +@doc("Options for resource creation.") +union ResourceCreationOptions { + @doc("Value to create a new resource.") + Yes: "Yes", + + @doc("Value to not create a new resource.") + No: "No", + + @doc("Value to use an existing resource.") + UseExisting: "UseExisting", + + string, +} + +@doc("The request for the create copy action of landing zone configuration.") +model CreateCopyRequest { + @doc("The name of the new landing zone configuration resource.") + @pattern("^[a-zA-Z0-9-]{3,24}$") + name: string; +} + +@doc("The response of the create copy action of landing zone configuration.") +model CreateCopyResponse { + @doc("The id of the copied landing zone configuration resource.") + copiedLandingZoneConfigurationId: armResourceIdentifier<[ + { + type: "Microsoft.Sovereign/landingZoneConfigurations"; + } + ]>; +} + +@doc("The request for the create copy action of landing zone configuration.") +model CreateLandingZoneConfigurationCopyRequest { + @doc("The name of the new landing zone configuration resource.") + @pattern("^[a-zA-Z0-9-]{3,64}$") + name: string; +} + +@doc("The response of the create copy action of landing zone configuration.") +model CreateLandingZoneConfigurationCopyResponse { + @doc("The id of the copied landing zone configuration resource.") + copiedLandingZoneConfigurationId: armResourceIdentifier<[ + { + type: "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations"; + } + ]>; +} + +@doc("The details for the custom resource override.") +@added(Versions.Preview20250227) +model CustomNamingConvention { + @doc("The type of the resource.") + resourceType: ResourceType; + + @doc("The custom formula for the resource type.") + formula: string; +} + +@doc("The input values for defining resource types for naming conventions.") +@added(Versions.Preview20250227) +union ResourceType { + @doc("Value when customer wants to provide custom naming convention for Azure Firewall.") + azureFirewalls: "azureFirewalls", + + @doc("Value when customer wants to provide custom naming convention for Log Analytics workspace.") + workspaces: "workspaces", + + @doc("Value when customer wants to provide custom naming convention for automation account.") + automationAccounts: "automationAccounts", + + @doc("Value when customer wants to provide custom naming convention for dashboard.") + dashboards: "dashboards", + + @doc("Value when customer wants to provide custom naming convention for managed identity.") + userAssignedIdentities: "userAssignedIdentities", + + @doc("Value when customer wants to provide custom naming convention for Bastion.") + bastionHosts: "bastionHosts", + + @doc("Value when customer wants to provide custom naming convention for DDoS protection plan.") + ddosProtectionPlans: "ddosProtectionPlans", + + @doc("Value when customer wants to provide custom naming convention for Bastion NSG.") + networkSecurityGroups: "networkSecurityGroups", + + @doc("Value when customer wants to provide custom naming convention for virtual network.") + virtualNetworks: "virtualNetworks", + + @doc("Value when customer wants to provide custom naming convention for route table.") + routeTables: "routeTables", + + string, +} + +@added(Versions.Preview20250227) +@doc("Platform management group properties.") +model PlatformManagementGroupProperties { + ...ManagementGroupProperties; + + @doc("Management group name.") + name: string; +} diff --git a/specification/sovereign/Sovereign.Management/landingZoneRegistrationResourceProperties.tsp b/specification/sovereign/Sovereign.Management/landingZoneRegistrationResourceProperties.tsp new file mode 100644 index 000000000000..d3e8356636c4 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/landingZoneRegistrationResourceProperties.tsp @@ -0,0 +1,31 @@ +using Azure.ResourceManager; +using TypeSpec.Versioning; +using Azure.Core; + +namespace Microsoft.Sovereign; + +@added(Versions.Preview20250227) +@doc("The properties of landing zone registration resource type.") +model LandingZoneRegistrationResourceProperties { + @visibility("read") + @doc("The status of a user-initiated, control-plane operation on the landing Zone registration resource type.") + provisioningState?: provisioningState; + + @doc("The resource id of the top level management group") + existingTopLevelMgId: armResourceIdentifier<[ + { + type: "Microsoft.Management/managementGroups"; + } + ]>; + + //need to check if landingZoneAccount name is needed + @doc("The resource id of the associated landing zone configuration.") + existingLandingZoneConfigurationId: armResourceIdentifier<[ + { + type: "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations"; + } + ]>; + + @doc("The managed identity to be tied to this landing zone registration") + managedIdentity: ManagedIdentityProperties; +} diff --git a/specification/sovereign/Sovereign.Management/main.tsp b/specification/sovereign/Sovereign.Management/main.tsp new file mode 100644 index 000000000000..30ebdfb97013 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/main.tsp @@ -0,0 +1,163 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-azure-resource-manager"; + +import "./common.tsp"; +import "./landingZoneAccountResourceProperties.tsp"; +import "./landingZoneConfigurationResourceProperties.tsp"; +import "./landingZoneRegistrationResourceProperties.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.ResourceManager; +using Azure.Core; +using OpenAPI; + +@service({ + title: "Cloud for Sovereignty Resource Provider.", +}) +@versioned(Versions) +@armProviderNamespace +@armCommonTypesVersion("v5") +namespace Microsoft.Sovereign; + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("The Landing zone account parent resource type.") +@added(Versions.Preview20250227) +@resource("landingZoneAccounts") +model LandingZoneAccountResource + is TrackedResource { + @doc("The parent landing zone account") + @segment("landingZoneAccounts") + @key("landingZoneAccountName") + @pattern("^[a-zA-Z0-9-]{3,64}$") + @visibility("read") + @path + name: string; + + ...ManagedServiceIdentityProperty; +} + +@armResourceOperations(LandingZoneAccountResource) +@added(Versions.Preview20250227) +interface LandingZoneAccountOperations { + @doc("Gets the landing zone account.") + get is ArmResourceRead; + @doc("Creates the landing zone account.") + create is ArmResourceCreateOrReplaceAsync; + @doc("Updates the landing zone account.") + update is ArmResourcePatchAsync< + LandingZoneAccountResource, + LandingZoneAccountResourceProperties + >; + @doc("Deletes the landing zone account.") + delete is ArmResourceDeleteWithoutOkAsync; + @doc("Lists the landing zone accounts within a resource group.") + listByResourceGroup is ArmResourceListByParent; + @doc("Lists the landing zone accounts within a subscription.") + listBySubscription is ArmListBySubscription; +} + +@parentResource(LandingZoneAccountResource) +@added(Versions.Preview20250227) +@resource("landingZoneConfigurations") +model LandingZoneConfigurationResource + is ProxyResource { + @doc("The landing zone configuration name") + @segment("landingZoneConfigurations") + @key("landingZoneConfigurationName") + @visibility("read") + @pattern("^[a-zA-Z0-9-]{3,64}$") + @path + name: string; +} + +@added(Versions.Preview20250227) +@armResourceOperations(LandingZoneConfigurationResource) +interface LandingZoneConfigurationOperations { + @doc("Gets the landing zone configuration.") + get is ArmResourceRead; + @doc("Creates the landing zone configuration.") + create is ArmResourceCreateOrReplaceAsync; + @doc("Updates the landing zone configuration.") + update is ArmResourcePatchAsync< + LandingZoneConfigurationResource, + LandingZoneConfigurationResourceProperties + >; + @doc("Deletes the landing zone configuration.") + delete is ArmResourceDeleteWithoutOkAsync; + @doc("Lists the landing zone configurations within a resource group.") + listByResourceGroup is ArmResourceListByParent; + @doc("Lists the landing zone configurations within a subscription.") + listBySubscription is ArmListBySubscription; + + @action("generateLandingZone") + @doc("Generate the landing zone.") + @added(Versions.Preview20250227) + @armResourceAction(LandingZoneConfigurationResource) + generateLandingZone is ArmResourceActionAsync< + LandingZoneConfigurationResource, + GenerateLandingZoneRequest, + GenerateLandingZoneResponse + >; + + @action("updateAuthoringStatus") + @doc("Provides a mechanism to update the authoring status.") + @added(Versions.Preview20250227) + @armResourceAction(LandingZoneConfigurationResource) + updateAuthoringStatus is ArmResourceActionAsync< + LandingZoneConfigurationResource, + UpdateAuthoringStatusRequest, + UpdateAuthoringStatusResponse + >; + + @action("createCopy") + @doc("Provides a mechanism to create a copy of the landing zone configuration.") + @added(Versions.Preview20250227) + @armResourceAction(LandingZoneConfigurationResource) + createCopy is ArmResourceActionAsync< + LandingZoneConfigurationResource, + CreateLandingZoneConfigurationCopyRequest, + CreateLandingZoneConfigurationCopyResponse + >; +} + +// Landing zone registration resource type +@parentResource(LandingZoneAccountResource) +@added(Versions.Preview20250227) +@resource("landingZoneRegistrations") +@doc("The Landing Zone registration resource type") +model LandingZoneRegistrationResource + is ProxyResource { + @doc("The name of the Landing Zone Registration resource.") + @pattern("^[a-zA-Z0-9-]{3,64}$") + @key("landingZoneRegistrationName") + @segment("landingZoneRegistrations") + @path + name: string; +} + +@added(Versions.Preview20250227) +@armResourceOperations(LandingZoneRegistrationResource) +interface LandingZoneRegistrationOperations { + @doc("Gets the landing zone registration.") + get is ArmResourceRead; + @doc("Creates the landing zone registration.") + create is ArmResourceCreateOrReplaceAsync; + @doc("Updates the landing zone registration.") + update is ArmResourcePatchAsync< + LandingZoneRegistrationResource, + LandingZoneRegistrationResourceProperties + >; + @doc("Deletes the landing zone registration.") + delete is ArmResourceDeleteSync; + @doc("Lists the landing zone registrations within a resource group.") + listByResourceGroup is ArmResourceListByParent; + @doc("Lists the landing zone registrations within a subscription.") + listBySubscription is ArmListBySubscription; +} diff --git a/specification/sovereign/Sovereign.Management/tspconfig.yaml b/specification/sovereign/Sovereign.Management/tspconfig.yaml new file mode 100644 index 000000000000..42029e1384f9 --- /dev/null +++ b/specification/sovereign/Sovereign.Management/tspconfig.yaml @@ -0,0 +1,12 @@ +emit: + - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + emitter-output-dir: "{project-root}/../" + azure-resource-provider-folder: "resource-manager" + examples-dir: "{project-root}/examples" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/sovereign.json" diff --git a/specification/sovereign/cspell.yaml b/specification/sovereign/cspell.yaml new file mode 100644 index 000000000000..ffc1a47c4f8d --- /dev/null +++ b/specification/sovereign/cspell.yaml @@ -0,0 +1,21 @@ +# This file configures spell checking. Items in "words" were initially populated +# with words that might be spelling errors. Review these words and take +# appropriate action. For more information, see: https://aka.ms/ci-fix#spell-check + +# Spell checking is not case sensitive +# Keep word lists in alphabetical order so the file is easier to manage +version: '0.2' +import: + - ../../cspell.yaml +words: + - lzcchildproxys + - lzcchildtrackeds + - lzclocationbasedproxyname + - lzclocationbasedproxys + - lzrchildproxys + - lzrchildtrackeds + - mobo + - proxys + - sovereignt + - türkiye + - unversioned diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v3/types.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v3/types.json new file mode 100644 index 000000000000..3785f8b346c7 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v3/types.json @@ -0,0 +1,695 @@ +{ + "swagger": "2.0", + "info": { + "version": "3.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "Resource": { + "title": "Resource", + "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "#/definitions/systemData" + } + }, + "x-ms-azure-resource": true + }, + "AzureEntityResource": { + "x-ms-client-name": "AzureEntityResource", + "title": "Entity Resource", + "description": "The resource model definition for an Azure Resource Manager resource with an etag.", + "type": "object", + "properties": { + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "TrackedResource": { + "title": "Tracked Resource", + "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "title": "Proxy Resource", + "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ResourceModelWithAllowedPropertySet": { + "description": "The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "managedBy": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "kind": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. " + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "identity": { + "allOf": [ + { + "$ref": "#/definitions/Identity" + } + ] + }, + "sku": { + "allOf": [ + { + "$ref": "#/definitions/Sku" + } + ] + }, + "plan": { + "allOf": [ + { + "$ref": "#/definitions/Plan" + } + ] + } + }, + "x-ms-azure-resource": true + }, + "SkuTier": { + "type": "string", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + }, + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." + }, + "Sku": { + "description": "The resource model definition representing SKU", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "tier": { + "$ref": "#/definitions/SkuTier" + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "Identity": { + "description": "Identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + } + }, + "Plan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + }, + "description": "Plan for the resource.", + "required": [ + "name", + "publisher", + "product" + ] + }, + "ErrorDetail": { + "description": "The error detail.", + "type": "object", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "description": "The error additional info." + } + } + }, + "ErrorResponse": { + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + }, + "Operation": { + "title": "REST API Operation", + "description": "Details of a REST API operation, returned from the Resource Provider Operations API", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.", + "type": "boolean", + "readOnly": true + }, + "display": { + "description": "Localized display information for this particular operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.", + "type": "string", + "readOnly": true + } + } + }, + "origin": { + "description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"", + "type": "string", + "readOnly": true, + "enum": [ + "user", + "system", + "user,system" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + } + }, + "actionType": { + "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "type": "string", + "readOnly": true, + "enum": [ + "Internal" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + } + } + }, + "OperationListResult": { + "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the resource provider", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + } + }, + "OperationStatusResult": { + "description": "The current status of an async operation.", + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string" + }, + "name": { + "description": "Name of the async operation.", + "type": "string" + }, + "status": { + "description": "Operation status.", + "type": "string" + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time" + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationStatusResult" + } + }, + "error": { + "description": "If present, details of the operation error.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "locationData": { + "description": "Metadata pertaining to the geographic location of the resource.", + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 256, + "description": "A canonical name for the geographic or physical location." + }, + "city": { + "type": "string", + "description": "The city or locality where the resource is located." + }, + "district": { + "type": "string", + "description": "The district, state, or province where the resource is located." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region where the resource is located" + } + }, + "required": [ + "name" + ] + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "encryptionProperties": { + "description": "Configuration of key for data encryption", + "type": "object", + "properties": { + "status": { + "description": "Indicates whether or not the encryption is enabled for container registry.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "identity": { + "description": "The client ID of the identity which will be used to access key vault.", + "type": "string" + } + } + }, + "CheckNameAvailabilityRequest": { + "description": "The check availability request body.", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource for which availability needs to be checked.", + "type": "string" + }, + "type": { + "description": "The resource type.", + "type": "string" + } + } + }, + "CheckNameAvailabilityResponse": { + "description": "The check availability result.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates if the resource name is available.", + "type": "boolean" + }, + "reason": { + "description": "The reason why the given name is not available.", + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "CheckNameAvailabilityReason", + "modelAsString": true + } + }, + "message": { + "description": "Detailed reason why the given name is available.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription.", + "minLength": 1 + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation.", + "minLength": 1 + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of an ongoing async operation.", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Azure region.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v4/managedidentity.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v4/managedidentity.json new file mode 100644 index 000000000000..05f812c9d58f --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v4/managedidentity.json @@ -0,0 +1,113 @@ +{ + "swagger": "2.0", + "info": { + "version": "4.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "UserAssignedIdentities": { + "title": "User-Assigned Identities", + "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.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "UserAssignedIdentity": { + "type": "object", + "description": "User assigned identity properties", + "properties": { + "principalId": { + "description": "The principal ID of the assigned identity.", + "format": "uuid", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client ID of the assigned identity.", + "format": "uuid", + "type": "string", + "readOnly": true + } + } + }, + "ManagedServiceIdentityType": { + "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + }, + "ManagedServiceIdentity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/ManagedServiceIdentityType" + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentities" + } + }, + "required": [ + "type" + ] + }, + "SystemAssignedServiceIdentityType": { + "description": "Type of managed service identity (either system assigned, or none).", + "enum": [ + "None", + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "SystemAssignedServiceIdentityType", + "modelAsString": true + } + }, + "SystemAssignedServiceIdentity": { + "description": "Managed service identity (either system assigned, or none)", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/SystemAssignedServiceIdentityType" + } + }, + "required": [ + "type" + ] + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/customermanagedkeys.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/customermanagedkeys.json new file mode 100644 index 000000000000..736401b6ffc8 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/customermanagedkeys.json @@ -0,0 +1,68 @@ +{ + "swagger": "2.0", + "info": { + "version": "5.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "encryption": { + "type": "object", + "description": "All encryption configuration for a resource.", + "properties": { + "infrastructureEncryption": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "InfrastructureEncryption", + "modelAsString": true + }, + "description": "(Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled." + }, + "customerManagedKeyEncryption": { + "type": "object", + "description": "All Customer-managed key encryption properties for the resource.", + "properties": { + "keyEncryptionKeyIdentity": { + "type": "object", + "description": "All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.", + "properties": { + "identityType": { + "type": "string", + "enum": [ + "systemAssignedIdentity", + "userAssignedIdentity", + "delegatedResourceIdentity" + ], + "description": "The type of identity to use. Values can be systemAssignedIdentity, userAssignedIdentity, or delegatedResourceIdentity." + }, + "userAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity." + }, + "federatedClientId": { + "type": "string", + "format": "uuid", + "description": "application client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540" + }, + "delegatedIdentityClientId": { + "type": "string", + "format": "uuid", + "description": "delegated identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and userAssignedIdentity - internal use only." + } + } + }, + "keyEncryptionKeyUrl": { + "type": "string", + "description": "key encryption key Url, versioned or unversioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek." + } + } + } + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/managedidentity.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/managedidentity.json new file mode 100644 index 000000000000..388dd1f0a0d6 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/managedidentity.json @@ -0,0 +1,114 @@ +{ + "swagger": "2.0", + "info": { + "version": "5.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "UserAssignedIdentities": { + "title": "User-Assigned Identities", + "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.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity", + "x-nullable": true + } + }, + "UserAssignedIdentity": { + "type": "object", + "description": "User assigned identity properties", + "properties": { + "principalId": { + "description": "The principal ID of the assigned identity.", + "format": "uuid", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client ID of the assigned identity.", + "format": "uuid", + "type": "string", + "readOnly": true + } + } + }, + "ManagedServiceIdentityType": { + "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + }, + "ManagedServiceIdentity": { + "description": "Managed service identity (system assigned and/or user assigned identities)", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/ManagedServiceIdentityType" + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentities" + } + }, + "required": [ + "type" + ] + }, + "SystemAssignedServiceIdentityType": { + "description": "Type of managed service identity (either system assigned, or none).", + "enum": [ + "None", + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "SystemAssignedServiceIdentityType", + "modelAsString": true + } + }, + "SystemAssignedServiceIdentity": { + "description": "Managed service identity (either system assigned, or none)", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "format": "uuid", + "type": "string", + "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/SystemAssignedServiceIdentityType" + } + }, + "required": [ + "type" + ] + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/managedidentitywithdelegation.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/managedidentitywithdelegation.json new file mode 100644 index 000000000000..6906526571cc --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/managedidentitywithdelegation.json @@ -0,0 +1,54 @@ +{ + "swagger": "2.0", + "info": { + "version": "5.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "ManagedServiceIdentityWithDelegation": { + "description": "Managed service identity (system assigned and/or user assigned identities and/or delegated identities) - internal use only.", + "type": "object", + "allOf": [ + { + "$ref": "managedidentity.json#/definitions/ManagedServiceIdentity" + } + ], + "properties": { + "delegatedResources": { + "$ref": "#/definitions/DelegatedResources" + } + } + }, + "DelegatedResources": { + "description": "The set of delegated resources. The delegated resources dictionary keys will be source resource internal ids - internal use only.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DelegatedResource" + } + }, + "DelegatedResource": { + "type": "object", + "description": "Delegated resource properties - internal use only.", + "properties": { + "resourceId": { + "description": "The ARM resource id of the delegated resource - internal use only.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id of the delegated resource - internal use only.", + "format": "uuid", + "type": "string" + }, + "referralResource": { + "description": "The delegation id of the referral delegation (optional) - internal use only.", + "type": "string" + }, + "location": { + "description": "The source resource location - internal use only.", + "type": "string" + } + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/mobo.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/mobo.json new file mode 100644 index 000000000000..c9f4b3ecee36 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/mobo.json @@ -0,0 +1,38 @@ +{ + "swagger": "2.0", + "info": { + "version": "5.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "ManagedOnBehalfOfConfiguration": { + "type": "object", + "description": "Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner.", + "properties": { + "moboBrokerResources": { + "type": "array", + "description": "Managed-On-Behalf-Of broker resources", + "items": { + "$ref": "#/definitions/MoboBrokerResource" + }, + "x-ms-identifiers": [ + "id" + ] + } + }, + "readOnly": true + }, + "MoboBrokerResource": { + "type": "object", + "description": "Managed-On-Behalf-Of broker resource. This resource is created by the Resource Provider to manage some resources on behalf of the user.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource identifier of a Managed-On-Behalf-Of broker resource" + } + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/privatelinks.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/privatelinks.json new file mode 100644 index 000000000000..8a17f46df8de --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/privatelinks.json @@ -0,0 +1,190 @@ +{ + "swagger": "2.0", + "info": { + "version": "5.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "PrivateEndpoint": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for private endpoint." + } + }, + "description": "The private endpoint resource." + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../v5/types.json#/definitions/Resource" + } + ], + "description": "The private endpoint connection resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "groupIds": { + "description": "The group ids for the private endpoint resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The private endpoint resource." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the private endpoint connection." + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../v5/types.json#/definitions/Resource" + } + ], + "description": "A private link resource." + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "description": "List of private endpoint connections associated with the specified resource." + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources." + } + }, + "parameters": { + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the Azure resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/types.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/types.json new file mode 100644 index 000000000000..aff6214d69d7 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/common-types/resource-management/v5/types.json @@ -0,0 +1,722 @@ +{ + "swagger": "2.0", + "info": { + "version": "4.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "Resource": { + "title": "Resource", + "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" + }, + "systemData": { + "readOnly": true, + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "#/definitions/systemData" + } + }, + "x-ms-azure-resource": true + }, + "AzureEntityResource": { + "x-ms-client-name": "AzureEntityResource", + "title": "Entity Resource", + "description": "The resource model definition for an Azure Resource Manager resource with an etag.", + "type": "object", + "properties": { + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "TrackedResource": { + "title": "Tracked Resource", + "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "title": "Proxy Resource", + "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ResourceModelWithAllowedPropertySet": { + "description": "The resource model definition containing the full set of allowed properties for a resource. Except properties bag, there cannot be a top level property outside of this set.", + "type": "object", + "properties": { + "managedBy": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "kind": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. " + }, + "identity": { + "allOf": [ + { + "$ref": "#/definitions/Identity" + } + ] + }, + "sku": { + "allOf": [ + { + "$ref": "#/definitions/Sku" + } + ] + }, + "plan": { + "allOf": [ + { + "$ref": "#/definitions/Plan" + } + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "SkuTier": { + "type": "string", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + }, + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." + }, + "Sku": { + "description": "The resource model definition representing SKU", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. E.g. P3. It is typically a letter+number code" + }, + "tier": { + "$ref": "#/definitions/SkuTier" + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "Identity": { + "description": "Identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "format": "uuid", + "description": "The principal ID of resource identity. The value must be an UUID." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "format": "uuid", + "description": "The tenant ID of resource. The value must be an UUID." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + } + }, + "Plan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + }, + "description": "Plan for the resource.", + "required": [ + "name", + "publisher", + "product" + ] + }, + "ErrorDetail": { + "description": "The error detail.", + "type": "object", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "x-ms-identifiers": [], + "description": "The error additional info." + } + } + }, + "ErrorResponse": { + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + }, + "Operation": { + "title": "REST API Operation", + "description": "Details of a REST API operation, returned from the Resource Provider Operations API", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.", + "type": "boolean", + "readOnly": true + }, + "display": { + "description": "Localized display information for this particular operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.", + "type": "string", + "readOnly": true + } + } + }, + "origin": { + "description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"", + "type": "string", + "readOnly": true, + "enum": [ + "user", + "system", + "user,system" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + } + }, + "actionType": { + "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "type": "string", + "readOnly": true, + "enum": [ + "Internal" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + } + } + }, + "OperationListResult": { + "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations supported by the resource provider", + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + } + }, + "OperationStatusResult": { + "description": "The current status of an async operation.", + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string", + "format": "arm-id" + }, + "resourceId": { + "description": "Fully qualified ID of the resource against which the original async operation was started.", + "type": "string", + "format": "arm-id", + "readOnly": true + }, + "name": { + "description": "Name of the async operation.", + "type": "string" + }, + "status": { + "description": "Operation status.", + "type": "string" + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time" + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationStatusResult" + } + }, + "error": { + "description": "If present, details of the operation error.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "locationData": { + "description": "Metadata pertaining to the geographic location of the resource.", + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 256, + "description": "A canonical name for the geographic or physical location." + }, + "city": { + "type": "string", + "description": "The city or locality where the resource is located." + }, + "district": { + "type": "string", + "description": "The district, state, or province where the resource is located." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region where the resource is located" + } + }, + "required": [ + "name" + ] + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "encryptionProperties": { + "description": "Configuration of key for data encryption", + "type": "object", + "properties": { + "status": { + "description": "Indicates whether or not the encryption is enabled for container registry.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "identity": { + "description": "The client ID of the identity which will be used to access key vault.", + "type": "string" + } + } + }, + "CheckNameAvailabilityRequest": { + "description": "The check availability request body.", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource for which availability needs to be checked.", + "type": "string" + }, + "type": { + "description": "The resource type.", + "type": "string" + } + } + }, + "CheckNameAvailabilityResponse": { + "description": "The check availability result.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates if the resource name is available.", + "type": "boolean" + }, + "reason": { + "description": "The reason why the given name is not available.", + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "CheckNameAvailabilityReason", + "modelAsString": true + } + }, + "message": { + "description": "Detailed reason why the given name is available.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "The ID of the target subscription. The value must be an UUID." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation.", + "minLength": 1 + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ManagementGroupNameParameter": { + "name": "managementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the management group. The name is case insensitive.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope at which the operation is performed.", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "TenantIdParameter": { + "name": "tenantId", + "in": "path", + "description": "The Azure tenant ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of an ongoing async operation.", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure region.", + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "If-Match": { + "name": "ifMatch", + "in": "header", + "required": true, + "type": "string", + "description": "The If-Match header that makes a request conditional.", + "x-ms-parameter-location": "method" + }, + "If-None-Match": { + "name": "ifNoneMatch", + "in": "header", + "required": true, + "type": "string", + "description": "The If-None-Match header that makes a request conditional.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Create.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Create.json new file mode 100644 index 000000000000..90f3ca0dad56 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Create.json @@ -0,0 +1,83 @@ +{ + "title": "LandingZoneAccountOperations_Create", + "operationId": "LandingZoneAccountOperations_Create", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "resource": { + "properties": { + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestStorageAccount/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "location": "northeurope" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Delete.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Delete.json new file mode 100644 index 000000000000..691f5199332d --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LandingZoneAccountOperations_Delete", + "operationId": "LandingZoneAccountOperations_Delete", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Get.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Get.json new file mode 100644 index 000000000000..06f6203acad9 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Get.json @@ -0,0 +1,40 @@ +{ + "title": "LandingZoneAccountOperations_Get", + "operationId": "LandingZoneAccountOperations_Get", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_ListByResourceGroup.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_ListByResourceGroup.json new file mode 100644 index 000000000000..a34739adfaaa --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_ListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "title": "LandingZoneAccountOperations_ListByResourceGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "LandingZoneAccountOperations_ListByResourceGroup", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "rgsovereign" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_ListBySubscription.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_ListBySubscription.json new file mode 100644 index 000000000000..a3fdeb4bfccc --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "title": "LandingZoneAccountOperations_ListBySubscription", + "operationId": "LandingZoneAccountOperations_ListBySubscription", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Update.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Update.json new file mode 100644 index 000000000000..3d18831dae36 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneAccountOperations_Update.json @@ -0,0 +1,56 @@ +{ + "title": "LandingZoneAccountOperations_Update", + "operationId": "LandingZoneAccountOperations_Update", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "properties": { + "properties": { + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestStorageAccount/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "type": "SystemAssigned" + } + }, + "tags": { + "tag1": "MCFS" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Storage/storageAccounts/teststcontainer" + }, + "identity": { + "principalId": "e7953ada-b215-4c82-9a4c-7b8dd6e09beb", + "tenantId": "8a7a0a60-587f-4774-af1f-4cbf9f1edb6b", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "MCFS" + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/ExampleResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA", + "name": "ExampleLZA", + "type": "microsoft.sovereign/landingzoneaccounts", + "location": "northeurope", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T15:27:06.6937323Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T18:35:56.1267273Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Create.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Create.json new file mode 100644 index 000000000000..0631fa7d86f9 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Create.json @@ -0,0 +1,316 @@ +{ + "title": "LandingZoneConfigurationOperations_Create", + "operationId": "LandingZoneConfigurationOperations_Create", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC", + "resource": { + "properties": { + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_CreateCopy.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_CreateCopy.json new file mode 100644 index 000000000000..e7c04f7b2c5b --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_CreateCopy.json @@ -0,0 +1,26 @@ +{ + "title": "LandingZoneConfigurationOperations_CreateCopy", + "operationId": "LandingZoneConfigurationOperations_CreateCopy", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC", + "body": { + "name": "LandingZoneConfiguration" + } + }, + "responses": { + "200": { + "body": { + "copiedLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/Copy-ExampleLZC" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Delete.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Delete.json new file mode 100644 index 000000000000..c637d9048b45 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "LandingZoneConfigurationOperations_Delete", + "operationId": "LandingZoneConfigurationOperations_Delete", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_GenerateLandingZone.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_GenerateLandingZone.json new file mode 100644 index 000000000000..88c8c6c6db7a --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_GenerateLandingZone.json @@ -0,0 +1,38 @@ +{ + "title": "LandingZoneConfigurationOperations_GenerateLandingZone", + "operationId": "LandingZoneConfigurationOperations_GenerateLandingZone", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC", + "body": { + "infrastructureAsCodeOutputOptions": "Bicep", + "deploymentPrefix": "mcfs", + "topLevelMgDisplayName": "TestMG", + "deploymentLocation": "eastus", + "existingManagementSubscriptionId": "/subscriptions/49804ded-c8b8-43b2-8dba-bab9dd7d81e1", + "existingIdentitySubscriptionId": "/subscriptions/26211934-4ed9-4c30-b139-13bd61286867", + "existingConnectivitySubscriptionId": "/subscriptions/08a376df-4789-4920-9de8-cf6900b55968", + "subscriptionBillingScope": null, + "existingTopLevelMgParentId": null, + "deploymentSuffix": "test", + "organization": "test", + "environment": "QA" + } + }, + "responses": { + "200": { + "body": { + "topLevelMgDisplayName": "MCFS", + "landingZoneConfigurationName": "ExampleLZC" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Get.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Get.json new file mode 100644 index 000000000000..b0e2cbea75a6 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Get.json @@ -0,0 +1,118 @@ +{ + "title": "LandingZoneConfigurationOperations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "LandingZoneConfigurationOperations_Get", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "rgsovereign", + "landingZoneAccountName": "a-K18-78P-2c-33WD3e47yNxD5iwJ3-gB1C-PqU-6748-y85-c-Wu8", + "landingZoneConfigurationName": "Sj4K5xH1SJ-Ym35--O5-c8WGV7" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_ListByResourceGroup.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_ListByResourceGroup.json new file mode 100644 index 000000000000..9176f06c80a1 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_ListByResourceGroup.json @@ -0,0 +1,122 @@ +{ + "title": "LandingZoneConfigurationOperations_ListByResourceGroup", + "operationId": "LandingZoneConfigurationOperations_ListByResourceGroup", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_ListBySubscription.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_ListBySubscription.json new file mode 100644 index 000000000000..609d4d68f8f2 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_ListBySubscription.json @@ -0,0 +1,121 @@ +{ + "title": "LandingZoneConfigurationOperations_ListBySubscription", + "operationId": "LandingZoneConfigurationOperations_ListBySubscription", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Update.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Update.json new file mode 100644 index 000000000000..6360f3ee3bb1 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_Update.json @@ -0,0 +1,213 @@ +{ + "title": "LandingZoneConfigurationOperations_Update", + "operationId": "LandingZoneConfigurationOperations_Update", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC", + "properties": { + "properties": { + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "authoringStatus": "Authoring", + "ddosProtectionCreationOption": "Yes", + "logAnalyticsWorkspaceCreationOption": "No", + "firewallCreationOption": "Standard", + "logRetentionInDays": 540, + "hubNetworkCidrBlock": "10.20.255.0/24", + "azureBastionCreationOption": "Yes", + "existingDdosProtectionId": null, + "existingLogAnalyticsWorkspaceId": null, + "tags": [ + { + "name": "tag1", + "value": "do" + }, + { + "name": "tag2", + "value": "do" + } + ], + "firewallSubnetCidrBlock": "10.20.255.0/24", + "gatewaySubnetCidrBlock": "10.20.255.0/24", + "existingAzureBastionId": null, + "azureBastionSubnetCidrBlock": "10.20.255.0/24", + "landingZonesMgChildren": [ + { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "c138fd1a-e08f-4318-9490-d11ef2c2f9c1", + "assignmentParameters": {} + } + ], + "name": "Corp" + } + ], + "topLevelMgMetadata": { + "policyInitiativesAssignmentProperties": [ + { + "policyInitiativeId": "/providers/Microsoft.Authorization/policySetDefinitions/0a2ebd47-3fb9-4735-a006-b7f31ddadd9f", + "assignmentParameters": { + "Effect": "Audit" + } + } + ] + }, + "landingZonesMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformManagementMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformConnectivityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "platformIdentityMgMetadata": { + "policyInitiativesAssignmentProperties": [] + }, + "decommissionedMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": false + }, + "sandboxMgMetadata": { + "policyInitiativesAssignmentProperties": [], + "create": true + }, + "managedIdentity": { + "type": "SystemAssigned" + }, + "platformMgChildren": [ + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg1" + }, + { + "policyInitiativesAssignmentProperties": [], + "name": "childmg2" + } + ], + "namingConventionFormula": "{ResourceTypeAbbreviation}", + "customNamingConvention": [ + { + "formula": "{DeploymentSuffix}", + "resourceType": "azureFirewalls" + } + ] + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneConfigurations/lzctest", + "name": "lzctest", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_UpdateAuthoringStatus.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_UpdateAuthoringStatus.json new file mode 100644 index 000000000000..3850a08c7a3e --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneConfigurationOperations_UpdateAuthoringStatus.json @@ -0,0 +1,27 @@ +{ + "title": "LandingZoneConfigurationOperations_UpdateAuthoringStatus", + "operationId": "LandingZoneConfigurationOperations_UpdateAuthoringStatus", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneConfigurationName": "ExampleLZC", + "body": { + "authoringStatus": "Authoring" + } + }, + "responses": { + "200": { + "body": { + "landingZoneConfigurationName": "ExampleLZC", + "authoringStatus": "Authoring" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Create.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Create.json new file mode 100644 index 000000000000..fe42f2f85516 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Create.json @@ -0,0 +1,71 @@ +{ + "title": "LandingZoneRegistrationOperations_Create", + "operationId": "LandingZoneRegistrationOperations_Create", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneRegistrationName": "ExampleLZR", + "resource": { + "properties": { + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Delete.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Delete.json new file mode 100644 index 000000000000..21c85ca59382 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Delete.json @@ -0,0 +1,15 @@ +{ + "title": "LandingZoneRegistrationOperations_Delete", + "operationId": "LandingZoneRegistrationOperations_Delete", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneRegistrationName": "ExampleLZR" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Get.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Get.json new file mode 100644 index 000000000000..99d49492053b --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Get.json @@ -0,0 +1,36 @@ +{ + "title": "LandingZoneRegistrationOperations_Get", + "operationId": "LandingZoneRegistrationOperations_Get", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneRegistrationName": "ExampleLZR" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_ListByResourceGroup.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_ListByResourceGroup.json new file mode 100644 index 000000000000..10531be009bb --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_ListByResourceGroup.json @@ -0,0 +1,40 @@ +{ + "title": "LandingZoneRegistrationOperations_ListByResourceGroup", + "operationId": "LandingZoneRegistrationOperations_ListByResourceGroup", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_ListBySubscription.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_ListBySubscription.json new file mode 100644 index 000000000000..a7f6a391f546 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_ListBySubscription.json @@ -0,0 +1,39 @@ +{ + "title": "LandingZoneRegistrationOperations_ListBySubscription", + "operationId": "LandingZoneRegistrationOperations_ListBySubscription", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "landingZoneAccountName": "ExampleLZA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Update.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Update.json new file mode 100644 index 000000000000..aaf47ed5be3c --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/LandingZoneRegistrationOperations_Update.json @@ -0,0 +1,50 @@ +{ + "title": "LandingZoneRegistrationOperations_Update", + "operationId": "LandingZoneRegistrationOperations_Update", + "parameters": { + "api-version": "2025-02-27-preview", + "subscriptionId": "9B52DE5E-FE73-4C8B-8968-1E8F0097DDB8", + "resourceGroupName": "ExampleResourceGroup", + "landingZoneAccountName": "ExampleLZA", + "landingZoneRegistrationName": "ExampleLZR", + "properties": { + "properties": { + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "existingTopLevelMgId": "/providers/Microsoft.Management/managementGroups/mcfs", + "existingLandingZoneConfigurationId": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/ExampleLZA/landingZoneConfigurations/ExampleLZC", + "managedIdentity": { + "type": "SystemAssigned" + } + }, + "id": "/subscriptions/22b62f96-c8d5-4131-97f8-f820a5a3c55f/resourceGroups/TestResourceGroup/providers/Microsoft.Sovereign/landingZoneAccounts/LZAtestSI37/landingZoneRegistrations/ExampleLZR", + "name": "ExampleLZR", + "type": "microsoft.sovereign/landingzoneaccounts/landingzoneconfigurations", + "systemData": { + "createdBy": "example@example.com", + "createdByType": "User", + "createdAt": "2024-09-25T20:19:04.5255905Z", + "lastModifiedBy": "example@example.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-25T20:19:04.5255905Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/Operations_List.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/Operations_List.json new file mode 100644 index 000000000000..3a9f0ebb0bff --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/examples/Operations_List.json @@ -0,0 +1,286 @@ +{ + "title": "Operations_List_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-02-27-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Sovereign/Locations/operationstatuses/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "Locations/operationstatuses", + "operation": "read_operationstatuses", + "description": "read operationstatuses" + } + }, + { + "name": "Microsoft.Sovereign/Locations/operationstatuses/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "Locations/operationstatuses", + "operation": "write_operationstatuses", + "description": "write operationstatuses" + } + }, + { + "name": "Microsoft.Sovereign/checkNameAvailability/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "checkNameAvailability", + "operation": "action_checkNameAvailability", + "description": "action checkNameAvailability" + } + }, + { + "name": "Microsoft.Sovereign/Operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "Operations", + "operation": "read_Operations", + "description": "read Operations" + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_ListBySubscription", + "description": "Lists the landing zone accounts within a subscription." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_ListByResourceGroup", + "description": "Lists the landing zone accounts within a resource group." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_Get", + "description": "Gets the landing zone account." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_Create", + "description": "Creates the landing zone account." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_Delete", + "description": "Deletes the landing zone account." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts", + "operation": "LandingZoneAccountOperations_Update", + "description": "Updates the landing zone account." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_ListBySubscription", + "description": "Lists the landing zone configurations within a subscription." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_ListByResourceGroup", + "description": "Lists the landing zone configurations within a resource group." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_Get", + "description": "Gets the landing zone configuration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_Create", + "description": "Creates the landing zone configuration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_Delete", + "description": "Deletes the landing zone configuration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations", + "operation": "LandingZoneConfigurationOperations_Update", + "description": "Updates the landing zone configuration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/createCopy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations/createCopy", + "operation": "LandingZoneConfigurationOperations_CreateCopy", + "description": "Provides a mechanism to create a copy of the landing zone configuration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/generateLandingZone/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations/generateLandingZone", + "operation": "LandingZoneConfigurationOperations_GenerateLandingZone", + "description": "Generate the landing zone." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations/updateAuthoringStatus/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneConfigurations/updateAuthoringStatus", + "operation": "LandingZoneConfigurationOperations_UpdateAuthoringStatus", + "description": "Provides a mechanism to update the authoring status." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_ListBySubscription", + "description": "Lists the landing zone registrations within a subscription." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_ListByResourceGroup", + "description": "Lists the landing zone registrations within a resource group." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_Get", + "description": "Gets the landing zone registration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_Create", + "description": "Creates the landing zone registration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_Delete", + "description": "Deletes the landing zone registration." + } + }, + { + "name": "Microsoft.Sovereign/landingZoneAccounts/landingZoneRegistrations/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "landingZoneAccounts/landingZoneRegistrations", + "operation": "LandingZoneRegistrationOperations_Update", + "description": "Updates the landing zone registration." + } + }, + { + "name": "Microsoft.Sovereign/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "Microsoft.Sovereign", + "operation": "Register the Microsoft.Sovereign", + "description": "Register the subscription for Microsoft.Sovereign" + } + }, + { + "name": "Microsoft.Sovereign/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.Sovereign", + "resource": "Microsoft.Sovereign", + "operation": "Unregister the Microsoft.Sovereign", + "description": "Unregister the subscription for Microsoft.Sovereign" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/sovereign.json b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/sovereign.json new file mode 100644 index 000000000000..b7516da06fb3 --- /dev/null +++ b/specification/sovereign/resource-manager/Microsoft.Sovereign/preview/2025-02-27-preview/sovereign.json @@ -0,0 +1,2845 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cloud for Sovereignty Resource Provider.", + "version": "2025-02-27-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "LandingZoneAccountOperations" + }, + { + "name": "LandingZoneConfigurationOperations" + }, + { + "name": "LandingZoneRegistrationOperations" + } + ], + "paths": { + "/providers/Microsoft.Sovereign/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen - generated by [MaximumSet] rule": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Sovereign/landingZoneAccounts": { + "get": { + "operationId": "LandingZoneAccountOperations_ListBySubscription", + "tags": [ + "LandingZoneAccountOperations" + ], + "description": "Lists the landing zone accounts within a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneAccountResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneAccountOperations_ListBySubscription": { + "$ref": "./examples/LandingZoneAccountOperations_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations": { + "get": { + "operationId": "LandingZoneConfigurationOperations_ListBySubscription", + "tags": [ + "LandingZoneConfigurationOperations" + ], + "description": "Lists the landing zone configurations within a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneConfigurationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneConfigurationOperations_ListBySubscription": { + "$ref": "./examples/LandingZoneConfigurationOperations_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations": { + "get": { + "operationId": "LandingZoneRegistrationOperations_ListBySubscription", + "tags": [ + "LandingZoneRegistrationOperations" + ], + "description": "Lists the landing zone registrations within a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneRegistrationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneRegistrationOperations_ListBySubscription": { + "$ref": "./examples/LandingZoneRegistrationOperations_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts": { + "get": { + "operationId": "LandingZoneAccountOperations_ListByResourceGroup", + "tags": [ + "LandingZoneAccountOperations" + ], + "description": "Lists the landing zone accounts within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneAccountResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneAccountOperations_ListByResourceGroup_MaximumSet_Gen - generated by [MaximumSet] rule": { + "$ref": "./examples/LandingZoneAccountOperations_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}": { + "get": { + "operationId": "LandingZoneAccountOperations_Get", + "tags": [ + "LandingZoneAccountOperations" + ], + "description": "Gets the landing zone account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneAccountResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneAccountOperations_Get": { + "$ref": "./examples/LandingZoneAccountOperations_Get.json" + } + } + }, + "put": { + "operationId": "LandingZoneAccountOperations_Create", + "tags": [ + "LandingZoneAccountOperations" + ], + "description": "Creates the landing zone account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LandingZoneAccountResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LandingZoneAccountResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/LandingZoneAccountResource" + } + }, + "201": { + "description": "Resource 'LandingZoneAccountResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/LandingZoneAccountResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneAccountOperations_Create": { + "$ref": "./examples/LandingZoneAccountOperations_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LandingZoneAccountOperations_Update", + "tags": [ + "LandingZoneAccountOperations" + ], + "description": "Updates the landing zone account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LandingZoneAccountResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneAccountResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneAccountOperations_Update": { + "$ref": "./examples/LandingZoneAccountOperations_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LandingZoneAccountOperations_Delete", + "tags": [ + "LandingZoneAccountOperations" + ], + "description": "Deletes the landing zone account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneAccountOperations_Delete": { + "$ref": "./examples/LandingZoneAccountOperations_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations": { + "get": { + "operationId": "LandingZoneConfigurationOperations_ListByResourceGroup", + "tags": [ + "LandingZoneConfigurationOperations" + ], + "description": "Lists the landing zone configurations within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneConfigurationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneConfigurationOperations_ListByResourceGroup": { + "$ref": "./examples/LandingZoneConfigurationOperations_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}": { + "get": { + "operationId": "LandingZoneConfigurationOperations_Get", + "tags": [ + "LandingZoneConfigurationOperations" + ], + "description": "Gets the landing zone configuration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneConfigurationName", + "in": "path", + "description": "The landing zone configuration name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneConfigurationResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneConfigurationOperations_Get_MaximumSet_Gen - generated by [MaximumSet] rule": { + "$ref": "./examples/LandingZoneConfigurationOperations_Get.json" + } + } + }, + "put": { + "operationId": "LandingZoneConfigurationOperations_Create", + "tags": [ + "LandingZoneConfigurationOperations" + ], + "description": "Creates the landing zone configuration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneConfigurationName", + "in": "path", + "description": "The landing zone configuration name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LandingZoneConfigurationResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LandingZoneConfigurationResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/LandingZoneConfigurationResource" + } + }, + "201": { + "description": "Resource 'LandingZoneConfigurationResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/LandingZoneConfigurationResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneConfigurationOperations_Create": { + "$ref": "./examples/LandingZoneConfigurationOperations_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LandingZoneConfigurationOperations_Update", + "tags": [ + "LandingZoneConfigurationOperations" + ], + "description": "Updates the landing zone configuration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneConfigurationName", + "in": "path", + "description": "The landing zone configuration name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LandingZoneConfigurationResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneConfigurationResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneConfigurationOperations_Update": { + "$ref": "./examples/LandingZoneConfigurationOperations_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LandingZoneConfigurationOperations_Delete", + "tags": [ + "LandingZoneConfigurationOperations" + ], + "description": "Deletes the landing zone configuration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneConfigurationName", + "in": "path", + "description": "The landing zone configuration name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneConfigurationOperations_Delete": { + "$ref": "./examples/LandingZoneConfigurationOperations_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}/createCopy": { + "post": { + "operationId": "LandingZoneConfigurationOperations_CreateCopy", + "tags": [ + "LandingZoneConfigurationOperations" + ], + "description": "Provides a mechanism to create a copy of the landing zone configuration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneConfigurationName", + "in": "path", + "description": "The landing zone configuration name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/CreateLandingZoneConfigurationCopyRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CreateLandingZoneConfigurationCopyResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneConfigurationOperations_CreateCopy": { + "$ref": "./examples/LandingZoneConfigurationOperations_CreateCopy.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}/generateLandingZone": { + "post": { + "operationId": "LandingZoneConfigurationOperations_GenerateLandingZone", + "tags": [ + "LandingZoneConfigurationOperations" + ], + "description": "Generate the landing zone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneConfigurationName", + "in": "path", + "description": "The landing zone configuration name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateLandingZoneRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GenerateLandingZoneResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneConfigurationOperations_GenerateLandingZone": { + "$ref": "./examples/LandingZoneConfigurationOperations_GenerateLandingZone.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneConfigurations/{landingZoneConfigurationName}/updateAuthoringStatus": { + "post": { + "operationId": "LandingZoneConfigurationOperations_UpdateAuthoringStatus", + "tags": [ + "LandingZoneConfigurationOperations" + ], + "description": "Provides a mechanism to update the authoring status.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneConfigurationName", + "in": "path", + "description": "The landing zone configuration name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAuthoringStatusRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UpdateAuthoringStatusResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneConfigurationOperations_UpdateAuthoringStatus": { + "$ref": "./examples/LandingZoneConfigurationOperations_UpdateAuthoringStatus.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations": { + "get": { + "operationId": "LandingZoneRegistrationOperations_ListByResourceGroup", + "tags": [ + "LandingZoneRegistrationOperations" + ], + "description": "Lists the landing zone registrations within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneRegistrationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneRegistrationOperations_ListByResourceGroup": { + "$ref": "./examples/LandingZoneRegistrationOperations_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sovereign/landingZoneAccounts/{landingZoneAccountName}/landingZoneRegistrations/{landingZoneRegistrationName}": { + "get": { + "operationId": "LandingZoneRegistrationOperations_Get", + "tags": [ + "LandingZoneRegistrationOperations" + ], + "description": "Gets the landing zone registration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneRegistrationName", + "in": "path", + "description": "The name of the Landing Zone Registration resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneRegistrationResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneRegistrationOperations_Get": { + "$ref": "./examples/LandingZoneRegistrationOperations_Get.json" + } + } + }, + "put": { + "operationId": "LandingZoneRegistrationOperations_Create", + "tags": [ + "LandingZoneRegistrationOperations" + ], + "description": "Creates the landing zone registration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneRegistrationName", + "in": "path", + "description": "The name of the Landing Zone Registration resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LandingZoneRegistrationResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LandingZoneRegistrationResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/LandingZoneRegistrationResource" + } + }, + "201": { + "description": "Resource 'LandingZoneRegistrationResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/LandingZoneRegistrationResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneRegistrationOperations_Create": { + "$ref": "./examples/LandingZoneRegistrationOperations_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LandingZoneRegistrationOperations_Update", + "tags": [ + "LandingZoneRegistrationOperations" + ], + "description": "Updates the landing zone registration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneRegistrationName", + "in": "path", + "description": "The name of the Landing Zone Registration resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LandingZoneRegistrationResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LandingZoneRegistrationResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneRegistrationOperations_Update": { + "$ref": "./examples/LandingZoneRegistrationOperations_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LandingZoneRegistrationOperations_Delete", + "tags": [ + "LandingZoneRegistrationOperations" + ], + "description": "Deletes the landing zone registration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "landingZoneAccountName", + "in": "path", + "description": "The parent landing zone account", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + }, + { + "name": "landingZoneRegistrationName", + "in": "path", + "description": "The name of the Landing Zone Registration resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LandingZoneRegistrationOperations_Delete": { + "$ref": "./examples/LandingZoneRegistrationOperations_Delete.json" + } + } + } + } + }, + "definitions": { + "AuthoringStatus": { + "type": "string", + "description": "The authoring status for a landing zone configuration.", + "enum": [ + "Authoring", + "ReadyForUse", + "Disabled" + ], + "x-ms-enum": { + "name": "AuthoringStatus", + "modelAsString": true, + "values": [ + { + "name": "Authoring", + "value": "Authoring", + "description": "This is the default status when a create configuration request is made. In this state, the Landing Zone configuration can be updated." + }, + { + "name": "ReadyForUse", + "value": "ReadyForUse", + "description": "This status is set when the configuration changes are complete and the configuration is ready for code generation" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "This status is set when the landing zone configuration is no longer in use." + } + ] + } + }, + "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate": { + "type": "object", + "description": "Managed service identity (system assigned and/or user assigned identities)", + "properties": { + "type": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The identities assigned to this resource by the user.", + "additionalProperties": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" + } + ], + "type": "object", + "x-nullable": true + } + } + } + }, + "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": { + "type": "object", + "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "CreateCopyRequest": { + "type": "object", + "description": "The request for the create copy action of landing zone configuration.", + "properties": { + "name": { + "type": "string", + "description": "The name of the new landing zone configuration resource.", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + }, + "required": [ + "name" + ] + }, + "CreateCopyResponse": { + "type": "object", + "description": "The response of the create copy action of landing zone configuration.", + "properties": { + "copiedLandingZoneConfigurationId": { + "type": "string", + "format": "arm-id", + "description": "The id of the copied landing zone configuration resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Sovereign/landingZoneConfigurations" + } + ] + } + } + }, + "required": [ + "copiedLandingZoneConfigurationId" + ] + }, + "CreateLandingZoneConfigurationCopyRequest": { + "type": "object", + "description": "The request for the create copy action of landing zone configuration.", + "properties": { + "name": { + "type": "string", + "description": "The name of the new landing zone configuration resource.", + "pattern": "^[a-zA-Z0-9-]{3,64}$" + } + }, + "required": [ + "name" + ] + }, + "CreateLandingZoneConfigurationCopyResponse": { + "type": "object", + "description": "The response of the create copy action of landing zone configuration.", + "properties": { + "copiedLandingZoneConfigurationId": { + "type": "string", + "format": "arm-id", + "description": "The id of the copied landing zone configuration resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations" + } + ] + } + } + }, + "required": [ + "copiedLandingZoneConfigurationId" + ] + }, + "CustomNamingConvention": { + "type": "object", + "description": "The details for the custom resource override.", + "properties": { + "resourceType": { + "$ref": "#/definitions/ResourceType", + "description": "The type of the resource." + }, + "formula": { + "type": "string", + "description": "The custom formula for the resource type." + } + }, + "required": [ + "resourceType", + "formula" + ] + }, + "DecommissionedManagementGroupProperties": { + "type": "object", + "description": "Decommissioned management group properties.", + "properties": { + "policyInitiativesAssignmentProperties": { + "type": "array", + "description": "Array of initiative assignments to be applied to the management group.", + "items": { + "$ref": "#/definitions/PolicyInitiativeAssignmentProperties" + }, + "x-ms-identifiers": [] + }, + "create": { + "type": "boolean", + "description": "When set to false, this management group will not be created. The default value is false." + } + }, + "required": [ + "policyInitiativesAssignmentProperties", + "create" + ] + }, + "DecommissionedManagementGroupPropertiesUpdate": { + "type": "object", + "description": "Decommissioned management group properties.", + "properties": { + "policyInitiativesAssignmentProperties": { + "type": "array", + "description": "Array of initiative assignments to be applied to the management group.", + "items": { + "$ref": "#/definitions/PolicyInitiativeAssignmentProperties" + }, + "x-ms-identifiers": [] + }, + "create": { + "type": "boolean", + "description": "When set to false, this management group will not be created. The default value is false." + } + } + }, + "FirewallCreationOptions": { + "type": "string", + "description": "The input values for creating or using an existing firewall resource.", + "enum": [ + "None", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "FirewallCreationOptions", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Value when a firewall resource is not created." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Value when the firewall creation is based on the standard SKU." + }, + { + "name": "Premium", + "value": "Premium", + "description": "Value when the firewall creation is based on the premium SKU." + } + ] + } + }, + "GenerateLandingZoneRequest": { + "type": "object", + "description": "The request to generate code for a landing zone.", + "properties": { + "infrastructureAsCodeOutputOptions": { + "$ref": "#/definitions/InfrastructureAsCodeOutputOptions", + "description": "The export options available for code generation." + }, + "existingManagementSubscriptionId": { + "type": "string", + "format": "arm-id", + "description": "Management subscription fully qualified Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Subscription/aliases" + } + ] + } + }, + "existingIdentitySubscriptionId": { + "type": "string", + "format": "arm-id", + "description": "Identity subscription fully qualified Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Subscription/aliases" + } + ] + } + }, + "existingConnectivitySubscriptionId": { + "type": "string", + "format": "arm-id", + "description": "Connectivity subscription fully qualified Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Subscription/aliases" + } + ] + } + }, + "subscriptionBillingScope": { + "type": "string", + "description": "The full resource ID of billing scope associated to the EA, MCA or MPA account you wish to create the subscription in." + }, + "existingTopLevelMgParentId": { + "type": "string", + "format": "arm-id", + "description": "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.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Management/managementGroups" + } + ] + } + }, + "deploymentPrefix": { + "type": "string", + "description": "The prefix that will be added to all resources created by this deployment.", + "minLength": 2, + "maxLength": 5, + "pattern": "^([a-zA-Z0-9-]*)$" + }, + "deploymentSuffix": { + "type": "string", + "description": "The suffix that will be added to all resources created by this deployment.", + "minLength": 2, + "maxLength": 5 + }, + "topLevelMgDisplayName": { + "type": "string", + "description": "The top level management group display name.", + "minLength": 1, + "maxLength": 90 + }, + "deploymentLocation": { + "type": "string", + "description": "Location to run deployment(s) from the list of azure regions.", + "pattern": "^([a-zA-Z0-9]+)$" + }, + "organization": { + "type": "string", + "description": "The name of the organization or agency the landing zone is being deployed for." + }, + "environment": { + "type": "string", + "description": "The environment for which the landing zone is being deployed" + } + }, + "required": [ + "infrastructureAsCodeOutputOptions", + "deploymentPrefix", + "topLevelMgDisplayName", + "deploymentLocation" + ] + }, + "GenerateLandingZoneResponse": { + "type": "object", + "description": "The response for the request to generate landing zone code.", + "properties": { + "topLevelMgDisplayName": { + "type": "string", + "description": "The top level Management Group display name." + }, + "landingZoneConfigurationName": { + "type": "string", + "description": "The name of the Landing Zone configuration resource." + }, + "generatedCodeUrl": { + "type": "string", + "format": "password", + "description": "The url to access the generated code..", + "x-ms-secret": true + }, + "storageAccountName": { + "type": "string", + "format": "password", + "description": "The storage account name to access the generated code.", + "x-ms-secret": true + }, + "containerName": { + "type": "string", + "format": "password", + "description": "The storage account container to access the generated code.", + "x-ms-secret": true + }, + "blobName": { + "type": "string", + "format": "password", + "description": "The storage account blob name to access the generated code.", + "x-ms-secret": true + }, + "generatedArmTemplate": { + "type": "string", + "format": "password", + "description": "The generated code content as a json string.", + "x-ms-secret": true + } + }, + "required": [ + "topLevelMgDisplayName", + "landingZoneConfigurationName", + "generatedCodeUrl", + "storageAccountName", + "containerName", + "blobName" + ] + }, + "InfrastructureAsCodeOutputOptions": { + "type": "string", + "description": "Output options for landing zone code generation.", + "enum": [ + "Bicep", + "ARM" + ], + "x-ms-enum": { + "name": "InfrastructureAsCodeOutputOptions", + "modelAsString": true, + "values": [ + { + "name": "Bicep", + "value": "Bicep", + "description": "Value when generating Landing Zone code in Bicep." + }, + { + "name": "ARM", + "value": "ARM", + "description": "Value when generating landing zone code in Arm." + } + ] + } + }, + "LandingZoneAccountResource": { + "type": "object", + "description": "The Landing zone account parent resource type.", + "properties": { + "properties": { + "$ref": "#/definitions/LandingZoneAccountResourceProperties", + "description": "The resource-specific properties for this resource." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "LandingZoneAccountResourceListResult": { + "type": "object", + "description": "The response of a LandingZoneAccountResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LandingZoneAccountResource items on this page", + "items": { + "$ref": "#/definitions/LandingZoneAccountResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LandingZoneAccountResourceProperties": { + "type": "object", + "description": "The properties of landing zone account resource type.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/provisioningState", + "description": "The status of a user-initiated, control-plane operation on the landing zone account.", + "readOnly": true + }, + "storageAccount": { + "type": "string", + "format": "arm-id", + "description": "The storage account that will host the generated slz code.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + } + }, + "required": [ + "storageAccount" + ] + }, + "LandingZoneAccountResourcePropertiesUpdate": { + "type": "object", + "description": "The properties of landing zone account resource type.", + "properties": { + "storageAccount": { + "type": "string", + "format": "arm-id", + "description": "The storage account that will host the generated slz code.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + } + } + }, + "LandingZoneAccountResourceUpdate": { + "type": "object", + "description": "The Landing zone account parent resource type.", + "properties": { + "properties": { + "$ref": "#/definitions/LandingZoneAccountResourcePropertiesUpdate", + "description": "The resource-specific properties for this resource." + }, + "identity": { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" + } + ] + }, + "LandingZoneConfigurationResource": { + "type": "object", + "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/LandingZoneConfigurationResourceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "LandingZoneConfigurationResourceListResult": { + "type": "object", + "description": "The response of a LandingZoneConfigurationResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LandingZoneConfigurationResource items on this page", + "items": { + "$ref": "#/definitions/LandingZoneConfigurationResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LandingZoneConfigurationResourceProperties": { + "type": "object", + "description": "The properties of landing zone configuration resource type.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/provisioningState", + "description": "The status of a user-initiated, control-plane operation on the landing zone configuration.", + "readOnly": true + }, + "authoringStatus": { + "$ref": "#/definitions/AuthoringStatus", + "description": "The status for the landing zone configurations workflow.", + "readOnly": true + }, + "ddosProtectionCreationOption": { + "$ref": "#/definitions/ResourceCreationOptions", + "description": "To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan." + }, + "existingDdosProtectionId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the ddos protection plan.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/ddosProtectionPlans" + } + ] + } + }, + "logAnalyticsWorkspaceCreationOption": { + "$ref": "#/definitions/ResourceCreationOptions", + "description": "To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace." + }, + "existingLogAnalyticsWorkspaceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the log analytics workspace that was created to centralize log ingestion.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + } + }, + "tags": { + "type": "array", + "description": "Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}.", + "items": { + "$ref": "#/definitions/Tags" + }, + "x-ms-identifiers": [] + }, + "firewallCreationOption": { + "$ref": "#/definitions/FirewallCreationOptions", + "description": "To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one." + }, + "firewallSubnetCidrBlock": { + "type": "string", + "description": "Azure firewall subnet. IPv4 CIDR block." + }, + "gatewaySubnetCidrBlock": { + "type": "string", + "description": "Gateway subnet. IPv4 CIDR block." + }, + "logRetentionInDays": { + "type": "integer", + "format": "int64", + "description": "Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730", + "minimum": 30, + "maximum": 730 + }, + "hubNetworkCidrBlock": { + "type": "string", + "description": "The address space for the VNET. IPv4 CIDR block." + }, + "azureBastionCreationOption": { + "$ref": "#/definitions/ResourceCreationOptions", + "description": "To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service." + }, + "existingAzureBastionId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of azure bastion.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/bastionHosts" + } + ] + } + }, + "azureBastionSubnetCidrBlock": { + "type": "string", + "description": "Azure bastion subnet. IP v4 CIDR block." + }, + "landingZonesMgChildren": { + "type": "array", + "description": "Landing zone children management group properties", + "items": { + "$ref": "#/definitions/LandingZoneManagementGroupProperties" + }, + "x-ms-identifiers": [] + }, + "topLevelMgMetadata": { + "$ref": "#/definitions/ManagementGroupProperties", + "description": "This will be applied to the root of the landing zone deployment." + }, + "landingZonesMgMetadata": { + "$ref": "#/definitions/ManagementGroupProperties", + "description": "This will be applied to the landing zone management groups." + }, + "platformMgMetadata": { + "$ref": "#/definitions/ManagementGroupProperties", + "description": "This will be applied to the platform management group." + }, + "platformManagementMgMetadata": { + "$ref": "#/definitions/ManagementGroupProperties", + "description": "This will be applied to the management management group under platform." + }, + "platformConnectivityMgMetadata": { + "$ref": "#/definitions/ManagementGroupProperties", + "description": "This will be applied to the connectivity management group under platform." + }, + "platformIdentityMgMetadata": { + "$ref": "#/definitions/ManagementGroupProperties", + "description": "This will be applied to the identity management group under platform." + }, + "decommissionedMgMetadata": { + "$ref": "#/definitions/DecommissionedManagementGroupProperties", + "description": "This will be applied to the decommissioned management group." + }, + "sandboxMgMetadata": { + "$ref": "#/definitions/SandboxManagementGroupProperties", + "description": "This will be applied to the sandbox management group." + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentityProperties", + "description": "The managed identity to be tied to this landing zone configuration" + }, + "platformMgChildren": { + "type": "array", + "description": "Platform children management group properties.", + "items": { + "$ref": "#/definitions/PlatformManagementGroupProperties" + }, + "x-ms-identifiers": [] + }, + "namingConventionFormula": { + "type": "string", + "description": "The naming convention that's used by default for all resource types for this landing zone configuration" + }, + "customNamingConvention": { + "type": "array", + "description": "The customized naming convention for one or more resource types in this landing zone configuration", + "items": { + "$ref": "#/definitions/CustomNamingConvention" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "ddosProtectionCreationOption", + "logAnalyticsWorkspaceCreationOption", + "firewallCreationOption", + "gatewaySubnetCidrBlock", + "logRetentionInDays", + "hubNetworkCidrBlock", + "azureBastionCreationOption", + "managedIdentity" + ] + }, + "LandingZoneConfigurationResourcePropertiesUpdate": { + "type": "object", + "description": "The properties of landing zone configuration resource type.", + "properties": { + "ddosProtectionCreationOption": { + "$ref": "#/definitions/ResourceCreationOptions", + "description": "To deploy ddos, choose Yes, otherwise No. Select Existing to provide an existing ddos protection plan." + }, + "existingDdosProtectionId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the ddos protection plan.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/ddosProtectionPlans" + } + ] + } + }, + "logAnalyticsWorkspaceCreationOption": { + "$ref": "#/definitions/ResourceCreationOptions", + "description": "To deploy log analytics workspace, choose Yes, otherwise No. Select UseExisting to provide an existing log analytics workspace." + }, + "existingLogAnalyticsWorkspaceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the log analytics workspace that was created to centralize log ingestion.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + } + }, + "tags": { + "type": "array", + "description": "Array of tag objects in format of {'name':'a tag name', 'value':'a tag value'}.", + "items": { + "$ref": "#/definitions/Tags" + }, + "x-ms-identifiers": [] + }, + "firewallCreationOption": { + "$ref": "#/definitions/FirewallCreationOptions", + "description": "To deploy firewall, choose the Standard/Premium based on the desired SKU. Choose None for no firewall and UseExisting for a pre existing one." + }, + "firewallSubnetCidrBlock": { + "type": "string", + "description": "Azure firewall subnet. IPv4 CIDR block." + }, + "gatewaySubnetCidrBlock": { + "type": "string", + "description": "Gateway subnet. IPv4 CIDR block." + }, + "logRetentionInDays": { + "type": "integer", + "format": "int64", + "description": "Set how long logs are retained for, in days. Minimum length is 30 and maximum is 730", + "minimum": 30, + "maximum": 730 + }, + "hubNetworkCidrBlock": { + "type": "string", + "description": "The address space for the VNET. IPv4 CIDR block." + }, + "azureBastionCreationOption": { + "$ref": "#/definitions/ResourceCreationOptions", + "description": "To deploy the bastion service, choose Yes, otherwise No. Choose UseExisting for existing bastion service." + }, + "existingAzureBastionId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of azure bastion.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/bastionHosts" + } + ] + } + }, + "azureBastionSubnetCidrBlock": { + "type": "string", + "description": "Azure bastion subnet. IP v4 CIDR block." + }, + "landingZonesMgChildren": { + "type": "array", + "description": "Landing zone children management group properties", + "items": { + "$ref": "#/definitions/LandingZoneManagementGroupProperties" + }, + "x-ms-identifiers": [] + }, + "topLevelMgMetadata": { + "$ref": "#/definitions/ManagementGroupPropertiesUpdate", + "description": "This will be applied to the root of the landing zone deployment." + }, + "landingZonesMgMetadata": { + "$ref": "#/definitions/ManagementGroupPropertiesUpdate", + "description": "This will be applied to the landing zone management groups." + }, + "platformMgMetadata": { + "$ref": "#/definitions/ManagementGroupPropertiesUpdate", + "description": "This will be applied to the platform management group." + }, + "platformManagementMgMetadata": { + "$ref": "#/definitions/ManagementGroupPropertiesUpdate", + "description": "This will be applied to the management management group under platform." + }, + "platformConnectivityMgMetadata": { + "$ref": "#/definitions/ManagementGroupPropertiesUpdate", + "description": "This will be applied to the connectivity management group under platform." + }, + "platformIdentityMgMetadata": { + "$ref": "#/definitions/ManagementGroupPropertiesUpdate", + "description": "This will be applied to the identity management group under platform." + }, + "decommissionedMgMetadata": { + "$ref": "#/definitions/DecommissionedManagementGroupPropertiesUpdate", + "description": "This will be applied to the decommissioned management group." + }, + "sandboxMgMetadata": { + "$ref": "#/definitions/SandboxManagementGroupPropertiesUpdate", + "description": "This will be applied to the sandbox management group." + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentityPropertiesUpdate", + "description": "The managed identity to be tied to this landing zone configuration" + }, + "platformMgChildren": { + "type": "array", + "description": "Platform children management group properties.", + "items": { + "$ref": "#/definitions/PlatformManagementGroupProperties" + }, + "x-ms-identifiers": [] + }, + "namingConventionFormula": { + "type": "string", + "description": "The naming convention that's used by default for all resource types for this landing zone configuration" + }, + "customNamingConvention": { + "type": "array", + "description": "The customized naming convention for one or more resource types in this landing zone configuration", + "items": { + "$ref": "#/definitions/CustomNamingConvention" + }, + "x-ms-identifiers": [] + } + } + }, + "LandingZoneConfigurationResourceUpdate": { + "type": "object", + "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/LandingZoneConfigurationResourcePropertiesUpdate", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "LandingZoneManagementGroupProperties": { + "type": "object", + "description": "Landing zone management group properties.", + "properties": { + "policyInitiativesAssignmentProperties": { + "type": "array", + "description": "Array of initiative assignments to be applied to the management group.", + "items": { + "$ref": "#/definitions/PolicyInitiativeAssignmentProperties" + }, + "x-ms-identifiers": [] + }, + "name": { + "type": "string", + "description": "Management group name." + } + }, + "required": [ + "policyInitiativesAssignmentProperties", + "name" + ] + }, + "LandingZoneRegistrationResource": { + "type": "object", + "description": "The Landing Zone registration resource type", + "properties": { + "properties": { + "$ref": "#/definitions/LandingZoneRegistrationResourceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "LandingZoneRegistrationResourceListResult": { + "type": "object", + "description": "The response of a LandingZoneRegistrationResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LandingZoneRegistrationResource items on this page", + "items": { + "$ref": "#/definitions/LandingZoneRegistrationResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LandingZoneRegistrationResourceProperties": { + "type": "object", + "description": "The properties of landing zone registration resource type.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/provisioningState", + "description": "The status of a user-initiated, control-plane operation on the landing Zone registration resource type.", + "readOnly": true + }, + "existingTopLevelMgId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the top level management group", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Management/managementGroups" + } + ] + } + }, + "existingLandingZoneConfigurationId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the associated landing zone configuration.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations" + } + ] + } + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentityProperties", + "description": "The managed identity to be tied to this landing zone registration" + } + }, + "required": [ + "existingTopLevelMgId", + "existingLandingZoneConfigurationId", + "managedIdentity" + ] + }, + "LandingZoneRegistrationResourcePropertiesUpdate": { + "type": "object", + "description": "The properties of landing zone registration resource type.", + "properties": { + "existingTopLevelMgId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the top level management group", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Management/managementGroups" + } + ] + } + }, + "existingLandingZoneConfigurationId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the associated landing zone configuration.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Sovereign/landingZoneAccounts/landingZoneConfigurations" + } + ] + } + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentityPropertiesUpdate", + "description": "The managed identity to be tied to this landing zone registration" + } + } + }, + "LandingZoneRegistrationResourceUpdate": { + "type": "object", + "description": "The Landing Zone registration resource type", + "properties": { + "properties": { + "$ref": "#/definitions/LandingZoneRegistrationResourcePropertiesUpdate", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ManagedIdentityProperties": { + "type": "object", + "description": "The properties of managed identity.", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityResourceType", + "description": "The type of managed identity." + }, + "userAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the managed identity.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "ManagedIdentityPropertiesUpdate": { + "type": "object", + "description": "The properties of managed identity.", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityResourceType", + "description": "The type of managed identity." + }, + "userAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the managed identity.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + } + } + } + }, + "ManagedIdentityResourceType": { + "type": "string", + "description": "The authoring status for a landing zone configuration.", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityResourceType", + "modelAsString": true, + "values": [ + { + "name": "SystemAssigned", + "value": "SystemAssigned", + "description": "System assigned managed identity." + }, + { + "name": "UserAssigned", + "value": "UserAssigned", + "description": "User assigned managed identity." + } + ] + } + }, + "ManagementGroupProperties": { + "type": "object", + "description": "Details of the policy and initiatives associated with the management group.", + "properties": { + "policyInitiativesAssignmentProperties": { + "type": "array", + "description": "Array of initiative assignments to be applied to the management group.", + "items": { + "$ref": "#/definitions/PolicyInitiativeAssignmentProperties" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "policyInitiativesAssignmentProperties" + ] + }, + "ManagementGroupPropertiesUpdate": { + "type": "object", + "description": "Details of the policy and initiatives associated with the management group.", + "properties": { + "policyInitiativesAssignmentProperties": { + "type": "array", + "description": "Array of initiative assignments to be applied to the management group.", + "items": { + "$ref": "#/definitions/PolicyInitiativeAssignmentProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "PlatformManagementGroupProperties": { + "type": "object", + "description": "Platform management group properties.", + "properties": { + "policyInitiativesAssignmentProperties": { + "type": "array", + "description": "Array of initiative assignments to be applied to the management group.", + "items": { + "$ref": "#/definitions/PolicyInitiativeAssignmentProperties" + }, + "x-ms-identifiers": [] + }, + "name": { + "type": "string", + "description": "Management group name." + } + }, + "required": [ + "policyInitiativesAssignmentProperties", + "name" + ] + }, + "PolicyInitiativeAssignmentProperties": { + "type": "object", + "description": "Details of policy assignments", + "properties": { + "policyInitiativeId": { + "type": "string", + "description": "The fully qualified id of the policy initiative." + }, + "assignmentParameters": { + "type": "object", + "description": "The parameters for the assignment of policy initiatives.", + "additionalProperties": {} + } + }, + "required": [ + "policyInitiativeId", + "assignmentParameters" + ] + }, + "ResourceCreationOptions": { + "type": "string", + "description": "Options for resource creation.", + "enum": [ + "Yes", + "No", + "UseExisting" + ], + "x-ms-enum": { + "name": "ResourceCreationOptions", + "modelAsString": true, + "values": [ + { + "name": "Yes", + "value": "Yes", + "description": "Value to create a new resource." + }, + { + "name": "No", + "value": "No", + "description": "Value to not create a new resource." + }, + { + "name": "UseExisting", + "value": "UseExisting", + "description": "Value to use an existing resource." + } + ] + } + }, + "ResourceType": { + "type": "string", + "description": "The input values for defining resource types for naming conventions.", + "enum": [ + "azureFirewalls", + "workspaces", + "automationAccounts", + "dashboards", + "userAssignedIdentities", + "bastionHosts", + "ddosProtectionPlans", + "networkSecurityGroups", + "virtualNetworks", + "routeTables" + ], + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true, + "values": [ + { + "name": "azureFirewalls", + "value": "azureFirewalls", + "description": "Value when customer wants to provide custom naming convention for Azure Firewall." + }, + { + "name": "workspaces", + "value": "workspaces", + "description": "Value when customer wants to provide custom naming convention for Log Analytics workspace." + }, + { + "name": "automationAccounts", + "value": "automationAccounts", + "description": "Value when customer wants to provide custom naming convention for automation account." + }, + { + "name": "dashboards", + "value": "dashboards", + "description": "Value when customer wants to provide custom naming convention for dashboard." + }, + { + "name": "userAssignedIdentities", + "value": "userAssignedIdentities", + "description": "Value when customer wants to provide custom naming convention for managed identity." + }, + { + "name": "bastionHosts", + "value": "bastionHosts", + "description": "Value when customer wants to provide custom naming convention for Bastion." + }, + { + "name": "ddosProtectionPlans", + "value": "ddosProtectionPlans", + "description": "Value when customer wants to provide custom naming convention for DDoS protection plan." + }, + { + "name": "networkSecurityGroups", + "value": "networkSecurityGroups", + "description": "Value when customer wants to provide custom naming convention for Bastion NSG." + }, + { + "name": "virtualNetworks", + "value": "virtualNetworks", + "description": "Value when customer wants to provide custom naming convention for virtual network." + }, + { + "name": "routeTables", + "value": "routeTables", + "description": "Value when customer wants to provide custom naming convention for route table." + } + ] + } + }, + "SandboxManagementGroupProperties": { + "type": "object", + "description": "Sandbox management group properties.", + "properties": { + "policyInitiativesAssignmentProperties": { + "type": "array", + "description": "Array of initiative assignments to be applied to the management group.", + "items": { + "$ref": "#/definitions/PolicyInitiativeAssignmentProperties" + }, + "x-ms-identifiers": [] + }, + "create": { + "type": "boolean", + "description": "When set to false this management group will not be created. The default value is false." + } + }, + "required": [ + "policyInitiativesAssignmentProperties", + "create" + ] + }, + "SandboxManagementGroupPropertiesUpdate": { + "type": "object", + "description": "Sandbox management group properties.", + "properties": { + "policyInitiativesAssignmentProperties": { + "type": "array", + "description": "Array of initiative assignments to be applied to the management group.", + "items": { + "$ref": "#/definitions/PolicyInitiativeAssignmentProperties" + }, + "x-ms-identifiers": [] + }, + "create": { + "type": "boolean", + "description": "When set to false this management group will not be created. The default value is false." + } + } + }, + "Tags": { + "type": "object", + "description": "The details associated with tags.", + "properties": { + "name": { + "type": "string", + "description": "A tag name." + }, + "value": { + "type": "string", + "description": "A tag value." + } + }, + "required": [ + "name" + ] + }, + "UpdateAuthoringStatusRequest": { + "type": "object", + "description": "The request to update authoring status of a configuration.", + "properties": { + "authoringStatus": { + "$ref": "#/definitions/AuthoringStatus", + "description": "The value of the authoring status to be updated." + } + }, + "required": [ + "authoringStatus" + ] + }, + "UpdateAuthoringStatusResponse": { + "type": "object", + "description": "The response for the request to update authoring status.", + "properties": { + "landingZoneConfigurationName": { + "type": "string", + "description": "The name of the landing zone configuration resource." + }, + "authoringStatus": { + "$ref": "#/definitions/AuthoringStatus", + "description": "The value of the authoring status to be updated." + } + }, + "required": [ + "landingZoneConfigurationName", + "authoringStatus" + ] + }, + "provisioningState": { + "type": "string", + "description": "The custom provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The state of the resource when creating" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The state of the resource when updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The state of the resource when deleting" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/sovereign/resource-manager/readme.az.md b/specification/sovereign/resource-manager/readme.az.md new file mode 100644 index 000000000000..e0ce373403e2 --- /dev/null +++ b/specification/sovereign/resource-manager/readme.az.md @@ -0,0 +1,28 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: sovereign + namespace: azure.mgmt.sovereign + package-name: azure-mgmt-sovereign +az-output-folder: $(azure-cli-extension-folder)/src/sovereign +python-sdk-output-folder: "$(az-output-folder)/azext_sovereign/vendored_sdks/sovereign" +# add additional configuration here specific for Azure CLI +# refer to the faq.md for more details +``` + + + +This is for command modules that already in azure cli main repo. +``` yaml $(az) && $(target-mode) == 'core' +az: + extensions: sovereign + namespace: azure.mgmt.sovereign + package-name: azure-mgmt-sovereign +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/sovereign +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/sovereign" +``` \ No newline at end of file diff --git a/specification/sovereign/resource-manager/readme.cli.md b/specification/sovereign/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c6cf6ad37ea4 --- /dev/null +++ b/specification/sovereign/resource-manager/readme.cli.md @@ -0,0 +1 @@ +## CLI Common Settings for all the command line tools \ No newline at end of file diff --git a/specification/sovereign/resource-manager/readme.csharp.md b/specification/sovereign/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..68ba0b706c4d --- /dev/null +++ b/specification/sovereign/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.Sovereign + output-folder: $(csharp-sdks-folder)/sovereign/management/Microsoft.Sovereign/GeneratedProtocol +``` diff --git a/specification/sovereign/resource-manager/readme.go.md b/specification/sovereign/resource-manager/readme.go.md new file mode 100644 index 000000000000..0b7dcc3f6eef --- /dev/null +++ b/specification/sovereign/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/sovereign/armsovereign +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` diff --git a/specification/sovereign/resource-manager/readme.md b/specification/sovereign/resource-manager/readme.md new file mode 100644 index 000000000000..21e9308db8a5 --- /dev/null +++ b/specification/sovereign/resource-manager/readme.md @@ -0,0 +1,82 @@ +# sovereign + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for sovereign. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the sovereign. + +```yaml +title: Microsoft.Sovereign +openapi-type: arm +openapi-subtype: rpaas +tag: package-2025-02-27-preview +``` + +### Tag: package-2025-02-27-preview + +These settings apply only when `--tag=package-2025-02-27-preview` is specified on the command line. + +```yaml $(tag) == 'package-2025-02-27-preview' +input-file: + - Microsoft.Sovereign/preview/2025-02-27-preview/sovereign.json +suppressions: + - code: AvoidAnonymousTypes + reason: This error is caused by typespec inbuilt managed identity model. +``` +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions + - repo: azure-powershell +``` +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/sovereign/resource-manager/readme.python.md b/specification/sovereign/resource-manager/readme.python.md new file mode 100644 index 000000000000..a49ee3eaf5e4 --- /dev/null +++ b/specification/sovereign/resource-manager/readme.python.md @@ -0,0 +1,18 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-sovereign +namespace: azure.mgmt.sovereign +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/sovereign/azure-mgmt-sovereign/azure/mgmt/sovereign +``` diff --git a/specification/sovereign/resource-manager/readme.typescript.md b/specification/sovereign/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..cb761a8e5567 --- /dev/null +++ b/specification/sovereign/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-sovereign" + output-folder: "$(typescript-sdks-folder)/sdk/sovereign/arm-sovereign" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +``` From c00a0639ee161ed08a44cefca9eb43e78d0019cc Mon Sep 17 00:00:00 2001 From: Charles Lowell <10964656+chlowell@users.noreply.github.com> Date: Thu, 30 Jan 2025 13:07:52 -0800 Subject: [PATCH 2/3] Update Key Vault Service Attention mentionees (#32350) --- .github/policies/resourceManagement.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/policies/resourceManagement.yml b/.github/policies/resourceManagement.yml index 2020893ea957..04988c15013c 100644 --- a/.github/policies/resourceManagement.yml +++ b/.github/policies/resourceManagement.yml @@ -1182,9 +1182,10 @@ configuration: then: - mentionUsers: mentionees: - - RandalliLama - - schaabs - - jlichwa + - cheathamb36 + - chen-karen + - lgonsoulin + - vickm replyTemplate: Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc ${mentionees}. assignMentionees: False - if: From d96c4134c9184176a615fe0f2ad07355f2096d21 Mon Sep 17 00:00:00 2001 From: Lakshay Nagpal <139222088+ApnaLakshay@users.noreply.github.com> Date: Fri, 31 Jan 2025 09:35:22 +0530 Subject: [PATCH 3/3] documented unsupported in description (#32342) * documented unsupported in description * Added previosu versions too for unsupported doc --- .../preview/2021-04-01-preview/Maintenance.json | 2 +- .../preview/2021-09-01-preview/Maintenance.json | 2 +- .../preview/2022-07-01-preview/Maintenance.json | 2 +- .../preview/2022-11-01-preview/Maintenance.json | 2 +- .../preview/2023-09-01-preview/Maintenance.json | 4 ++-- .../preview/2023-10-01-preview/Maintenance.json | 6 +++--- .../stable/2023-04-01/Maintenance.json | 6 +++--- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/Maintenance.json index b11a8b5336fc..5fc6bd951402 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/Maintenance.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-04-01-preview/Maintenance.json @@ -1536,7 +1536,7 @@ "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment within a subscription", + "summary": "[UNSUPPORTED] Get configuration assignment within a subscription. This API is not implemented yet.", "operationId": "ConfigurationAssignmentsWithinSubscription_List", "consumes": [], "produces": [ diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-09-01-preview/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-09-01-preview/Maintenance.json index 0e4c43c7d0f5..ba9481827820 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-09-01-preview/Maintenance.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2021-09-01-preview/Maintenance.json @@ -1536,7 +1536,7 @@ "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment within a subscription", + "summary": "[UNSUPPORTED] Get configuration assignment within a subscription. This API is not implemented yet.", "operationId": "ConfigurationAssignmentsWithinSubscription_List", "consumes": [], "produces": [ diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2022-07-01-preview/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2022-07-01-preview/Maintenance.json index f7466d991542..c8536812dc64 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2022-07-01-preview/Maintenance.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2022-07-01-preview/Maintenance.json @@ -1536,7 +1536,7 @@ "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment within a subscription", + "summary": "[UNSUPPORTED] Get configuration assignment within a subscription. This API is not implemented yet.", "operationId": "ConfigurationAssignmentsWithinSubscription_List", "consumes": [], "produces": [ diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json index 154050b31062..23d894a6c1d6 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json @@ -1536,7 +1536,7 @@ "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment within a subscription", + "summary": "[UNSUPPORTED] Get configuration assignment within a subscription. This API is not implemented yet.", "operationId": "ConfigurationAssignmentsWithinSubscription_List", "consumes": [], "produces": [ diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json index d61a638be06e..75c3d3ed0970 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/Maintenance.json @@ -1658,7 +1658,7 @@ "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment within a subscription", + "summary": "[UNSUPPORTED] Get configuration assignment within a subscription. This API is not implemented yet.", "operationId": "ConfigurationAssignmentsWithinSubscription_List", "consumes": [], "produces": [ @@ -1701,7 +1701,7 @@ "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment", + "summary": "[UNSUPPORTED] Get configuration assignment. This API is not implemented yet.", "description": "Get configuration assignment for resource..", "operationId": "ConfigurationAssignmentsForSubscriptions_Get", "consumes": [ diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json index 6fb07ba2f545..06e05c8a74ec 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-10-01-preview/Maintenance.json @@ -1722,7 +1722,7 @@ "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment within a subscription", + "summary": "[UNSUPPORTED] Get configuration assignment within a subscription. This API is not implemented yet.", "operationId": "ConfigurationAssignmentsWithinSubscription_List", "consumes": [], "produces": [ @@ -1765,8 +1765,8 @@ "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment", - "description": "Get configuration assignment for resource..", + "summary": "[UNSUPPORTED] Get configuration assignment. This API is not implemented yet.", + "description": "Get configuration assignment for resource.", "operationId": "ConfigurationAssignmentsForSubscriptions_Get", "consumes": [ "application/json" diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json index 344528944bc5..ac2d367482e6 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json @@ -1473,7 +1473,7 @@ "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment within a subscription. This API is not implemented yet.", + "summary": "[UNSUPPORTED] Get configuration assignment within a subscription. This API is not implemented yet.", "operationId": "ConfigurationAssignmentsWithinSubscription_List", "consumes": [], "produces": [ @@ -1516,8 +1516,8 @@ "tags": [ "ConfigurationAssignments" ], - "summary": "Get configuration assignment", - "description": "Get configuration assignment for resource..", + "summary": "[UNSUPPORTED] Get configuration assignment. This API is not implemented yet.", + "description": "Get configuration assignment for resource.", "operationId": "ConfigurationAssignmentsForSubscriptions_Get", "consumes": [ "application/json"