Skip to content

Commit 5ecc352

Browse files
Merge pull request #112993 from jjbfour/updatemsidocs
update managed identity docs
2 parents ebd8967 + b523294 commit 5ecc352

File tree

2 files changed

+52
-58
lines changed

2 files changed

+52
-58
lines changed
25.3 KB
Loading

articles/azure-resource-manager/managed-applications/publish-managed-identity.md

Lines changed: 52 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ A Managed Application can be configured with Managed Identity through the [Creat
4848

4949
```json
5050
"outputs": {
51-
"managedIdentity": "[parse('{\"Type\":\"SystemAssigned\"}')]"
51+
"managedIdentity": { "Type": "SystemAssigned" }
5252
}
5353
```
5454

@@ -60,71 +60,65 @@ Below are some recommendations on when to use CreateUIDefinition for enabling Ma
6060
- The Managed Identity requires complex consumer input.
6161
- The Managed Identity is needed on creation of the Managed Application.
6262

63-
#### SystemAssigned CreateUIDefinition
63+
#### Managed Identity CreateUIDefinition control
6464

65-
A basic CreateUIDefinition that enables the SystemAssigned identity for the Managed Application.
65+
CreateUIDefinition supports a built-in [Managed Identity control](./microsoft-managedidentity-identityselector.md).
6666

6767
```json
6868
{
6969
"$schema": "https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#",
7070
"handler": "Microsoft.Azure.CreateUIDef",
71-
"version": "0.1.2-preview",
72-
"parameters": {
73-
"basics": [
74-
{}
75-
],
76-
"steps": [
77-
],
78-
"outputs": {
79-
"managedIdentity": "[parse('{\"Type\":\"SystemAssigned\"}')]"
80-
}
81-
}
82-
}
83-
```
84-
85-
#### UserAssigned CreateUIDefinition
86-
87-
A basic CreateUIDefinition that takes a **user-assigned identity** resource as input and enables the UserAssigned identity for the Managed Application.
88-
89-
```json
90-
{
91-
"$schema": "https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#",
92-
"handler": "Microsoft.Azure.CreateUIDef",
93-
"version": "0.1.2-preview",
94-
"parameters": {
95-
"basics": [
96-
{}
97-
],
98-
"steps": [
99-
{
100-
"name": "manageIdentity",
101-
"label": "Identity",
102-
"subLabel": {
103-
"preValidation": "Manage Identities",
104-
"postValidation": "Done"
105-
},
106-
"bladeTitle": "Identity",
107-
"elements": [
108-
{
109-
"name": "userAssignedText",
110-
"type": "Microsoft.Common.TextBox",
111-
"label": "User assigned managed identity",
112-
"defaultValue": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userassignedidentites/myuserassignedidentity",
113-
"visible": true
114-
}
115-
]
116-
}
117-
],
118-
"outputs": {
119-
"managedIdentity": "[parse(concat('{\"Type\":\"UserAssigned\",\"UserAssignedIdentities\":{',string(steps('manageIdentity').userAssignedText),':{}}}'))]"
120-
}
71+
"version": "0.0.1-preview",
72+
"parameters": {
73+
"basics": [],
74+
"steps": [
75+
{
76+
"name": "applicationSettings",
77+
"label": "Application Settings",
78+
"subLabel": {
79+
"preValidation": "Configure your application settings",
80+
"postValidation": "Done"
81+
},
82+
"bladeTitle": "Application Settings",
83+
"elements": [
84+
{
85+
"name": "appName",
86+
"type": "Microsoft.Common.TextBox",
87+
"label": "Managed application Name",
88+
"toolTip": "Managed application instance name",
89+
"visible": true
90+
},
91+
{
92+
"name": "appIdentity",
93+
"type": "Microsoft.ManagedIdentity.IdentitySelector",
94+
"label": "Managed Identity Configuration",
95+
"toolTip": {
96+
"systemAssignedIdentity": "Enable system assigned identity to grant the managed application access to additional existing resources.",
97+
"userAssignedIdentity": "Add user assigned identities to grant the managed application access to additional existing resources."
98+
},
99+
"defaultValue": {
100+
"systemAssignedIdentity": "Off"
101+
},
102+
"options": {
103+
"hideSystemAssignedIdentity": false,
104+
"hideUserAssignedIdentity": false,
105+
"readOnlySystemAssignedIdentity": false
106+
},
107+
"visible": true
108+
}
109+
]
110+
}
111+
],
112+
"outputs": {
113+
"applicationResourceName": "[steps('applicationSettings').appName]",
114+
"location": "[location()]",
115+
"managedIdentity": "[steps('applicationSettings').appIdentity]"
121116
}
117+
}
122118
}
123119
```
124120

125-
The CreateUIDefinition.json above generates a create user experience that has a textbox for a consumer to enter the **user-assigned identity** Azure resource ID. The generated experience would look like:
126-
127-
![Sample user-assigned identity CreateUIDefinition](./media/publish-managed-identity/user-assigned-identity.png)
121+
![Managed Identity CreateUIDefinition](./media/publish-managed-identity/msi-cuid.png)
128122

129123
### Using Azure Resource Manager templates
130124

@@ -197,7 +191,7 @@ A basic Azure Resource Manager template that deploys a Managed Application with
197191

198192
## Granting access to Azure resources
199193

200-
Once a Managed Application is granted an identity, it can be granted access to existing azure resources. This process can be done through the Access control (IAM) interface in the Azure portal. The name of the Managed Application or **user-assigned identity** can be searched to add a role assignment.
194+
Once a Managed Application is granted an identity, it can be granted access to existing Azure resources. This process can be done through the Access control (IAM) interface in the Azure portal. The name of the Managed Application or **user-assigned identity** can be searched to add a role assignment.
201195

202196
![Add role assignment for Managed Application](./media/publish-managed-identity/identity-role-assignment.png)
203197

@@ -212,7 +206,7 @@ Managed Identity can also be used to deploy a Managed Application that requires
212206

213207
When linking the deployment of the Managed Application to existing resources, both the existing Azure resource and a **user-assigned identity** with the applicable role assignment on that resource must be provided.
214208

215-
A sample CreateUIDefinition that requires two inputs: a network interface resource ID and a user assigned identity resource id.
209+
A sample CreateUIDefinition that requires two inputs: a network interface resource ID and a user assigned identity resource ID.
216210

217211
```json
218212
{

0 commit comments

Comments
 (0)