Skip to content

Commit 21c77be

Browse files
committed
freshness updates
1 parent ca2d4f6 commit 21c77be

10 files changed

+77
-75
lines changed

articles/azure-resource-manager/managed-applications/microsoft-common-checkbox.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: CheckBox UI element
33
description: Describes the Microsoft.Common.CheckBox UI element for Azure portal. Enables users to select to check or uncheck an option.
44
ms.topic: reference
5-
ms.date: 07/09/2020
5+
ms.date: 06/21/2024
66
---
77

88
# Microsoft.Common.CheckBox UI element
99

10-
The CheckBox control lets users check or uncheck an option. The control returns **true** when the control is checked or **false** when not checked.
10+
The CheckBox control lets users check or uncheck an option. The control returns `true` when the control is checked or `false` when not checked.
1111

1212
## UI sample
1313

@@ -17,13 +17,13 @@ The CheckBox control lets users check or uncheck an option. The control returns
1717

1818
```json
1919
{
20-
"name": "legalAccept",
21-
"type": "Microsoft.Common.CheckBox",
22-
"label": "I agree to the terms and conditions.",
23-
"constraints": {
24-
"required": true,
25-
"validationMessage": "Please acknowledge the legal conditions."
26-
}
20+
"name": "legalAccept",
21+
"type": "Microsoft.Common.CheckBox",
22+
"label": "I agree to the terms and conditions.",
23+
"constraints": {
24+
"required": true,
25+
"validationMessage": "Please acknowledge the legal conditions."
26+
}
2727
}
2828
```
2929

@@ -35,9 +35,9 @@ true
3535

3636
## Remarks
3737

38-
When you set **required** to **true**, the user must select the checkbox. If the user doesn't select the checkbox, the validation message is displayed.
38+
When you set `required` to `true`, the user must select the checkbox. If the user doesn't select the checkbox, the validation message is displayed.
3939

4040
## Next steps
4141

42-
* For an introduction to creating UI definitions, see [Getting started with CreateUiDefinition](create-uidefinition-overview.md).
43-
* For a description of common properties in UI elements, see [CreateUiDefinition elements](create-uidefinition-elements.md).
42+
- For an introduction to creating UI definitions, see [Getting started with CreateUiDefinition](create-uidefinition-overview.md).
43+
- For a description of common properties in UI elements, see [CreateUiDefinition elements](create-uidefinition-elements.md).

articles/azure-resource-manager/managed-applications/microsoft-common-fileupload.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: FileUpload UI element
3-
description: Describes the Microsoft.Common.FileUpload UI element for Azure portal. Enables users need to upload files when deploying a managed application.
3+
description: Describes the Microsoft.Common.FileUpload UI element for Azure portal. Enables users who need to upload files when deploying a managed application.
44
ms.topic: reference
5-
ms.date: 09/05/2018
5+
ms.date: 06/21/2024
66
---
77

88
# Microsoft.Common.FileUpload UI element
@@ -37,13 +37,13 @@ A control that allows a user to specify one or more files to upload.
3737

3838
## Sample output
3939

40-
If options.multiple is false and options.uploadMode is file, then the output has the contents of the file as a JSON string:
40+
If `options.multiple` is `false` and `options.uploadMode` is `file`, then the output has the contents of the file as a JSON string:
4141

4242
```json
4343
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
4444
```
4545

46-
If options.multiple is true and`options.uploadMode is file, then the output has the contents of the files as a JSON array:
46+
If `options.multiple` is `true` and `options.uploadMode` is `file`, then the output has the contents of the files as a JSON array:
4747

4848
```json
4949
[
@@ -54,32 +54,33 @@ If options.multiple is true and`options.uploadMode is file, then the output has
5454
]
5555
```
5656

57-
If options.multiple is false and options.uploadMode is url, then the output has a URL as a JSON string:
57+
If `options.multiple` is `false` and `options.uploadMode` is `url`, then the output has a URL as a JSON string:
5858

5959
```json
60-
"https://myaccount.blob.core.windows.net/pictures/profile.jpg?sv=2013-08-15&st=2013-08-16&se=2013-08-17&sr=c&sp=r&rscd=file;%20attachment&rsct=binary &sig=YWJjZGVmZw%3d%3d&sig=a39%2BYozJhGp6miujGymjRpN8tsrQfLo9Z3i8IRyIpnQ%3d"
60+
"https://contoso.blob.core.windows.net/pictures/profile.jpg?sv=2013-08-15&st=2013-08-16&se=2013-08-17&sr=c&sp=r&rscd=file;%20attachment&rsct=binary &sig=YWJjZGVmZw%3d%3d&sig=a39%2BYozJhGp6miujGymjRpN8tsrQfLo9Z3i8IRyIpnQ%3d"
6161
```
6262

63-
If options.multiple is true and options.uploadMode is url, then the output has a list of URLs as a JSON array:
63+
If `options.multiple` is `true` and `options.uploadMode` is `url`, then the output has a list of URLs as a JSON array:
64+
6465
```json
6566
[
66-
"https://myaccount.blob.core.windows.net/pictures/profile1.jpg?sv=2013-08-15&st=2013-08-16&se=2013-08-17&sr=c&sp=r&rscd=file;%20attachment&rsct=binary &sig=YWJjZGVmZw%3d%3d&sig=a39%2BYozJhGp6miujGymjRpN8tsrQfLo9Z3i8IRyIpnQ%3d",
67-
"https://myaccount.blob.core.windows.net/pictures/profile2.jpg?sv=2013-08-15&st=2013-08-16&se=2013-08-17&sr=c&sp=r&rscd=file;%20attachment&rsct=binary &sig=YWJjZGVmZw%3d%3d&sig=a39%2BYozJhGp6miujGymjRpN8tsrQfLo9Z3i8IRyIpnQ%3d",
68-
"https://myaccount.blob.core.windows.net/pictures/profile3.jpg?sv=2013-08-15&st=2013-08-16&se=2013-08-17&sr=c&sp=r&rscd=file;%20attachment&rsct=binary &sig=YWJjZGVmZw%3d%3d&sig=a39%2BYozJhGp6miujGymjRpN8tsrQfLo9Z3i8IRyIpnQ%3d"
67+
"https://contoso.blob.core.windows.net/pictures/profile1.jpg?sv=2013-08-15&st=2013-08-16&se=2013-08-17&sr=c&sp=r&rscd=file;%20attachment&rsct=binary &sig=YWJjZGVmZw%3d%3d&sig=a39%2BYozJhGp6miujGymjRpN8tsrQfLo9Z3i8IRyIpnQ%3d",
68+
"https://contoso.blob.core.windows.net/pictures/profile2.jpg?sv=2013-08-15&st=2013-08-16&se=2013-08-17&sr=c&sp=r&rscd=file;%20attachment&rsct=binary &sig=YWJjZGVmZw%3d%3d&sig=a39%2BYozJhGp6miujGymjRpN8tsrQfLo9Z3i8IRyIpnQ%3d",
69+
"https://contoso.blob.core.windows.net/pictures/profile3.jpg?sv=2013-08-15&st=2013-08-16&se=2013-08-17&sr=c&sp=r&rscd=file;%20attachment&rsct=binary &sig=YWJjZGVmZw%3d%3d&sig=a39%2BYozJhGp6miujGymjRpN8tsrQfLo9Z3i8IRyIpnQ%3d"
6970
]
7071
```
7172

72-
When testing a CreateUiDefinition, some browsers (like Google Chrome) truncate URLs generated by the Microsoft.Common.FileUpload element in the browser console. You may need to right-click individual links to copy the full URLs.
73+
When you test a _CreateUiDefinition.json_, some browsers truncate URLs generated by the `Microsoft.Common.FileUpload` element in the browser console. You might need to right-click individual links to copy the full URLs.
7374

7475
## Remarks
7576

76-
- `constraints.accept` specifies the types of files that are shown in the browser's file dialog. See the [HTML5 specification](https://html.spec.whatwg.org/multipage/input.html#attr-input-accept) for allowed values. The default value is **null**.
77-
- If `options.multiple` is set to **true**, the user is allowed to select more than one file in the browser's file dialog. The default value is **false**.
78-
- This element supports uploading files in two modes based on the value of `options.uploadMode`. If **file** is specified, the output has the contents of the file as a blob. If **url** is specified, then the file is uploaded to a temporary location, and the output has the URL of the blob. Temporary blobs will be purged after 24 hours. The default value is **file**.
77+
- `constraints.accept` specifies the types of files that are shown in the browser's file dialog. See the [HTML5 specification](https://html.spec.whatwg.org/multipage/input.html#attr-input-accept) for allowed values. The default value is `null`.
78+
- If `options.multiple` is set to `true`, the user is allowed to select more than one file in the browser's file dialog. The default value is `false`.
79+
- This element supports uploading files in two modes based on the value of `options.uploadMode`. If `file` is specified, the output has the contents of the file as a blob. If `url` is specified, then the file is uploaded to a temporary location, and the output has the URL of the blob. Temporary blobs will be purged after 24 hours. The default value is `file`.
7980
- An uploaded file is protected. The output URL includes a [SAS token](../../storage/common/storage-sas-overview.md?toc=/azure/storage/blobs/toc.json) for accessing the file during deployment.
80-
- The value of `options.openMode` determines how the file is read. If the file is expected to be plain text, specify **text**; else, specify **binary**. The default value is **text**.
81-
- If `options.uploadMode` is set to **file** and `options.openMode` is set to **binary**, the output is base64-encoded.
82-
- `options.encoding` specifies the encoding to use when reading the file. The default value is **UTF-8**, and is used only when `options.openMode` is set to **text**.
81+
- The value of `options.openMode` determines how the file is read. If the file is expected to be plain text, specify `text` otherwise specify `binary`. The default value is `text`.
82+
- If `options.uploadMode` is set to `file` and `options.openMode` is set to `binary`, the output is base64-encoded.
83+
- `options.encoding` specifies the encoding to use when reading the file. The default value is `UTF-8`, and is used only when `options.openMode` is set to `text`.
8384

8485
## Next steps
8586

articles/azure-resource-manager/managed-applications/microsoft-common-passwordbox.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: PasswordBox UI element
33
description: Describes the Microsoft.Common.PasswordBox UI element for Azure portal. Enables users to provide a secret value when deploying managed applications.
44
ms.topic: reference
5-
ms.date: 06/27/2018
5+
ms.date: 06/21/2024
66
---
77

88
# Microsoft.Common.PasswordBox UI element
@@ -46,7 +46,7 @@ A control that can be used to provide and confirm a password.
4646

4747
- This element doesn't support the `defaultValue` property.
4848
- For implementation details of `constraints`, see [Microsoft.Common.TextBox](microsoft-common-textbox.md).
49-
- If `options.hideConfirmation` is set to **true**, the second text box for confirming the user's password is hidden. The default value is **false**.
49+
- If `options.hideConfirmation` is set to `true`, the second text box for confirming the user's password is hidden. The default value is `false`.
5050

5151
## Next steps
5252

articles/azure-resource-manager/managed-applications/microsoft-common-section.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Section UI element
33
description: Describes the Microsoft.Common.Section UI element for Azure portal. Use to group elements in the portal for deploying managed applications.
44
ms.topic: reference
5-
ms.date: 06/27/2018
5+
ms.date: 06/21/2024
66
---
77

88
# Microsoft.Common.Section UI element
@@ -42,6 +42,7 @@ A control that groups one or more elements under a heading.
4242
- This element doesn't support the `toolTip` property.
4343

4444
## Sample output
45+
4546
To access the output values of elements in `elements`, use the [basics()](create-ui-definition-referencing-functions.md#basics) or [steps()](create-ui-definition-referencing-functions.md#steps) functions and dot notation:
4647

4748
```json
@@ -52,5 +53,5 @@ Elements of type `Microsoft.Common.Section` have no output values themselves.
5253

5354
## Next steps
5455

55-
* For an introduction to creating UI definitions, see [Getting started with CreateUiDefinition](create-uidefinition-overview.md).
56-
* For a description of common properties in UI elements, see [CreateUiDefinition elements](create-uidefinition-elements.md).
56+
- For an introduction to creating UI definitions, see [Getting started with CreateUiDefinition](create-uidefinition-overview.md).
57+
- For a description of common properties in UI elements, see [CreateUiDefinition elements](create-uidefinition-elements.md).

articles/azure-resource-manager/managed-applications/microsoft-common-serviceprincipalselector.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ServicePrincipalSelector UI element
33
description: Describes the Microsoft.Common.ServicePrincipalSelector UI element for Azure portal. Provides a control to choose an application and a textbox to input a password or certificate thumbprint.
44
ms.topic: reference
5-
ms.date: 11/17/2020
5+
ms.date: 06/21/2024
66
---
77

88
# Microsoft.Common.ServicePrincipalSelector UI element
@@ -80,7 +80,7 @@ To use an existing application, choose **Select Existing** and then select **Mak
8080

8181
## Example
8282

83-
The following is an example of the `Microsoft.Common.ServicePrincipalSelector` control. The `defaultValue` property sets `principalId` to `<default guid>` as a placeholder for a default application identifier GUID.
83+
The following code is an example of the `Microsoft.Common.ServicePrincipalSelector` control. The `defaultValue` property sets `principalId` to `<default guid>` as a placeholder for a default application identifier GUID.
8484

8585
```json
8686
{
@@ -139,7 +139,7 @@ The following is an example of the `Microsoft.Common.ServicePrincipalSelector` c
139139

140140
## Example output
141141

142-
The `appId` is the Id of the application registration that you selected or created. The `objectId` is an array of object Ids for the service principals configured for the selected application registration.
142+
The `appId` is the ID of the application registration that you selected or created. The `objectId` is an array of object Ids for the service principals configured for the selected application registration.
143143

144144
When no selection is made from the control, the `newOrExisting` property value is **new**:
145145

articles/azure-resource-manager/managed-applications/microsoft-common-slider.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Slider UI element
33
description: Describes the Microsoft.Common.Slider UI element for Azure portal. Enables users to set a value from a range of options.
44
ms.topic: reference
5-
ms.date: 07/10/2020
5+
ms.date: 06/21/2024
66
---
77

88
# Microsoft.Common.Slider UI element
@@ -17,19 +17,19 @@ The Slider control lets users select from a range of allowed values.
1717

1818
```json
1919
{
20-
"name": "memorySize",
21-
"type": "Microsoft.Common.Slider",
22-
"min": 1,
23-
"max": 64,
24-
"label": "Memory",
25-
"subLabel": "MB",
26-
"defaultValue": 24,
27-
"showStepMarkers": false,
28-
"toolTip": "Pick the size in MB",
29-
"constraints": {
30-
"required": false
31-
},
32-
"visible": true
20+
"name": "memorySize",
21+
"type": "Microsoft.Common.Slider",
22+
"min": 1,
23+
"max": 64,
24+
"label": "Memory",
25+
"subLabel": "MB",
26+
"defaultValue": 24,
27+
"showStepMarkers": false,
28+
"toolTip": "Pick the size in MB",
29+
"constraints": {
30+
"required": false
31+
},
32+
"visible": true
3333
}
3434
```
3535

@@ -47,5 +47,5 @@ The Slider control lets users select from a range of allowed values.
4747

4848
## Next steps
4949

50-
* For an introduction to creating UI definitions, see [Getting started with CreateUiDefinition](create-uidefinition-overview.md).
51-
* For a description of common properties in UI elements, see [CreateUiDefinition elements](create-uidefinition-elements.md).
50+
- For an introduction to creating UI definitions, see [Getting started with CreateUiDefinition](create-uidefinition-overview.md).
51+
- For a description of common properties in UI elements, see [CreateUiDefinition elements](create-uidefinition-elements.md).

articles/azure-resource-manager/managed-applications/microsoft-compute-credentialscombo.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: CredentialsCombo UI element
33
description: Describes the Microsoft.Compute.CredentialsCombo UI element for Azure portal.
44
ms.topic: reference
5-
ms.date: 08/01/2022
5+
ms.date: 06/21/2024
66
---
77

88
# Microsoft.Compute.CredentialsCombo UI element
@@ -25,9 +25,9 @@ For Linux with **SSH public key** selected, the SSH key control is displayed:
2525

2626
The **SSH public key source** has three options:
2727

28-
- **Generate new key pair**: Provide a name to create a new SSH key pair in Azure.
29-
- **Use existing key stored in Azure**: Select an existing SSH public key that's stored in Azure.
30-
- **Use existing public key**: Use an SSH public key that you've already created. For example, an SSH public key that was created on a local computer.
28+
- **Generate new key pair**: Provide a name to create a new SSH key pair.
29+
- **Use existing key stored in Azure**: Select an existing SSH public key stored in Azure.
30+
- **Use existing public key**: Use an SSH public key that you already created. For example, an SSH public key that was created on a local computer.
3131

3232
:::image type="content" source="./media/managed-application-elements/microsoft-compute-credentialscombo-linux-key-options.png" alt-text="Screenshot of the credentials combo user-interface element with options for Linux SSH public key.":::
3333

@@ -117,7 +117,7 @@ If `osPlatform` is **Linux** and the user provided an SSH public key, the contro
117117
```
118118

119119
- When **Generate new key pair** is selected, the `sshPublicKey` property is empty. The reason is because on the **Review+Create** tab the keys are generated after you select **Create** and **Download private key and create resource**.
120-
- The `sshKeyName` property contains a name only when a new SSH key pair is generated in Azure or for a key that's already stored in Azure.
120+
- The `sshKeyName` property contains a name only when a new SSH key pair is generated in Azure or for a key already stored in Azure.
121121
- The `generateNewSshKey` is **false** when you use an existing key. When a new key pair is generated, the value is **true**.
122122

123123
## Remarks

articles/azure-resource-manager/managed-applications/microsoft-compute-sizeselector.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: SizeSelector UI element
33
description: Describes the Microsoft.Compute.SizeSelector UI element for Azure portal. Use for selecting the size of a virtual machine.
44
ms.topic: reference
5-
ms.date: 06/27/2018
5+
ms.date: 06/21/2024
66
---
77

88
# Microsoft.Compute.SizeSelector UI element
@@ -15,7 +15,7 @@ The user sees a selector with default values from the element definition.
1515

1616
![Microsoft.Compute.SizeSelector](./media/managed-application-elements/microsoft-compute-sizeselector.png)
1717

18-
After selecting the control, the user sees an expanded view of the available sizes.
18+
After the control is selected, the user sees an expanded view of the available sizes.
1919

2020
![Microsoft.Compute.SizeSelector expanded](./media/managed-application-elements/microsoft-compute-sizeselector-expanded.png)
2121

@@ -63,13 +63,13 @@ After selecting the control, the user sees an expanded view of the available siz
6363
- `recommendedSizes` should have at least one size. The first recommended size is used as the default. The list of available sizes isn't sorted by the recommended state. The user can select that column to sort by recommended state.
6464
- If a recommended size isn't available in the selected location, the size is automatically skipped. Instead, the next recommended size is used.
6565
- `constraints.allowedSizes` and `constraints.excludedSizes` are both optional, but can't be used simultaneously. The list of available sizes can be determined by calling [List available virtual machine sizes for a subscription](/rest/api/compute/resource-skus/list). Any size not specified in the `constraints.allowedSizes` is hidden, and any size not specified in `constraints.excludedSizes` is shown.
66-
- `osPlatform` must be specified, and can be either **Windows** or **Linux**. It's used to determine the hardware costs of the virtual machines.
67-
- `imageReference` is omitted for first-party images, but provided for third-party images. It's used to determine the software costs of the virtual machines.
66+
- `osPlatform` must be specified, and can be either **Windows** or **Linux**. The `osPlatform` is used to determine the hardware costs of the virtual machines.
67+
- `imageReference` is omitted for first-party images, but provided for third-party images. The `imageReference` is used to determine the software costs of the virtual machines.
6868
- `count` is used to set the appropriate multiplier for the element. It supports a static value, like **2**, or a dynamic value from another element, like `[steps('step1').vmCount]`. The default value is **1**.
6969
- The `numAvailabilityZonesRequired` can be 1, 2, or 3.
70-
- By default, `hideDiskTypeFilter` is **false**. The disk type filter enables the user to see all disk types or only SSD.
70+
- By default, `hideDiskTypeFilter` is `false`. The disk type filter enables the user to see all disk types or only SSD.
7171

7272
## Next steps
7373

74-
* For an introduction to creating UI definitions, see [Getting started with CreateUiDefinition](create-uidefinition-overview.md).
75-
* For a description of common properties in UI elements, see [CreateUiDefinition elements](create-uidefinition-elements.md).
74+
- For an introduction to creating UI definitions, see [Getting started with CreateUiDefinition](create-uidefinition-overview.md).
75+
- For a description of common properties in UI elements, see [CreateUiDefinition elements](create-uidefinition-elements.md).

0 commit comments

Comments
 (0)