Skip to content

Commit b6c09ad

Browse files
committed
updates content
1 parent 7bb66d7 commit b6c09ad

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

articles/azure-resource-manager/managed-applications/microsoft-solutions-armapicontrol.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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.
44
author: davidsmatlak
55
ms.author: davidsmatlak
66
ms.topic: conceptual
@@ -9,15 +9,15 @@ ms.date: 08/23/2022
99

1010
# Microsoft.Solutions.ArmApiControl UI element
1111

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.
1313

1414
## UI sample
1515

16-
There's no UI for this control.
16+
There's no UI for `ArmApiControl`.
1717

1818
## Schema
1919

20-
The following example shows the schema for this control:
20+
The following example shows the control's schema.
2121

2222
```json
2323
{
@@ -27,35 +27,37 @@ The following example shows the schema for this control:
2727
"method": "{HTTP-method}",
2828
"path": "{path-for-the-URL}",
2929
"body": {
30-
"key1": "val1",
31-
"key2": "val2"
30+
"key1": "value1",
31+
"key2": "value2"
3232
}
3333
}
3434
}
3535
```
3636

3737
## Sample output
3838

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.
4040

4141
## Remarks
4242

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.
4545

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:
4747

4848
```json
49-
"path": "subscriptions/<subid>/resourceGroup/<resourceGroupName>/providers/Microsoft.Network/expressRouteCircuits/<routecircuitName>/?api-version=2020-05-01"
49+
"path": "subscriptions/<subid>/resourceGroup/<resourceGroupName>/providers/Microsoft.Network/expressRouteCircuits/<routecircuitName>/?api-version=2022-01-01"
5050
```
5151

5252
- 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.
5353

5454
## Example
5555

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.
5757

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.
5961

6062
```json
6163
{
@@ -92,9 +94,10 @@ The `allowedValues` property of the `providersDropDown` element is configured to
9294
}
9395
```
9496

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.
9698

9799
## Next steps
98100

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).
100102
- 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

Comments
 (0)