[Blueprints] Add a new example file for using user-assigned MSI (#6297)

* Update rest API examples with a user-assigned MSI request/response example * flatten the example structure * while there, update the subscriptionIds to generic subIds * one escaped
Azure · Jun 20, 2019 · 2f48d30 · 2f48d30
1 parent b115123
commit 2f48d30
Show file tree

Hide file tree

Showing 35 changed files with 159 additions and 75 deletions.
diff --git a/...r/Microsoft.Blueprint/preview/2017-11-11-preview/examples/BlueprintAssignment_Create.json b/...r/Microsoft.Blueprint/preview/2017-11-11-preview/examples/BlueprintAssignment_Create.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2017-11-11-preview",
-    "subscriptionId": "f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000",
     "assignmentName": "assignSimpleBlueprint",
     "assignment": {
       "identity": {
@@ -68,7 +68,7 @@
             }
           }
         },
-        "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
         "type": "Microsoft.Blueprint/Assignment",
         "name": "assignSimpleBlueprint"
       }

diff --git a/...r/Microsoft.Blueprint/preview/2017-11-11-preview/examples/BlueprintAssignment_Delete.json b/...r/Microsoft.Blueprint/preview/2017-11-11-preview/examples/BlueprintAssignment_Delete.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2017-11-11-preview",
-    "subscriptionId": "f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000",
     "assignmentName": "assignSimpleBlueprint"
   },
   "responses": {
@@ -38,7 +38,7 @@
             }
           }
         },
-        "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
         "type": "Microsoft.Blueprint/Assignment",
         "name": "assignSimpleBlueprint"
       }

diff --git a/...ager/Microsoft.Blueprint/preview/2017-11-11-preview/examples/BlueprintAssignment_Get.json b/...ager/Microsoft.Blueprint/preview/2017-11-11-preview/examples/BlueprintAssignment_Get.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2017-11-11-preview",
-    "subscriptionId": "f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000",
     "assignmentName": "assignSimpleBlueprint"
   },
   "responses": {
@@ -38,7 +38,7 @@
             }
           }
         },
-        "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
         "type": "Microsoft.Blueprint/Assignment",
         "name": "assignSimpleBlueprint"
       }

diff --git a/...ger/Microsoft.Blueprint/preview/2017-11-11-preview/examples/BlueprintAssignment_List.json b/...ger/Microsoft.Blueprint/preview/2017-11-11-preview/examples/BlueprintAssignment_List.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2017-11-11-preview",
-    "subscriptionId": "f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b"
+    "subscriptionId": "00000000-0000-0000-0000-000000000000"
   },
   "responses": {
     "200": {
@@ -39,7 +39,7 @@
                 }
               }
             },
-            "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
+            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
             "type": "Microsoft.Blueprint/Assignment",
             "name": "assignSimpleBlueprint"
           }

diff --git a/.../resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json b/.../resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json
@@ -42,9 +42,8 @@
         "operationId": "Assignments_CreateOrUpdate",
         "description": "Create or update a blueprint assignment.",
         "x-ms-examples": {
-          "Assignment": {
-            "$ref": "./examples/BlueprintAssignment_Create.json"
-          }
+          "Assignment with system-assigned managed identity": { "$ref": "./examples/BlueprintAssignment_Create_SystemAssignedMSI.json" },
+          "Assignment with user-assigned managed identity": { "$ref": "./examples/BlueprintAssignment_Create_UserAssignedMSI.json" } 
         },
         "parameters": [
           {

diff --git a/...osoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignmentOperation_Get.json b/...osoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignmentOperation_Get.json
@@ -1,14 +1,14 @@
 {
   "parameters": {
     "api-version": "2018-11-01-preview",
-    "scope": "subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
     "assignmentName": "assignSimpleBlueprint",
     "assignmentOperationName": "fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f"
   },
   "responses": {
     "200": {
       "body": {
-        "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/microsoft.blueprint/blueprintAssignments/assignSimpleBlueprint/assignmentOperations/fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.blueprint/blueprintAssignments/assignSimpleBlueprint/assignmentOperations/fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f",
         "type": "microsoft.blueprint/blueprintAssignments/operations",
         "name": "fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f",
         "properties": {
@@ -22,7 +22,7 @@
               "kind": "azureResource",
               "action": "put",
               "jobState": "succeeded",
-              "requestUri": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/microsoft.deployments/deployments/48432786-2f1b-4925-8032-a5d57bcb5b6e",
+              "requestUri": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.deployments/deployments/48432786-2f1b-4925-8032-a5d57bcb5b6e",
               "result": {
                 "resources": [
                   {

diff --git a/...soft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignmentOperation_List.json b/...soft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignmentOperation_List.json
@@ -1,15 +1,15 @@
 {
   "parameters": {
     "api-version": "2018-11-01-preview",
-    "scope": "subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
     "assignmentName": "assignSimpleBlueprint"
   },
   "responses": {
     "200": {
       "body": {
         "value": [
           {
-            "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/microsoft.blueprint/blueprintAssignments/assignSimpleBlueprint/assignmentOperations/fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f",
+            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.blueprint/blueprintAssignments/assignSimpleBlueprint/assignmentOperations/fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f",
             "type": "microsoft.blueprint/blueprintAssignments/operations",
             "name": "fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f",
             "properties": {
@@ -23,7 +23,7 @@
                   "kind": "azureResource",
                   "action": "put",
                   "jobState": "succeeded",
-                  "requestUri": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/microsoft.deployments/deployments/48432786-2f1b-4925-8032-a5d57bcb5b6e",
+                  "requestUri": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.deployments/deployments/48432786-2f1b-4925-8032-a5d57bcb5b6e",
                   "result": {
                     "resources": [
                       {

diff --git a/.../examples/BlueprintAssignment_Create.json → ...tAssignment_Create_SystemAssignedMSI.json b/.../examples/BlueprintAssignment_Create.json → ...tAssignment_Create_SystemAssignedMSI.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2017-11-11-preview",
-    "scope": "subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
     "assignmentName": "assignSimpleBlueprint",
     "assignment": {
       "identity": {
@@ -68,7 +68,7 @@
             }
           }
         },
-        "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
         "type": "Microsoft.Blueprint/Assignment",
         "name": "assignSimpleBlueprint"
       }

diff --git a/...print/preview/2018-11-01-preview/examples/BlueprintAssignment_Create_UserAssignedMSI.json b/...print/preview/2018-11-01-preview/examples/BlueprintAssignment_Create_UserAssignedMSI.json
@@ -0,0 +1,85 @@
+{
+  "parameters": {
+    "api-version": "2017-11-11-preview",
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
+    "assignmentName": "assignSimpleBlueprint",
+    "assignment": {
+      "identity": {
+        "type": "UserAssigned",
+        "userAssignedIdentities": {
+          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {}
+        }
+      },
+      "location": "eastus",
+      "properties": {
+        "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
+        "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
+        "parameters": {
+          "storageAccountType": {
+            "value": "Standard_LRS"
+          },
+          "costCenter": {
+            "value": "Contoso/Online/Shopping/Production"
+          },
+          "owners": {
+            "value": [
+              "[email protected]",
+              "[email protected]"
+            ]
+          }
+        },
+        "resourceGroups": {
+          "storageRG": {
+            "name": "defaultRG",
+            "location": "eastus"
+          }
+        }
+      }
+    }
+  },
+  "responses": {
+    "201": {
+      "body": {
+        "identity": {
+          "type": "UserAssigned",
+          "tenantId": "00000000-0000-0000-0000-000000000000",
+          "userAssignedIdentities": {
+            "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {
+              "principalId": "00000000-0000-0000-0000-000000000000",
+              "clientId": "00000000-0000-0000-0000-000000000000"
+            }
+          }
+        },
+        "location": "eastus",
+        "properties": {
+          "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
+          "provisioningState": "creating",
+          "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
+          "parameters": {
+            "storageAccountType": {
+              "value": "Standard_LRS"
+            },
+            "costCenter": {
+              "value": "Contoso/Online/Shopping/Production"
+            },
+            "owners": {
+              "value": [
+                "[email protected]",
+                "[email protected]"
+              ]
+            }
+          },
+          "resourceGroups": {
+            "storageRG": {
+              "name": "defaultRG",
+              "location": "eastus"
+            }
+          }
+        },
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
+        "type": "Microsoft.Blueprint/Assignment",
+        "name": "assignSimpleBlueprint"
+      }
+    }
+  }
+}
diff --git a/...r/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Delete.json b/...r/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Delete.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2017-11-11-preview",
-    "scope": "subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
     "assignmentName": "assignSimpleBlueprint"
   },
   "responses": {
@@ -38,7 +38,7 @@
             }
           }
         },
-        "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
         "type": "Microsoft.Blueprint/Assignment",
         "name": "assignSimpleBlueprint"
       }

diff --git a/...ager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Get.json b/...ager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Get.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2017-11-11-preview",
-    "scope": "subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
     "assignmentName": "assignSimpleBlueprint"
   },
   "responses": {
@@ -38,7 +38,7 @@
             }
           }
         },
-        "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
         "type": "Microsoft.Blueprint/Assignment",
         "name": "assignSimpleBlueprint"
       }

diff --git a/...ger/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_List.json b/...ger/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_List.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2017-11-11-preview",
-    "scope": "subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b"
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000"
   },
   "responses": {
     "200": {
@@ -39,7 +39,7 @@
                 }
               }
             },
-            "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
+            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
             "type": "Microsoft.Blueprint/Assignment",
             "name": "assignSimpleBlueprint"
           }

diff --git a/...anager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/WhoIsBlueprint_Action.json b/...anager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/WhoIsBlueprint_Action.json
@@ -1,13 +1,13 @@
 {
   "parameters": {
     "api-version": "2018-11-01-preview",
-    "scope": "subscriptions/{subscriptionId}",
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
     "assignmentName": "assignSimpleBlueprint"
   },
   "responses": {
     "200": {
       "body": {
-        "objectId": "00000000-0000-0000-0000-000000000000"
+        "objectId": "00000000-1111-0000-1111-000000000000"
       }
     }
   }

diff --git a/...int/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Create.json b/...int/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Create.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2018-11-01-preview",
-    "scope": "subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
     "blueprintName": "simpleBlueprint",
     "artifactName": "storageTemplate",
     "artifact": {
@@ -108,7 +108,7 @@
           }
         },
         "kind": "template",
-        "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
         "type": "Microsoft.Blueprint/blueprints/artifacts",
         "name": "storageTemplate"
       }

diff --git a/...int/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Delete.json b/...int/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Delete.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2018-11-01-preview",
-    "scope": "subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
     "blueprintName": "simpleBlueprint",
     "artifactName": "storageTemplate"
   },
@@ -57,7 +57,7 @@
           }
         },
         "kind": "template",
-        "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
         "type": "Microsoft.Blueprint/blueprints/artifacts",
         "name": "storageTemplate"
       }

diff --git a/...eprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Get.json b/...eprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Get.json
@@ -1,7 +1,7 @@
 {
   "parameters": {
     "api-version": "2018-11-01-preview",
-    "scope": "subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b",
+    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
     "blueprintName": "simpleBlueprint",
     "artifactName": "storageTemplate"
   },
@@ -57,7 +57,7 @@
           }
         },
         "kind": "template",
-        "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
         "type": "Microsoft.Blueprint/blueprints/artifacts",
         "name": "storageTemplate"
       }