Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ param provisionVMAgent bool = true
@description('Optional. Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.')
param enableAutomaticUpdates bool = true

@description('Optional. Specifies the time zone of the virtual machine. e.g. \'Pacific Standard Time\'. Possible values can be TimeZoneInfo.id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.')
@description('Optional. Specifies the time zone of the virtual machine. e.g. \'Pacific Standard Time\'. Possible values can be `TimeZoneInfo.id` value from time zones returned by `TimeZoneInfo.GetSystemTimeZones`.')
param timeZone string = ''

@description('Optional. Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - AdditionalUnattendContent object.')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ This module deploys one or multiple Virtual Machines.
| `securityType` | string | `''` | | Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings. |
| `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. |
| `tags` | object | `{object}` | | Tags of the resource. |
| `timeZone` | string | `''` | | Specifies the time zone of the virtual machine. e.g. 'Pacific Standard Time'. Possible values can be TimeZoneInfo.id value from time zones returned by TimeZoneInfo.GetSystemTimeZones. |
| `timeZone` | string | `''` | | Specifies the time zone of the virtual machine. e.g. 'Pacific Standard Time'. Possible values can be `TimeZoneInfo.id` value from time zones returned by `TimeZoneInfo.GetSystemTimeZones`. |
| `ultraSSDEnabled` | bool | `False` | | The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. |
| `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. |
| `vmComputerNamesTransformation` | string | `'none'` | `[none, uppercase, lowercase]` | Specifies whether the computer names should be transformed. The transformation is performed on all computer names. Available transformations are 'none' (Default), 'uppercase' and 'lowercase'. |
Expand Down
2 changes: 1 addition & 1 deletion modules/Microsoft.Batch/batchAccounts/deploy.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ param storageAccountId string
@description('Optional. The authentication mode which the Batch service will use to manage the auto-storage account.')
param storageAuthenticationMode string = 'StorageKeys'

@description('Optional. The reference to a user assigned identity associated with the Batch pool which a compute node will use.')
@description('Optional. The resource ID of a user assigned identity assigned to pools which have compute nodes that need access to auto-storage.')
param storageAccessIdentity string = ''

@allowed([
Expand Down
2 changes: 1 addition & 1 deletion modules/Microsoft.Batch/batchAccounts/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
| `poolAllocationMode` | string | `'BatchService'` | `[BatchService, UserSubscription]` | The allocation mode for creating pools in the Batch account. Determines which quota will be used. |
| `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. |
| `publicNetworkAccess` | string | `''` | `['', Disabled, Enabled]` | Whether or not public network access is allowed for this resource. For security reasons it should be disabled. If not specified, it will be disabled by default if private endpoints are set. |
| `storageAccessIdentity` | string | `''` | | The reference to a user assigned identity associated with the Batch pool which a compute node will use. |
| `storageAccessIdentity` | string | `''` | | The resource ID of a user assigned identity assigned to pools which have compute nodes that need access to auto-storage. |
| `storageAuthenticationMode` | string | `'StorageKeys'` | `[BatchAccountManagedIdentity, StorageKeys]` | The authentication mode which the Batch service will use to manage the auto-storage account. |
| `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. |
| `tags` | object | `{object}` | | Tags of the resource. |
Expand Down
4 changes: 2 additions & 2 deletions modules/Microsoft.Cache/redis/deploy.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -262,13 +262,13 @@ module redisCache_privateEndpoints '../../Microsoft.Network/privateEndpoints/dep
@description('The resource name.')
output name string = redisCache.name

@description('The resource id.')
@description('The resource ID.')
output resourceId string = redisCache.id

@description('The name of the resource group the Redis cache was created in.')
output resourceGroupName string = resourceGroup().name

@description('Redis host name.')
@description('Redis hostname.')
output hostName string = redisCache.properties.hostName

@description('Redis SSL port.')
Expand Down
4 changes: 2 additions & 2 deletions modules/Microsoft.Cache/redis/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,11 +308,11 @@ privateEndpoints: [

| Output Name | Type | Description |
| :-- | :-- | :-- |
| `hostName` | string | Redis host name. |
| `hostName` | string | Redis hostname. |
| `location` | string | The location the resource was deployed into. |
| `name` | string | The resource name. |
| `resourceGroupName` | string | The name of the resource group the Redis cache was created in. |
| `resourceId` | string | The resource id. |
| `resourceId` | string | The resource ID. |
| `sslPort` | int | Redis SSL port. |
| `subnetId` | string | The full resource ID of a subnet in a virtual network where the Redis cache was deployed in. |

Expand Down
2 changes: 1 addition & 1 deletion modules/Microsoft.Compute/disks/deploy.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ param logicalSectorSize int = 4096
@description('Optional. If create option is ImportSecure, this is the URI of a blob to be imported into VM guest state.')
param securityDataUri string = ''

@description('Optional. If create option is Copy, this is the ARM id of the source snapshot or disk.')
@description('Optional. If create option is Copy, this is the ARM ID of the source snapshot or disk.')
param sourceResourceId string = ''

@description('Optional. If create option is Import, this is the URI of a blob to be imported into a managed disk.')
Expand Down
2 changes: 1 addition & 1 deletion modules/Microsoft.Compute/disks/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This template deploys a disk
| `publicNetworkAccess` | string | `'Disabled'` | `[Disabled, Enabled]` | Policy for controlling export on the disk. |
| `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. |
| `securityDataUri` | string | `''` | | If create option is ImportSecure, this is the URI of a blob to be imported into VM guest state. |
| `sourceResourceId` | string | `''` | | If create option is Copy, this is the ARM id of the source snapshot or disk. |
| `sourceResourceId` | string | `''` | | If create option is Copy, this is the ARM ID of the source snapshot or disk. |
| `sourceUri` | string | `''` | | If create option is Import, this is the URI of a blob to be imported into a managed disk. |
| `storageAccountId` | string | `''` | | Required if create option is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. |
| `tags` | object | `{object}` | | Tags of the availability set resource. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ param provisionVMAgent bool = true
@description('Optional. Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.')
param enableAutomaticUpdates bool = true

@description('Optional. Specifies the time zone of the virtual machine. e.g. \'Pacific Standard Time\'. Possible values can be TimeZoneInfo.id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.')
@description('Optional. Specifies the time zone of the virtual machine. e.g. \'Pacific Standard Time\'. Possible values can be `TimeZoneInfo.id` value from time zones returned by `TimeZoneInfo.GetSystemTimeZones`.')
param timeZone string = ''

@description('Optional. Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - AdditionalUnattendContent object.')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ The following resources are required to be able to deploy this resource.
| `skuCapacity` | int | `1` | | The initial instance count of scale set VMs. |
| `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. |
| `tags` | object | `{object}` | | Tags of the resource. |
| `timeZone` | string | `''` | | Specifies the time zone of the virtual machine. e.g. 'Pacific Standard Time'. Possible values can be TimeZoneInfo.id value from time zones returned by TimeZoneInfo.GetSystemTimeZones. |
| `timeZone` | string | `''` | | Specifies the time zone of the virtual machine. e.g. 'Pacific Standard Time'. Possible values can be `TimeZoneInfo.id` value from time zones returned by `TimeZoneInfo.GetSystemTimeZones`. |
| `ultraSSDEnabled` | bool | `False` | | The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. |
| `upgradePolicyMode` | string | `'Manual'` | `[Automatic, Manual, Rolling]` | Specifies the mode of an upgrade to virtual machines in the scale set.' Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ; Automatic - All virtual machines in the scale set are automatically updated at the same time. - Automatic, Manual, Rolling. |
| `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. |
Expand Down
2 changes: 1 addition & 1 deletion modules/Microsoft.Compute/virtualMachines/deploy.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ param provisionVMAgent bool = true
@description('Optional. Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.')
param enableAutomaticUpdates bool = true

@description('Optional. Specifies the time zone of the virtual machine. e.g. \'Pacific Standard Time\'. Possible values can be TimeZoneInfo.id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.')
@description('Optional. Specifies the time zone of the virtual machine. e.g. \'Pacific Standard Time\'. Possible values can be `TimeZoneInfo.id` value from time zones returned by `TimeZoneInfo.GetSystemTimeZones`.')
param timeZone string = ''

@description('Optional. Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - AdditionalUnattendContent object.')
Expand Down
2 changes: 1 addition & 1 deletion modules/Microsoft.Compute/virtualMachines/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ This module deploys one Virtual Machine with one or multiple nics and optionally
| `securityType` | string | `''` | | Specifies the SecurityType of the virtual machine. It is set as TrustedLaunch to enable UefiSettings. |
| `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. |
| `tags` | object | `{object}` | | Tags of the resource. |
| `timeZone` | string | `''` | | Specifies the time zone of the virtual machine. e.g. 'Pacific Standard Time'. Possible values can be TimeZoneInfo.id value from time zones returned by TimeZoneInfo.GetSystemTimeZones. |
| `timeZone` | string | `''` | | Specifies the time zone of the virtual machine. e.g. 'Pacific Standard Time'. Possible values can be `TimeZoneInfo.id` value from time zones returned by `TimeZoneInfo.GetSystemTimeZones`. |
| `ultraSSDEnabled` | bool | `False` | | The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. |
| `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. |
| `vmComputerNamesTransformation` | string | `'none'` | `[lowercase, none, uppercase]` | Specifies whether the computer names should be transformed. The transformation is performed on all computer names. Available transformations are 'none' (Default), 'uppercase' and 'lowercase'. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ This module deploys a Machine Learning Services Workspace.
### Parameter Usage: `computes`

Array to specify the compute resources to create respectively attach.
In case you provide a resource id, it will attach the resource and ignore "properties". In this case "computeLocation", "sku", "systemAssignedIdentity", "userAssignedIdentities" as well as "tags" don't need to be provided respectively are being ignored.
In case you provide a resource ID, it will attach the resource and ignore "properties". In this case "computeLocation", "sku", "systemAssignedIdentity", "userAssignedIdentities" as well as "tags" don't need to be provided respectively are being ignored.
Attaching a compute is not idempotent and will fail in case you try to redeploy over an existing compute in AML. I.e. for the first run set "deploy" to true, and after successful deployment to false.
For more information see https://docs.microsoft.com/en-us/azure/templates/microsoft.machinelearningservices/workspaces/computes?tabs=bicep

Expand Down
6 changes: 3 additions & 3 deletions modules/Microsoft.Web/staticSites/deploy.bicep
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ param templateProperties object = {}
param provider string = 'None'

@secure()
@description('Optional. The Personal Access Token for accessing the GitHub repo.')
@description('Optional. The Personal Access Token for accessing the GitHub repository.')
param repositoryToken string = ''

@description('Optional. The name of the GitHub repo.')
@description('Optional. The name of the GitHub repository.')
param repositoryUrl string = ''

@description('Optional. The branch name of the GitHub repo.')
@description('Optional. The branch name of the GitHub repository.')
param branch string = ''

@description('Optional. Enables system assigned managed identity on the resource.')
Expand Down
10 changes: 5 additions & 5 deletions modules/Microsoft.Web/staticSites/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Static Web Sites `[Microsoft.Web/staticSites]`
# Static Web Apps `[Microsoft.Web/staticSites]`

This module deploys a Static Web Site.
This module deploys a Static Web App.

## Navigation

Expand Down Expand Up @@ -30,16 +30,16 @@ This module deploys a Static Web Site.
| Parameter Name | Type | Default Value | Allowed Values | Description |
| :-- | :-- | :-- | :-- | :-- |
| `allowConfigFileUpdates` | bool | `True` | | If config file is locked for this static web app. |
| `branch` | string | `''` | | The branch name of the GitHub repo. |
| `branch` | string | `''` | | The branch name of the GitHub repository. |
| `buildProperties` | object | `{object}` | | Build properties for the static site. |
| `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). |
| `enterpriseGradeCdnStatus` | string | `'Disabled'` | `[Disabled, Disabling, Enabled, Enabling]` | State indicating the status of the enterprise grade CDN serving traffic to the static web app. |
| `location` | string | `[resourceGroup().location]` | | Location to deploy static site. The following locations are supported: CentralUS, EastUS2, EastAsia, WestEurope, WestUS2. |
| `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. |
| `privateEndpoints` | array | `[]` | | Configuration details for private endpoints. For security reasons, it is recommended to use private endpoints whenever possible. |
| `provider` | string | `'None'` | | The provider that submitted the last deployment to the primary environment of the static site. |
| `repositoryToken` | secureString | `''` | | The Personal Access Token for accessing the GitHub repo. |
| `repositoryUrl` | string | `''` | | The name of the GitHub repo. |
| `repositoryToken` | secureString | `''` | | The Personal Access Token for accessing the GitHub repository. |
| `repositoryUrl` | string | `''` | | The name of the GitHub repository. |
| `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. |
| `sku` | string | `'Free'` | `[Free, Standard]` | Type of static site to deploy. |
| `stagingEnvironmentPolicy` | string | `'Enabled'` | `[Disabled, Enabled]` | State indicating whether staging environments are allowed or not allowed for a static web app. |
Expand Down