You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-resource-manager/managed-applications/microsoft-solutions-armapicontrol.md
+18-15Lines changed: 18 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: ArmApiControl UI element
3
-
description: Describes the Microsoft.Solutions.ArmApiControl UI element for Azure portal. Used for calling API operations.
3
+
description: Describes the Microsoft.Solutions.ArmApiControl UI element for Azure portal that's used to call API operations.
4
4
author: davidsmatlak
5
5
ms.author: davidsmatlak
6
6
ms.topic: conceptual
@@ -9,15 +9,15 @@ ms.date: 08/23/2022
9
9
10
10
# Microsoft.Solutions.ArmApiControl UI element
11
11
12
-
ArmApiControl lets you get results from an Azure Resource Manager API operation. Use the results to populate dynamic content in other controls.
12
+
The `ArmApiControl` gets results from an Azure Resource Manager API operation using GET or POST. You can use the results to populate dynamic content in other controls.
13
13
14
14
## UI sample
15
15
16
-
There's no UI for this control.
16
+
There's no UI for `ArmApiControl`.
17
17
18
18
## Schema
19
19
20
-
The following example shows the schema for this control:
20
+
The following example shows the control's schema.
21
21
22
22
```json
23
23
{
@@ -27,35 +27,37 @@ The following example shows the schema for this control:
27
27
"method": "{HTTP-method}",
28
28
"path": "{path-for-the-URL}",
29
29
"body": {
30
-
"key1": "val1",
31
-
"key2": "val2"
30
+
"key1": "value1",
31
+
"key2": "value2"
32
32
}
33
33
}
34
34
}
35
35
```
36
36
37
37
## Sample output
38
38
39
-
The control's output is not displayed to the user. Instead, the result of the operation is used in other controls.
39
+
The control's output isn't displayed to the user. Instead, the operation's results are used in other controls.
40
40
41
41
## Remarks
42
42
43
-
- The `request.method` property specifies the HTTP method. Only `GET` or `POST` are allowed.
44
-
- The `request.path` property specifies a URL that must be a relative path to an ARM endpoint. It can be a static path or can be constructed dynamically by referring output values of the other controls.
43
+
- The `request.method` property specifies the HTTP method. Only GET or POST are allowed.
44
+
- The `request.path` property specifies a URL that must be a relative path to an Azure Resource Manager endpoint. It can be a static path or can be constructed dynamically by referring output values of the other controls.
45
45
46
-
For example, an ARM call into `Microsoft.Network/expressRouteCircuits` resource provider:
46
+
For example, an Azure Resource Manager call into `Microsoft.Network/expressRouteCircuits` resource provider:
- The `request.body` property is optional. Use it to specify a JSON body that is sent with the request. The body can be static content or constructed dynamically by referring to output values from other controls.
53
53
54
54
## Example
55
55
56
-
In the following example, the `providersApi` element calls an API to get an array of provider objects.
56
+
In the following example, the `providersApi` element uses the `ArmApiControl` and calls an API to get an array of provider objects. The array is used to create a list of provider names.
57
57
58
-
The `allowedValues` property of the `providersDropDown` element is configured to get the names of the providers. It displays them in the dropdown list.
58
+
The `providersDropDown` element's `allowedValues` property is configured to get the names of the providers. The provider names are displayed in the dropdown list.
59
+
60
+
The `output` property `providerName` shows the provider name that was selected from the dropdown list. The output can be used to pass the value to a parameter in a managed application template.
59
61
60
62
```json
61
63
{
@@ -92,9 +94,10 @@ The `allowedValues` property of the `providersDropDown` element is configured to
92
94
}
93
95
```
94
96
95
-
For an example of using the `ArmApiControl`to check the availability of a resource name, see [Microsoft.Common.TextBox](microsoft-common-textbox.md).
97
+
For an example of the `ArmApiControl`that uses the `request.body` property, see the [Microsoft.Common.TextBox](microsoft-common-textbox.md) single-line example. That example checks the availability of a storage account name and returns a message if the name is unavailable.
96
98
97
99
## Next steps
98
100
99
-
- For an introduction to creating UI definitions, see [Getting started with CreateUiDefinition](create-uidefinition-overview.md).
101
+
- For an introduction to creating UI definitions, see [CreateUiDefinition.json for Azure managed application's create experience](create-uidefinition-overview.md).
100
102
- For a description of common properties in UI elements, see [CreateUiDefinition elements](create-uidefinition-elements.md).
103
+
- To learn more about functions like `map`, `basics`, and `parse`, see [CreateUiDefinition functions](create-uidefinition-functions.md).
0 commit comments