Skip to content

Commit faf94e3

Browse files
authored
Merge pull request #287474 from MicrosoftDocs/main
9/27 11:00 AM IST Publish
2 parents 283e45c + 04069cc commit faf94e3

File tree

51 files changed

+459
-129
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+459
-129
lines changed

articles/app-service/breadcrumb/toc.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ items:
99
- name: App Service
1010
tocHref: /azure/reliability/
1111
topicHref: /azure/app-service/index
12+
- name: App Service
13+
tocHref: /azure/developer/
14+
topicHref: /azure/app-service/index
1215
items:
1316
- name: Web Apps
1417
tocHref: /entra/fundamentals/

articles/azure-functions/functions-app-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ When using app settings, you should be aware of the following considerations:
2222

2323
+ Changes to function app settings require your function app to be restarted.
2424

25-
+ In setting names, double-underscore (`__`) and colon (`:`) are considered reserved values. Double-underscores are interpreted as hierarchical delimiters on both Windows and Linux, and colons are interpreted in the same way only on Linux. For example, the setting `AzureFunctionsWebHost__hostid=somehost_123456` would be interpreted as the following JSON object:
25+
+ In setting names, double-underscore (`__`) and colon (`:`) are considered reserved values. Double-underscores are interpreted as hierarchical delimiters on both Windows and Linux, and colons are interpreted in the same way only on Windows. For example, the setting `AzureFunctionsWebHost__hostid=somehost_123456` would be interpreted as the following JSON object:
2626

2727
```json
2828
"AzureFunctionsWebHost": {

articles/azure-functions/functions-bindings-timer.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Write-Host "PowerShell timer trigger function ran! TIME: $currentU
238238

239239
|Attribute property | Description|
240240
|---------|----------------------|
241-
|**Schedule**| A [CRON expression](#ncrontab-expressions) or a [TimeSpan](#timespan) value. A `TimeSpan` can be used only for a function app that runs on an App Service Plan. You can put the schedule expression in an app setting and set this property to the app setting name wrapped in **%** signs, as `%ScheduleAppSetting%`. |
241+
|**Schedule**| A [NCRONTAB expression](#ncrontab-expressions) or a [TimeSpan](#timespan) value. A `TimeSpan` can be used only for a function app that runs on an App Service Plan. You can put the schedule expression in an app setting and set this property to the app setting name wrapped in **%** signs, as `%ScheduleAppSetting%`. |
242242
|**RunOnStartup**| If `true`, the function is invoked when the runtime starts. For example, the runtime starts when the function app wakes up after going idle due to inactivity. when the function app restarts due to function changes, and when the function app scales out. *Use with caution.* **RunOnStartup** should rarely if ever be set to `true`, especially in production. |
243243
|**UseMonitor**| Set to `true` or `false` to indicate whether the schedule should be monitored. Schedule monitoring persists schedule occurrences to aid in ensuring the schedule is maintained correctly even when function app instances restart. If not set explicitly, the default is `true` for schedules that have a recurrence interval greater than or equal to 1 minute. For schedules that trigger more than once per minute, the default is `false`. |
244244

@@ -256,7 +256,7 @@ For Python v2 functions defined using a decorator, the following properties on t
256256
| Property | Description |
257257
|-------------|-----------------------------|
258258
| `arg_name` | The name of the variable that represents the timer object in function code. |
259-
| `schedule` | A [CRON expression](#ncrontab-expressions) or a [TimeSpan](#timespan) value. A `TimeSpan` can be used only for a function app that runs on an App Service Plan. You can put the schedule expression in an app setting and set this property to the app setting name wrapped in **%** signs, as in this example: "%ScheduleAppSetting%". |
259+
| `schedule` | A [NCRONTAB expression](#ncrontab-expressions) or a [TimeSpan](#timespan) value. A `TimeSpan` can be used only for a function app that runs on an App Service Plan. You can put the schedule expression in an app setting and set this property to the app setting name wrapped in **%** signs, as in this example: "%ScheduleAppSetting%". |
260260
| `run_on_startup` | If `true`, the function is invoked when the runtime starts. For example, the runtime starts when the function app wakes up after going idle due to inactivity. when the function app restarts due to function changes, and when the function app scales out. *Use with caution.* **runOnStartup** should rarely if ever be set to `true`, especially in production. |
261261
| `use_monitor` | Set to `true` or `false` to indicate whether the schedule should be monitored. Schedule monitoring persists schedule occurrences to aid in ensuring the schedule is maintained correctly even when function app instances restart. If not set explicitly, the default is `true` for schedules that have a recurrence interval greater than or equal to 1 minute. For schedules that trigger more than once per minute, the default is `false`. |
262262

@@ -290,7 +290,7 @@ The following table explains the properties that you can set on the `options` ob
290290

291291
| Property | Description |
292292
|---------|----------------------|
293-
|**schedule**| A [CRON expression](#ncrontab-expressions) or a [TimeSpan](#timespan) value. A `TimeSpan` can be used only for a function app that runs on an App Service Plan. You can put the schedule expression in an app setting and set this property to the app setting name wrapped in **%** signs, as in this example: "%ScheduleAppSetting%". |
293+
|**schedule**| A [NCRONTAB expression](#ncrontab-expressions) or a [TimeSpan](#timespan) value. A `TimeSpan` can be used only for a function app that runs on an App Service Plan. You can put the schedule expression in an app setting and set this property to the app setting name wrapped in **%** signs, as in this example: "%ScheduleAppSetting%". |
294294
|**runOnStartup**| If `true`, the function is invoked when the runtime starts. For example, the runtime starts when the function app wakes up after going idle due to inactivity. when the function app restarts due to function changes, and when the function app scales out. *Use with caution.* **runOnStartup** should rarely if ever be set to `true`, especially in production. |
295295
|**useMonitor**| Set to `true` or `false` to indicate whether the schedule should be monitored. Schedule monitoring persists schedule occurrences to aid in ensuring the schedule is maintained correctly even when function app instances restart. If not set explicitly, the default is `true` for schedules that have a recurrence interval greater than or equal to 1 minute. For schedules that trigger more than once per minute, the default is `false`. |
296296

@@ -303,7 +303,7 @@ The following table explains the binding configuration properties that you set i
303303
|**type** | Must be set to "timerTrigger". This property is set automatically when you create the trigger in the Azure portal.|
304304
|**direction** | Must be set to "in". This property is set automatically when you create the trigger in the Azure portal. |
305305
|**name** | The name of the variable that represents the timer object in function code. |
306-
|**schedule**| A [CRON expression](#ncrontab-expressions) or a [TimeSpan](#timespan) value. A `TimeSpan` can be used only for a function app that runs on an App Service Plan. You can put the schedule expression in an app setting and set this property to the app setting name wrapped in **%** signs, as in this example: "%ScheduleAppSetting%". |
306+
|**schedule**| A [NCRONTAB expression](#ncrontab-expressions) or a [TimeSpan](#timespan) value. A `TimeSpan` can be used only for a function app that runs on an App Service Plan. You can put the schedule expression in an app setting and set this property to the app setting name wrapped in **%** signs, as in this example: "%ScheduleAppSetting%". |
307307
|**runOnStartup**| If `true`, the function is invoked when the runtime starts. For example, the runtime starts when the function app wakes up after going idle due to inactivity. when the function app restarts due to function changes, and when the function app scales out. *Use with caution.* **runOnStartup** should rarely if ever be set to `true`, especially in production. |
308308
|**useMonitor**| Set to `true` or `false` to indicate whether the schedule should be monitored. Schedule monitoring persists schedule occurrences to aid in ensuring the schedule is maintained correctly even when function app instances restart. If not set explicitly, the default is `true` for schedules that have a recurrence interval greater than or equal to 1 minute. For schedules that trigger more than once per minute, the default is `false`. |
309309

@@ -320,7 +320,7 @@ The following table explains the binding configuration properties that you set i
320320
|**type** | Must be set to "timerTrigger". This property is set automatically when you create the trigger in the Azure portal.|
321321
|**direction** | Must be set to "in". This property is set automatically when you create the trigger in the Azure portal. |
322322
|**name** | The name of the variable that represents the timer object in function code. |
323-
|**schedule**| A [CRON expression](#ncrontab-expressions) or a [TimeSpan](#timespan) value. A `TimeSpan` can be used only for a function app that runs on an App Service Plan. You can put the schedule expression in an app setting and set this property to the app setting name wrapped in **%** signs, as in this example: "%ScheduleAppSetting%". |
323+
|**schedule**| A [NCRONTAB expression](#ncrontab-expressions) or a [TimeSpan](#timespan) value. A `TimeSpan` can be used only for a function app that runs on an App Service Plan. You can put the schedule expression in an app setting and set this property to the app setting name wrapped in **%** signs, as in this example: "%ScheduleAppSetting%". |
324324
|**runOnStartup**| If `true`, the function is invoked when the runtime starts. For example, the runtime starts when the function app wakes up after going idle due to inactivity. when the function app restarts due to function changes, and when the function app scales out. *Use with caution.* **runOnStartup** should rarely if ever be set to `true`, especially in production. |
325325
|**useMonitor**| Set to `true` or `false` to indicate whether the schedule should be monitored. Schedule monitoring persists schedule occurrences to aid in ensuring the schedule is maintained correctly even when function app instances restart. If not set explicitly, the default is `true` for schedules that have a recurrence interval greater than or equal to 1 minute. For schedules that trigger more than once per minute, the default is `false`. |
326326

@@ -406,18 +406,19 @@ Here are some examples of NCRONTAB expressions you can use for the timer trigger
406406

407407
> [!NOTE]
408408
> NCRONTAB expression supports both **five field** and **six field** format. The sixth field position is a value for seconds which is placed at the beginning of the expression.
409+
> If the CRON expression is invalid the Azure Portal Function Test will display a 404 error, if Application Insights is connected more details are logged there.
409410
410411
#### NCRONTAB time zones
411412

412-
The numbers in a CRON expression refer to a time and date, not a time span. For example, a 5 in the `hour` field refers to 5:00 AM, not every 5 hours.
413+
The numbers in a NCRONTAB expression refer to a time and date, not a time span. For example, a 5 in the `hour` field refers to 5:00 AM, not every 5 hours.
413414

414415
[!INCLUDE [functions-timezone](../../includes/functions-timezone.md)]
415416

416417
### TimeSpan
417418

418419
A `TimeSpan` can be used only for a function app that runs on an App Service Plan.
419420

420-
Unlike a CRON expression, a `TimeSpan` value specifies the time interval between each function invocation. When a function completes after running longer than the specified interval, the timer immediately invokes the function again.
421+
Unlike a NCRONTAB expression, a `TimeSpan` value specifies the time interval between each function invocation. When a function completes after running longer than the specified interval, the timer immediately invokes the function again.
421422

422423
Expressed as a string, the `TimeSpan` format is `hh:mm:ss` when `hh` is less than 24. When the first two digits are 24 or greater, the format is `dd:hh:mm`. Here are some examples:
423424

articles/azure-resource-manager/templates/best-practices.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Best practices for templates
33
description: Describes recommended approaches for authoring Azure Resource Manager templates (ARM templates). Offers suggestions to avoid common problems when using templates.
44
ms.topic: best-practice
55
ms.custom: devx-track-arm-template
6-
ms.date: 09/25/2024
6+
ms.date: 09/26/2024
77
---
88
# ARM template best practices
99

@@ -206,7 +206,7 @@ The following information can be helpful when you work with [resources](./syntax
206206
]
207207
```
208208

209-
For more details about comments and metadata see [Understand the structure and syntax of ARM templates](./syntax.md#comments-and-metadata).
209+
For more details about comments and metadata, see [Understand the structure and syntax of ARM templates](./syntax.md#comments-and-metadata).
210210

211211
* If you use a *public endpoint* in your template (such as an Azure Blob storage public endpoint), *don't hard-code* the namespace. Use the `reference` function to dynamically retrieve the namespace. You can use this approach to deploy the template to different public namespace environments without manually changing the endpoint in the template. Set the API version to the same version that you're using for the storage account in your template.
212212

@@ -293,11 +293,11 @@ The following information can be helpful when you work with [resources](./syntax
293293

294294
## Comments
295295

296-
In addition to the `comments` property, comments using the `//` syntax are supported. For more details about comments and metadata see [Understand the structure and syntax of ARM templates](./syntax.md#comments-and-metadata). You may choose to save JSON files that contain `//` comments using the `.jsonc` file extension, to indicate the JSON file contains comments. The ARM service will also accept comments in any JSON file including parameters files.
296+
In addition to the `comments` property, comments using the `//` syntax are supported. For more details about comments and metadata, see [Understand the structure and syntax of ARM templates](./syntax.md#comments-and-metadata). You may choose to save JSON files that contain `//` comments using the `.jsonc` file extension, to indicate the JSON file contains comments. The ARM service will also accept comments in any JSON file including parameters files.
297297

298298
## Visual Studio Code ARM Tools
299299

300-
Working with ARM templates is much easier with the Azure Resource Manager (ARM) Tools for Visual Studio Code. This extension provides language support, resource snippets, and resource auto-completion to help you create and validate Azure Resource Manager templates. To learn more and install the extension, see [Azure Resource Manager (ARM) Tools](https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools).
300+
Working with ARM templates is easier with the Azure Resource Manager (ARM) Tools for Visual Studio Code. This extension provides language support, resource snippets, and resource auto-completion to help you create and validate Azure Resource Manager templates. To learn more and install the extension, see [Azure Resource Manager (ARM) Tools](https://marketplace.visualstudio.com/items?itemName=msazurermtools.azurerm-vscode-tools).
301301

302302
## Use test toolkit
303303

articles/azure-resource-manager/templates/copy-resources.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Deploy multiple instances of resources
33
description: Use copy operation and arrays in an Azure Resource Manager template (ARM template) to deploy resource type many times.
44
ms.topic: how-to
55
ms.custom: devx-track-arm-template
6-
ms.date: 08/30/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Resource iteration in ARM templates
@@ -14,7 +14,6 @@ You can also use copy loop with [properties](copy-properties.md), [variables](co
1414

1515
If you need to specify whether a resource is deployed at all, see [condition element](conditional-resource-deployment.md).
1616

17-
1817
> [!TIP]
1918
> We recommend [Bicep](../bicep/overview.md) because it offers the same capabilities as ARM templates and the syntax is easier to use. To learn more, see [loops](../bicep/loops.md).
2019

articles/azure-resource-manager/templates/definitions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Type definitions in templates
33
description: Describes how to create type definitions in an Azure Resource Manager template (ARM template).
44
ms.topic: conceptual
55
ms.custom: devx-track-arm-template
6-
ms.date: 08/22/2023
6+
ms.date: 09/26/2024
77
---
88

99
# Type definitions in ARM templates
@@ -348,7 +348,6 @@ If the value is true, elements of the array whose index is greater than the larg
348348

349349
The nullable constraint indicates that the value may be `null` or omitted. See [Properties](#properties) for an example.
350350

351-
352351
## Description
353352

354353
You can add a description to a type definition to help users of your template understand the value to provide.

articles/azure-resource-manager/templates/deploy-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure deployment templates with Azure CLI – Azure Resource Manager | Microsoft Docs
33
description: Use Azure Resource Manager and Azure CLI to create and deploy resource groups to Azure. The resources are defined in an Azure deployment template.
44
ms.topic: how-to
5-
ms.date: 10/10/2023
5+
ms.date: 09/26/2024
66
ms.custom: devx-track-azurecli, seo-azure-cli, devx-track-arm-template
77
keywords: azure cli deploy arm template, create resource group azure, azure deployment template, deployment resources, arm template, azure arm template
88
---

articles/azure-resource-manager/templates/deploy-github-actions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Deploy Resource Manager templates by using GitHub Actions
33
description: Describes how to deploy Azure Resource Manager templates (ARM templates) by using GitHub Actions.
44
ms.topic: how-to
5-
ms.date: 06/23/2023
5+
ms.date: 09/26/2024
66
ms.custom: github-actions-azure, devx-track-arm-template
77
---
88

@@ -46,7 +46,7 @@ Add a Resource Manager template to your GitHub repository. This template creates
4646
https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json
4747
```
4848

49-
You can put the file anywhere in the repository. The workflow sample in the next section assumes the template file is named **azuredeploy.json**, and it is stored at the root of your repository.
49+
You can put the file anywhere in the repository. The workflow sample in the next section assumes the template file is named **azuredeploy.json**, and it's stored at the root of your repository.
5050

5151
## Create workflow
5252

@@ -94,7 +94,7 @@ The workflow file must be stored in the **.github/workflows** folder at the root
9494
The first section of the workflow file includes:
9595

9696
- **name**: The name of the workflow.
97-
- **on**: The name of the GitHub events that triggers the workflow. The workflow is trigger when there is a push event on the main branch, which modifies at least one of the two files specified. The two files are the workflow file and the template file.
97+
- **on**: The name of the GitHub events that triggers the workflow. The workflow is trigger when there's a push event on the main branch, which modifies at least one of the two files specified. The two files are the workflow file and the template file.
9898

9999
# [OpenID Connect](#tab/openid)
100100

@@ -135,7 +135,7 @@ The workflow file must be stored in the **.github/workflows** folder at the root
135135
The first section of the workflow file includes:
136136

137137
- **name**: The name of the workflow.
138-
- **on**: The name of the GitHub events that triggers the workflow. The workflow is trigger when there is a push event on the main branch, which modifies at least one of the two files specified. The two files are the workflow file and the template file.
138+
- **on**: The name of the GitHub events that triggers the workflow. The workflow is trigger when there's a push event on the main branch, which modifies at least one of the two files specified. The two files are the workflow file and the template file.
139139
---
140140

141141
1. Select **Start commit**.
@@ -146,7 +146,7 @@ Because the workflow is configured to be triggered by either the workflow file o
146146

147147
## Check workflow status
148148

149-
1. Select the **Actions** tab. You will see a **Create deployStorageAccount.yml** workflow listed. It takes 1-2 minutes to run the workflow.
149+
1. Select the **Actions** tab. You see a **Create deployStorageAccount.yml** workflow listed. It takes 1-2 minutes to run the workflow.
150150
1. Select the workflow to open it.
151151
1. Select **Run ARM deploy** from the menu to verify the deployment.
152152

0 commit comments

Comments
 (0)