From 34d356ece8d37c70b17860021362ee1c199f91e9 Mon Sep 17 00:00:00 2001 From: Erika Gressi Date: Sun, 8 May 2022 22:51:01 +0200 Subject: [PATCH 1/7] dot test --- arm/.global/global.module.tests.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/arm/.global/global.module.tests.ps1 b/arm/.global/global.module.tests.ps1 index 03b11009d5..839995381b 100644 --- a/arm/.global/global.module.tests.ps1 +++ b/arm/.global/global.module.tests.ps1 @@ -734,7 +734,7 @@ Describe 'Deployment template tests' -Tag Template { } - It "[] parameters' description shoud start with a one word category followed by a dot, a space and the actual description text." -TestCases $deploymentFolderTestCases { + It "[] parameters' description shoud start with a one word category followed by a dot, a space and the actual description text ending with a dot." -TestCases $deploymentFolderTestCases { param( $moduleFolderName, $templateContent @@ -750,7 +750,7 @@ Describe 'Deployment template tests' -Tag Template { $Paramdescoutput = $templateContent.parameters.Keys foreach ($Param in $Paramdescoutput) { $Data = ($templateContent.parameters.$Param.metadata).description - if ($Data -notmatch '^[a-zA-Z]+\. .+') { + if ($Data -notmatch '^[a-zA-Z]+\. .+\.$') { $IncorrectParameters += $Param } } From 3d0df6114400d477e710ba877ac00e545e64cc04 Mon Sep 17 00:00:00 2001 From: Erika Gressi Date: Mon, 9 May 2022 00:31:51 +0200 Subject: [PATCH 2/7] dot test roledef --- arm/Microsoft.Authorization/roleDefinitions/deploy.bicep | 4 ++-- arm/Microsoft.Authorization/roleDefinitions/readme.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/arm/Microsoft.Authorization/roleDefinitions/deploy.bicep b/arm/Microsoft.Authorization/roleDefinitions/deploy.bicep index ccaba2cd63..6077a89f45 100644 --- a/arm/Microsoft.Authorization/roleDefinitions/deploy.bicep +++ b/arm/Microsoft.Authorization/roleDefinitions/deploy.bicep @@ -12,10 +12,10 @@ param actions array = [] @sys.description('Optional. List of denied actions.') param notActions array = [] -@sys.description('Optional. List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes') +@sys.description('Optional. List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes.') param dataActions array = [] -@sys.description('Optional. List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes') +@sys.description('Optional. List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes.') param notDataActions array = [] @sys.description('Optional. The group ID of the Management Group where the Role Definition and Target Scope will be applied to. If not provided, will use the current scope for deployment.') diff --git a/arm/Microsoft.Authorization/roleDefinitions/readme.md b/arm/Microsoft.Authorization/roleDefinitions/readme.md index c47e0a0330..191a56c5da 100644 --- a/arm/Microsoft.Authorization/roleDefinitions/readme.md +++ b/arm/Microsoft.Authorization/roleDefinitions/readme.md @@ -28,13 +28,13 @@ This module deploys custom RBAC Role Definitions across the management group, su | :-- | :-- | :-- | :-- | | `actions` | array | `[]` | List of allowed actions. | | `assignableScopes` | array | `[]` | Role definition assignable scopes. If not provided, will use the current scope provided. | -| `dataActions` | array | `[]` | List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes | +| `dataActions` | array | `[]` | List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes. | | `description` | string | `''` | Description of the custom RBAC role to be created. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `location` | string | `[deployment().location]` | Location deployment metadata. | | `managementGroupId` | string | `[managementGroup().name]` | The group ID of the Management Group where the Role Definition and Target Scope will be applied to. If not provided, will use the current scope for deployment. | | `notActions` | array | `[]` | List of denied actions. | -| `notDataActions` | array | `[]` | List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes | +| `notDataActions` | array | `[]` | List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes. | | `resourceGroupName` | string | `''` | The name of the Resource Group where the Role Definition and Target Scope will be applied to. | | `subscriptionId` | string | `''` | The subscription ID where the Role Definition and Target Scope will be applied to. Use for both Subscription level and Resource Group Level. | From 0f8d4bded5f38b18b933390958dc40909a670a90 Mon Sep 17 00:00:00 2001 From: Erika Gressi Date: Sat, 14 May 2022 01:57:41 +0200 Subject: [PATCH 3/7] added missing dots to descriptions --- .../policyAssignments/deploy.bicep | 16 ++++----- .../managementGroup/deploy.bicep | 12 +++---- .../resourceGroup/deploy.bicep | 14 ++++---- .../subscription/deploy.bicep | 12 +++---- .../policyDefinitions/deploy.bicep | 10 +++--- .../managementGroup/deploy.bicep | 8 ++--- .../subscription/deploy.bicep | 10 +++--- .../policyExemptions/deploy.bicep | 8 ++--- .../managementGroup/deploy.bicep | 8 ++--- .../resourceGroup/deploy.bicep | 10 +++--- .../subscription/deploy.bicep | 8 ++--- .../policySetDefinitions/deploy.bicep | 8 ++--- .../managementGroup/deploy.bicep | 6 ++-- .../subscription/deploy.bicep | 8 ++--- .../roleAssignments/deploy.bicep | 10 +++--- .../managementGroup/deploy.bicep | 10 +++--- .../resourceGroup/deploy.bicep | 12 +++---- .../roleAssignments/subscription/deploy.bicep | 10 +++--- .../roleDefinitions/deploy.bicep | 6 ++-- .../managementGroup/deploy.bicep | 6 ++-- .../resourceGroup/deploy.bicep | 12 +++---- .../roleDefinitions/subscription/deploy.bicep | 10 +++--- .../automationAccounts/variables/deploy.bicep | 8 ++--- .../applicationgroups/deploy.bicep | 8 ++--- .../workspaces/deploy.bicep | 6 ++-- .../netAppAccounts/deploy.bicep | 4 +-- .../securityRules/deploy.bicep | 8 ++--- .../privateDnsZones/A/deploy.bicep | 2 +- .../privateDnsZones/AAAA/deploy.bicep | 2 +- .../privateDnsZones/CNAME/deploy.bicep | 2 +- .../privateDnsZones/MX/deploy.bicep | 2 +- .../privateDnsZones/SOA/deploy.bicep | 2 +- .../privateDnsZones/SRV/deploy.bicep | 2 +- .../privateDnsZones/TXT/deploy.bicep | 2 +- arm/Microsoft.Sql/servers/deploy.bicep | 2 +- .../vulnerabilityAssessments/deploy.bicep | 10 +++--- .../virtualMachinesMultiple/deploy.bicep | 34 +++++++++---------- 37 files changed, 154 insertions(+), 154 deletions(-) diff --git a/arm/Microsoft.Authorization/policyAssignments/deploy.bicep b/arm/Microsoft.Authorization/policyAssignments/deploy.bicep index 30cc798b6b..62801cb1d1 100644 --- a/arm/Microsoft.Authorization/policyAssignments/deploy.bicep +++ b/arm/Microsoft.Authorization/policyAssignments/deploy.bicep @@ -27,7 +27,7 @@ param identity string = 'SystemAssigned' @sys.description('Optional. The Resource ID for the user assigned identity to assign to the policy assignment.') param userAssignedIdentityId string = '' -@sys.description('Required. The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: \'/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11\'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition') +@sys.description('Required. The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: \'/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11\'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition.') param roleDefinitionIds array = [] @sys.description('Optional. The policy assignment metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') @@ -36,7 +36,7 @@ param metadata object = {} @sys.description('Optional. The messages that describe why a resource is non-compliant with the policy.') param nonComplianceMessage string = '' -@sys.description('Optional. The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce') +@sys.description('Optional. The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce.') @allowed([ 'Default' 'DoNotEnforce' @@ -46,13 +46,13 @@ param enforcementMode string = 'Default' @sys.description('Optional. The Target Scope for the Policy. The name of the management group for the policy assignment. If not provided, will use the current scope for deployment.') param managementGroupId string = managementGroup().name -@sys.description('Optional. The Target Scope for the Policy. The subscription ID of the subscription for the policy assignment') +@sys.description('Optional. The Target Scope for the Policy. The subscription ID of the subscription for the policy assignment.') param subscriptionId string = '' -@sys.description('Optional. The Target Scope for the Policy. The name of the resource group for the policy assignment') +@sys.description('Optional. The Target Scope for the Policy. The name of the resource group for the policy assignment.') param resourceGroupName string = '' -@sys.description('Optional. The policy excluded scopes') +@sys.description('Optional. The policy excluded scopes.') param notScopes array = [] @sys.description('Optional. Location for all resources.') @@ -140,13 +140,13 @@ module policyAssignment_rg 'resourceGroup/deploy.bicep' = if (!empty(resourceGro } } -@sys.description('Policy Assignment Name') +@sys.description('Policy Assignment Name.') output name string = empty(subscriptionId) && empty(resourceGroupName) ? policyAssignment_mg.outputs.name : (!empty(subscriptionId) && empty(resourceGroupName) ? policyAssignment_sub.outputs.name : policyAssignment_rg.outputs.name) -@sys.description('Policy Assignment principal ID') +@sys.description('Policy Assignment principal ID.') output principalId string = empty(subscriptionId) && empty(resourceGroupName) ? policyAssignment_mg.outputs.principalId : (!empty(subscriptionId) && empty(resourceGroupName) ? policyAssignment_sub.outputs.principalId : policyAssignment_rg.outputs.principalId) -@sys.description('Policy Assignment resource ID') +@sys.description('Policy Assignment resource ID.') output resourceId string = empty(subscriptionId) && empty(resourceGroupName) ? policyAssignment_mg.outputs.resourceId : (!empty(subscriptionId) && empty(resourceGroupName) ? policyAssignment_sub.outputs.resourceId : policyAssignment_rg.outputs.resourceId) @sys.description('The location the resource was deployed into.') diff --git a/arm/Microsoft.Authorization/policyAssignments/managementGroup/deploy.bicep b/arm/Microsoft.Authorization/policyAssignments/managementGroup/deploy.bicep index c4e2073351..70c6e10a0d 100644 --- a/arm/Microsoft.Authorization/policyAssignments/managementGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/policyAssignments/managementGroup/deploy.bicep @@ -28,7 +28,7 @@ param identity string = 'SystemAssigned' @sys.description('Optional. The Resource ID for the user assigned identity to assign to the policy assignment.') param userAssignedIdentityId string = '' -@sys.description('Required. The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: \'/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11\'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition') +@sys.description('Required. The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: \'/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11\'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition.') param roleDefinitionIds array = [] @sys.description('Optional. The policy assignment metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') @@ -37,7 +37,7 @@ param metadata object = {} @sys.description('Optional. The messages that describe why a resource is non-compliant with the policy.') param nonComplianceMessage string = '' -@sys.description('Optional. The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce') +@sys.description('Optional. The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce.') @allowed([ 'Default' 'DoNotEnforce' @@ -47,7 +47,7 @@ param enforcementMode string = 'Default' @sys.description('Optional. The Target Scope for the Policy. The name of the management group for the policy assignment. If not provided, will use the current scope for deployment.') param managementGroupId string = managementGroup().name -@sys.description('Optional. The policy excluded scopes') +@sys.description('Optional. The policy excluded scopes.') param notScopes array = [] @sys.description('Optional. Location for all resources.') @@ -107,13 +107,13 @@ resource roleAssignment 'Microsoft.Authorization/roleAssignments@2020-10-01-prev } }] -@sys.description('Policy Assignment Name') +@sys.description('Policy Assignment Name.') output name string = policyAssignment.name -@sys.description('Policy Assignment principal ID') +@sys.description('Policy Assignment principal ID.') output principalId string = identity == 'SystemAssigned' ? policyAssignment.identity.principalId : '' -@sys.description('Policy Assignment resource ID') +@sys.description('Policy Assignment resource ID.') output resourceId string = extensionResourceId(tenantResourceId('Microsoft.Management/managementGroups', managementGroupId), 'Microsoft.Authorization/policyAssignments', policyAssignment.name) @sys.description('The location the resource was deployed into.') diff --git a/arm/Microsoft.Authorization/policyAssignments/resourceGroup/deploy.bicep b/arm/Microsoft.Authorization/policyAssignments/resourceGroup/deploy.bicep index 5bb5b7ce02..0b7c233715 100644 --- a/arm/Microsoft.Authorization/policyAssignments/resourceGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/policyAssignments/resourceGroup/deploy.bicep @@ -28,7 +28,7 @@ param identity string = 'SystemAssigned' @sys.description('Optional. The Resource ID for the user assigned identity to assign to the policy assignment.') param userAssignedIdentityId string = '' -@sys.description('Required. The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: \'/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11\'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition') +@sys.description('Required. The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: \'/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11\'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition.') param roleDefinitionIds array = [] @sys.description('Optional. The policy assignment metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') @@ -37,14 +37,14 @@ param metadata object = {} @sys.description('Optional. The messages that describe why a resource is non-compliant with the policy.') param nonComplianceMessage string = '' -@sys.description('Optional. The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce') +@sys.description('Optional. The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce.') @allowed([ 'Default' 'DoNotEnforce' ]) param enforcementMode string = 'Default' -@sys.description('Optional. The policy excluded scopes') +@sys.description('Optional. The policy excluded scopes.') param notScopes array = [] @sys.description('Optional. Location for all resources.') @@ -109,16 +109,16 @@ resource roleAssignment 'Microsoft.Authorization/roleAssignments@2020-10-01-prev } }] -@sys.description('Policy Assignment Name') +@sys.description('Policy Assignment Name.') output name string = policyAssignment.name -@sys.description('Policy Assignment principal ID') +@sys.description('Policy Assignment principal ID.') output principalId string = identity == 'SystemAssigned' ? policyAssignment.identity.principalId : '' -@sys.description('Policy Assignment resource ID') +@sys.description('Policy Assignment resource ID.') output resourceId string = az.resourceId(subscriptionId, resourceGroupName, 'Microsoft.Authorization/policyAssignments', policyAssignment.name) -@sys.description('The name of the resource group the policy was assigned to') +@sys.description('The name of the resource group the policy was assigned to.') output resourceGroupName string = resourceGroup().name @sys.description('The location the resource was deployed into.') diff --git a/arm/Microsoft.Authorization/policyAssignments/subscription/deploy.bicep b/arm/Microsoft.Authorization/policyAssignments/subscription/deploy.bicep index c138f2e1c8..8d5bfe0b39 100644 --- a/arm/Microsoft.Authorization/policyAssignments/subscription/deploy.bicep +++ b/arm/Microsoft.Authorization/policyAssignments/subscription/deploy.bicep @@ -28,7 +28,7 @@ param identity string = 'SystemAssigned' @sys.description('Optional. The Resource ID for the user assigned identity to assign to the policy assignment.') param userAssignedIdentityId string = '' -@sys.description('Required. The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: \'/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11\'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition') +@sys.description('Required. The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: \'/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11\'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition.') param roleDefinitionIds array = [] @sys.description('Optional. The policy assignment metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') @@ -37,14 +37,14 @@ param metadata object = {} @sys.description('Optional. The messages that describe why a resource is non-compliant with the policy.') param nonComplianceMessage string = '' -@sys.description('Optional. The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce') +@sys.description('Optional. The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce.') @allowed([ 'Default' 'DoNotEnforce' ]) param enforcementMode string = 'Default' -@sys.description('Optional. The policy excluded scopes') +@sys.description('Optional. The policy excluded scopes.') param notScopes array = [] @sys.description('Optional. Location for all resources.') @@ -107,13 +107,13 @@ resource roleAssignment 'Microsoft.Authorization/roleAssignments@2020-10-01-prev } }] -@sys.description('Policy Assignment Name') +@sys.description('Policy Assignment Name.') output name string = policyAssignment.name -@sys.description('Policy Assignment principal ID') +@sys.description('Policy Assignment principal ID.') output principalId string = identity == 'SystemAssigned' ? policyAssignment.identity.principalId : '' -@sys.description('Policy Assignment resource ID') +@sys.description('Policy Assignment resource ID.') output resourceId string = subscriptionResourceId(subscriptionId, 'Microsoft.Authorization/policyAssignments', policyAssignment.name) @sys.description('The location the resource was deployed into.') diff --git a/arm/Microsoft.Authorization/policyDefinitions/deploy.bicep b/arm/Microsoft.Authorization/policyDefinitions/deploy.bicep index c88c0a795f..586a8cfdb2 100644 --- a/arm/Microsoft.Authorization/policyDefinitions/deploy.bicep +++ b/arm/Microsoft.Authorization/policyDefinitions/deploy.bicep @@ -27,13 +27,13 @@ param metadata object = {} @sys.description('Optional. The policy definition parameters that can be used in policy definition references.') param parameters object = {} -@sys.description('Required. The Policy Rule details for the Policy Definition') +@sys.description('Required. The Policy Rule details for the Policy Definition.') param policyRule object @sys.description('Optional. The group ID of the Management Group (Scope). If not provided, will use the current scope for deployment.') param managementGroupId string = managementGroup().name -@sys.description('Optional. The subscription ID of the subscription (Scope). Cannot be used with managementGroupId') +@sys.description('Optional. The subscription ID of the subscription (Scope). Cannot be used with managementGroupId.') param subscriptionId string = '' @sys.description('Optional. Location deployment metadata.') @@ -89,11 +89,11 @@ module policyDefinition_sub 'subscription/deploy.bicep' = if (!empty(subscriptio } } -@sys.description('Policy Definition Name') +@sys.description('Policy Definition Name.') output name string = empty(subscriptionId) ? policyDefinition_mg.outputs.name : policyDefinition_sub.outputs.name -@sys.description('Policy Definition resource ID') +@sys.description('Policy Definition resource ID.') output resourceId string = empty(subscriptionId) ? policyDefinition_mg.outputs.resourceId : policyDefinition_sub.outputs.resourceId -@sys.description('Policy Definition Role Definition IDs') +@sys.description('Policy Definition Role Definition IDs.') output roleDefinitionIds array = empty(subscriptionId) ? policyDefinition_mg.outputs.roleDefinitionIds : policyDefinition_sub.outputs.roleDefinitionIds diff --git a/arm/Microsoft.Authorization/policyDefinitions/managementGroup/deploy.bicep b/arm/Microsoft.Authorization/policyDefinitions/managementGroup/deploy.bicep index c577623b52..56b8b60419 100644 --- a/arm/Microsoft.Authorization/policyDefinitions/managementGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/policyDefinitions/managementGroup/deploy.bicep @@ -27,7 +27,7 @@ param metadata object = {} @sys.description('Optional. The policy definition parameters that can be used in policy definition references.') param parameters object = {} -@sys.description('Required. The Policy Rule details for the Policy Definition') +@sys.description('Required. The Policy Rule details for the Policy Definition.') param policyRule object @sys.description('Optional. The group ID of the Management Group. If not provided, will use the current scope for deployment.') @@ -65,11 +65,11 @@ resource policyDefinition 'Microsoft.Authorization/policyDefinitions@2021-06-01' } } -@sys.description('Policy Definition Name') +@sys.description('Policy Definition Name.') output name string = policyDefinition.name -@sys.description('Policy Definition resource ID') +@sys.description('Policy Definition resource ID.') output resourceId string = extensionResourceId(tenantResourceId('Microsoft.Management/managementGroups', managementGroupId), 'Microsoft.Authorization/policyDefinitions', policyDefinition.name) -@sys.description('Policy Definition Role Definition IDs') +@sys.description('Policy Definition Role Definition IDs.') output roleDefinitionIds array = (contains(policyDefinition.properties.policyRule.then, 'details') ? ((contains(policyDefinition.properties.policyRule.then.details, 'roleDefinitionIds') ? policyDefinition.properties.policyRule.then.details.roleDefinitionIds : [])) : []) diff --git a/arm/Microsoft.Authorization/policyDefinitions/subscription/deploy.bicep b/arm/Microsoft.Authorization/policyDefinitions/subscription/deploy.bicep index 46b723022f..f2427616a2 100644 --- a/arm/Microsoft.Authorization/policyDefinitions/subscription/deploy.bicep +++ b/arm/Microsoft.Authorization/policyDefinitions/subscription/deploy.bicep @@ -27,10 +27,10 @@ param metadata object = {} @sys.description('Optional. The policy definition parameters that can be used in policy definition references.') param parameters object = {} -@sys.description('Required. The Policy Rule details for the Policy Definition') +@sys.description('Required. The Policy Rule details for the Policy Definition.') param policyRule object -@sys.description('Optional. The subscription ID of the subscription') +@sys.description('Optional. The subscription ID of the subscription.') param subscriptionId string = subscription().subscriptionId @sys.description('Optional. Location deployment metadata.') @@ -65,11 +65,11 @@ resource policyDefinition 'Microsoft.Authorization/policyDefinitions@2021-06-01' } } -@sys.description('Policy Definition Name') +@sys.description('Policy Definition Name.') output name string = policyDefinition.name -@sys.description('Policy Definition resource ID') +@sys.description('Policy Definition resource ID.') output resourceId string = subscriptionResourceId(subscriptionId, 'Microsoft.Authorization/policyDefinitions', policyDefinition.name) -@sys.description('Policy Definition Role Definition IDs') +@sys.description('Policy Definition Role Definition IDs.') output roleDefinitionIds array = (contains(policyDefinition.properties.policyRule.then, 'details') ? ((contains(policyDefinition.properties.policyRule.then.details, 'roleDefinitionIds') ? policyDefinition.properties.policyRule.then.details.roleDefinitionIds : [])) : []) diff --git a/arm/Microsoft.Authorization/policyExemptions/deploy.bicep b/arm/Microsoft.Authorization/policyExemptions/deploy.bicep index 643376d62b..707c60191d 100644 --- a/arm/Microsoft.Authorization/policyExemptions/deploy.bicep +++ b/arm/Microsoft.Authorization/policyExemptions/deploy.bicep @@ -14,7 +14,7 @@ param description string = '' @sys.description('Optional. The policy exemption metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') param metadata object = {} -@sys.description('Optional. The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated') +@sys.description('Optional. The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated.') @allowed([ 'Mitigated' 'Waiver' @@ -112,11 +112,11 @@ module policyExemption_rg 'resourceGroup/deploy.bicep' = if (!empty(resourceGrou } } -@sys.description('Policy Exemption Name') +@sys.description('Policy Exemption Name.') output name string = empty(subscriptionId) && empty(resourceGroupName) ? policyExemption_mg.outputs.name : (!empty(subscriptionId) && empty(resourceGroupName) ? policyExemption_sub.outputs.name : policyExemption_rg.outputs.name) -@sys.description('Policy Exemption resource ID') +@sys.description('Policy Exemption resource ID.') output resourceId string = empty(subscriptionId) && empty(resourceGroupName) ? policyExemption_mg.outputs.resourceId : (!empty(subscriptionId) && empty(resourceGroupName) ? policyExemption_sub.outputs.resourceId : policyExemption_rg.outputs.resourceId) -@sys.description('Policy Exemption Scope') +@sys.description('Policy Exemption Scope.') output scope string = empty(subscriptionId) && empty(resourceGroupName) ? policyExemption_mg.outputs.scope : (!empty(subscriptionId) && empty(resourceGroupName) ? policyExemption_sub.outputs.scope : policyExemption_rg.outputs.scope) diff --git a/arm/Microsoft.Authorization/policyExemptions/managementGroup/deploy.bicep b/arm/Microsoft.Authorization/policyExemptions/managementGroup/deploy.bicep index 2e79abcdd7..1136f4b082 100644 --- a/arm/Microsoft.Authorization/policyExemptions/managementGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/policyExemptions/managementGroup/deploy.bicep @@ -14,7 +14,7 @@ param description string = '' @sys.description('Optional. The policy exemption metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') param metadata object = {} -@sys.description('Optional. The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated') +@sys.description('Optional. The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated.') @allowed([ 'Mitigated' 'Waiver' @@ -65,11 +65,11 @@ resource policyExemption 'Microsoft.Authorization/policyExemptions@2020-07-01-pr } } -@sys.description('Policy Exemption Name') +@sys.description('Policy Exemption Name.') output name string = policyExemption.name -@sys.description('Policy Exemption resource ID') +@sys.description('Policy Exemption resource ID.') output resourceId string = extensionResourceId(tenantResourceId('Microsoft.Management/managementGroups', managementGroupId), 'Microsoft.Authorization/policyExemptions', policyExemption.name) -@sys.description('Policy Exemption Scope') +@sys.description('Policy Exemption Scope.') output scope string = tenantResourceId('Microsoft.Management/managementGroups', managementGroupId) diff --git a/arm/Microsoft.Authorization/policyExemptions/resourceGroup/deploy.bicep b/arm/Microsoft.Authorization/policyExemptions/resourceGroup/deploy.bicep index 8551f2bb91..43bd651eab 100644 --- a/arm/Microsoft.Authorization/policyExemptions/resourceGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/policyExemptions/resourceGroup/deploy.bicep @@ -14,7 +14,7 @@ param description string = '' @sys.description('Optional. The policy exemption metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') param metadata object = {} -@sys.description('Optional. The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated') +@sys.description('Optional. The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated.') @allowed([ 'Mitigated' 'Waiver' @@ -64,14 +64,14 @@ resource policyExemption 'Microsoft.Authorization/policyExemptions@2020-07-01-pr } } -@sys.description('Policy Exemption Name') +@sys.description('Policy Exemption Name.') output name string = policyExemption.name -@sys.description('Policy Exemption resource ID') +@sys.description('Policy Exemption resource ID.') output resourceId string = az.resourceId(subscriptionId, resourceGroupName, 'Microsoft.Authorization/policyExemptions', policyExemption.name) -@sys.description('Policy Exemption Scope') +@sys.description('Policy Exemption Scope.') output scope string = resourceGroup().id -@sys.description('The name of the resource group the policy exemption was applied at') +@sys.description('The name of the resource group the policy exemption was applied at.') output resourceGroupName string = resourceGroup().name diff --git a/arm/Microsoft.Authorization/policyExemptions/subscription/deploy.bicep b/arm/Microsoft.Authorization/policyExemptions/subscription/deploy.bicep index 0106c0b91e..c510b3cb51 100644 --- a/arm/Microsoft.Authorization/policyExemptions/subscription/deploy.bicep +++ b/arm/Microsoft.Authorization/policyExemptions/subscription/deploy.bicep @@ -14,7 +14,7 @@ param description string = '' @sys.description('Optional. The policy exemption metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') param metadata object = {} -@sys.description('Optional. The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated') +@sys.description('Optional. The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated.') @allowed([ 'Mitigated' 'Waiver' @@ -65,11 +65,11 @@ resource policyExemption 'Microsoft.Authorization/policyExemptions@2020-07-01-pr } } -@sys.description('Policy Exemption Name') +@sys.description('Policy Exemption Name.') output name string = policyExemption.name -@sys.description('Policy Exemption resource ID') +@sys.description('Policy Exemption resource ID.') output resourceId string = subscriptionResourceId(subscriptionId, 'Microsoft.Authorization/policyExemptions', policyExemption.name) -@sys.description('Policy Exemption Scope') +@sys.description('Policy Exemption Scope.') output scope string = subscription().id diff --git a/arm/Microsoft.Authorization/policySetDefinitions/deploy.bicep b/arm/Microsoft.Authorization/policySetDefinitions/deploy.bicep index 9bf774e6d7..547f880c5b 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/deploy.bicep +++ b/arm/Microsoft.Authorization/policySetDefinitions/deploy.bicep @@ -14,13 +14,13 @@ param description string = '' @sys.description('Optional. The group ID of the Management Group (Scope). If not provided, will use the current scope for deployment.') param managementGroupId string = managementGroup().name -@sys.description('Optional. The subscription ID of the subscription (Scope). Cannot be used with managementGroupId') +@sys.description('Optional. The subscription ID of the subscription (Scope). Cannot be used with managementGroupId.') param subscriptionId string = '' @sys.description('Optional. The Set Definition (Initiative) metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') param metadata object = {} -@sys.description('Required. The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters') +@sys.description('Required. The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters.') param policyDefinitions array @sys.description('Optional. The metadata describing groups of policy definition references within the Policy Set Definition (Initiative).') @@ -82,8 +82,8 @@ module policySetDefinition_sub 'subscription/deploy.bicep' = if (!empty(subscrip } } -@sys.description('Policy Set Definition Name') +@sys.description('Policy Set Definition Name.') output name string = empty(subscriptionId) ? policySetDefinition_mg.outputs.name : policySetDefinition_sub.outputs.name -@sys.description('Policy Set Definition resource ID') +@sys.description('Policy Set Definition resource ID.') output resourceId string = empty(subscriptionId) ? policySetDefinition_mg.outputs.resourceId : policySetDefinition_sub.outputs.resourceId diff --git a/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/deploy.bicep b/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/deploy.bicep index 3e6ab18865..6a2162d57c 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/deploy.bicep @@ -17,7 +17,7 @@ param managementGroupId string = managementGroup().name @sys.description('Optional. The Set Definition (Initiative) metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') param metadata object = {} -@sys.description('Required. The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters') +@sys.description('Required. The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters.') param policyDefinitions array @sys.description('Optional. The metadata describing groups of policy definition references within the Policy Set Definition (Initiative).') @@ -58,8 +58,8 @@ resource policySetDefinition 'Microsoft.Authorization/policySetDefinitions@2021- } } -@sys.description('Policy Set Definition Name') +@sys.description('Policy Set Definition Name.') output name string = policySetDefinition.name -@sys.description('Policy Set Definition resource ID') +@sys.description('Policy Set Definition resource ID.') output resourceId string = extensionResourceId(tenantResourceId('Microsoft.Management/managementGroups', managementGroupId), 'Microsoft.Authorization/policySetDefinitions', policySetDefinition.name) diff --git a/arm/Microsoft.Authorization/policySetDefinitions/subscription/deploy.bicep b/arm/Microsoft.Authorization/policySetDefinitions/subscription/deploy.bicep index cf269aa4bb..f261a56ad5 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/subscription/deploy.bicep +++ b/arm/Microsoft.Authorization/policySetDefinitions/subscription/deploy.bicep @@ -11,13 +11,13 @@ param displayName string = '' @sys.description('Optional. The description name of the Set Definition (Initiative)') param description string = '' -@sys.description('Optional. The subscription ID of the subscription') +@sys.description('Optional. The subscription ID of the subscription.') param subscriptionId string = subscription().subscriptionId @sys.description('Optional. The Set Definition (Initiative) metadata. Metadata is an open ended object and is typically a collection of key-value pairs.') param metadata object = {} -@sys.description('Required. The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters') +@sys.description('Required. The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters.') param policyDefinitions array @sys.description('Optional. The metadata describing groups of policy definition references within the Policy Set Definition (Initiative).') @@ -58,8 +58,8 @@ resource policySetDefinition 'Microsoft.Authorization/policySetDefinitions@2021- } } -@sys.description('Policy Set Definition Name') +@sys.description('Policy Set Definition Name.') output name string = policySetDefinition.name -@sys.description('Policy Set Definition resource ID') +@sys.description('Policy Set Definition resource ID.') output resourceId string = subscriptionResourceId(subscriptionId, 'Microsoft.Authorization/policySetDefinitions', policySetDefinition.name) diff --git a/arm/Microsoft.Authorization/roleAssignments/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/deploy.bicep index 71e08fc5e0..9717ee05b4 100644 --- a/arm/Microsoft.Authorization/roleAssignments/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/deploy.bicep @@ -21,10 +21,10 @@ param location string = deployment().location @sys.description('Optional. The description of the role assignment.') param description string = '' -@sys.description('Optional. ID of the delegated managed identity resource') +@sys.description('Optional. ID of the delegated managed identity resource.') param delegatedManagedIdentityResourceId string = '' -@sys.description('Optional. The conditions on the role assignment. This limits the resources it can be assigned to') +@sys.description('Optional. The conditions on the role assignment. This limits the resources it can be assigned to.') param condition string = '' @sys.description('Optional. Version of the condition. Currently accepted value is "2.0"') @@ -111,11 +111,11 @@ module roleAssignment_rg 'resourceGroup/deploy.bicep' = if (!empty(resourceGroup } } -@sys.description('The GUID of the Role Assignment') +@sys.description('The GUID of the Role Assignment.') output name string = empty(subscriptionId) && empty(resourceGroupName) ? roleAssignment_mg.outputs.name : (!empty(subscriptionId) && empty(resourceGroupName) ? roleAssignment_sub.outputs.name : roleAssignment_rg.outputs.name) -@sys.description('The resource ID of the Role Assignment') +@sys.description('The resource ID of the Role Assignment.') output resourceId string = empty(subscriptionId) && empty(resourceGroupName) ? roleAssignment_mg.outputs.resourceId : (!empty(subscriptionId) && empty(resourceGroupName) ? roleAssignment_sub.outputs.resourceId : roleAssignment_rg.outputs.resourceId) -@sys.description('The scope this Role Assignment applies to') +@sys.description('The scope this Role Assignment applies to.') output scope string = empty(subscriptionId) && empty(resourceGroupName) ? roleAssignment_mg.outputs.scope : (!empty(subscriptionId) && empty(resourceGroupName) ? roleAssignment_sub.outputs.scope : roleAssignment_rg.outputs.scope) diff --git a/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep index 643f46ba4d..356e891cab 100644 --- a/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep @@ -12,10 +12,10 @@ param managementGroupId string = managementGroup().name @sys.description('Optional. The description of the role assignment.') param description string = '' -@sys.description('Optional. ID of the delegated managed identity resource') +@sys.description('Optional. ID of the delegated managed identity resource.') param delegatedManagedIdentityResourceId string = '' -@sys.description('Optional. The conditions on the role assignment. This limits the resources it can be assigned to') +@sys.description('Optional. The conditions on the role assignment. This limits the resources it can be assigned to.') param condition string = '' @sys.description('Optional. Version of the condition. Currently accepted value is "2.0"') @@ -353,11 +353,11 @@ resource roleAssignment 'Microsoft.Authorization/roleAssignments@2020-10-01-prev } } -@sys.description('The GUID of the Role Assignment') +@sys.description('The GUID of the Role Assignment.') output name string = roleAssignment.name -@sys.description('The resource ID of the Role Assignment') +@sys.description('The resource ID of the Role Assignment.') output scope string = tenantResourceId('Microsoft.Management/managementGroups', managementGroupId) -@sys.description('The scope this Role Assignment applies to') +@sys.description('The scope this Role Assignment applies to.') output resourceId string = extensionResourceId(tenantResourceId('Microsoft.Management/managementGroups', managementGroupId), 'Microsoft.Authorization/roleAssignments', roleAssignment.name) diff --git a/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep index e73e6286cb..6e65bd5d34 100644 --- a/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep @@ -15,10 +15,10 @@ param subscriptionId string = subscription().subscriptionId @sys.description('Optional. The description of the role assignment.') param description string = '' -@sys.description('Optional. ID of the delegated managed identity resource') +@sys.description('Optional. ID of the delegated managed identity resource.') param delegatedManagedIdentityResourceId string = '' -@sys.description('Optional. The conditions on the role assignment. This limits the resources it can be assigned to') +@sys.description('Optional. The conditions on the role assignment. This limits the resources it can be assigned to.') param condition string = '' @sys.description('Optional. Version of the condition. Currently accepted value is "2.0"') @@ -352,14 +352,14 @@ resource roleAssignment 'Microsoft.Authorization/roleAssignments@2020-10-01-prev } } -@sys.description('The GUID of the Role Assignment') +@sys.description('The GUID of the Role Assignment.') output name string = roleAssignment.name -@sys.description('The resource ID of the Role Assignment') +@sys.description('The resource ID of the Role Assignment.') output scope string = resourceGroup().id -@sys.description('The scope this Role Assignment applies to') +@sys.description('The scope this Role Assignment applies to.') output resourceId string = az.resourceId(resourceGroupName, 'Microsoft.Authorization/roleAssignments', roleAssignment.name) -@sys.description('The name of the resource group the role assignment was applied at') +@sys.description('The name of the resource group the role assignment was applied at.') output resourceGroupName string = resourceGroup().name diff --git a/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep index 20a7bcf05f..623229a5bf 100644 --- a/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep @@ -12,10 +12,10 @@ param subscriptionId string = subscription().subscriptionId @sys.description('Optional. The description of the role assignment.') param description string = '' -@sys.description('Optional. ID of the delegated managed identity resource') +@sys.description('Optional. ID of the delegated managed identity resource.') param delegatedManagedIdentityResourceId string = '' -@sys.description('Optional. The conditions on the role assignment. This limits the resources it can be assigned to') +@sys.description('Optional. The conditions on the role assignment. This limits the resources it can be assigned to.') param condition string = '' @sys.description('Optional. Location deployment metadata.') @@ -353,11 +353,11 @@ resource roleAssignment 'Microsoft.Authorization/roleAssignments@2020-10-01-prev } } -@sys.description('The GUID of the Role Assignment') +@sys.description('The GUID of the Role Assignment.') output name string = roleAssignment.name -@sys.description('The resource ID of the Role Assignment') +@sys.description('The resource ID of the Role Assignment.') output scope string = subscription().id -@sys.description('The scope this Role Assignment applies to') +@sys.description('The scope this Role Assignment applies to.') output resourceId string = subscriptionResourceId(subscriptionId, 'Microsoft.Authorization/roleAssignments', roleAssignment.name) diff --git a/arm/Microsoft.Authorization/roleDefinitions/deploy.bicep b/arm/Microsoft.Authorization/roleDefinitions/deploy.bicep index 6077a89f45..e94e9411a6 100644 --- a/arm/Microsoft.Authorization/roleDefinitions/deploy.bicep +++ b/arm/Microsoft.Authorization/roleDefinitions/deploy.bicep @@ -98,11 +98,11 @@ module roleDefinition_rg 'resourceGroup/deploy.bicep' = if (!empty(resourceGroup } } -@sys.description('The GUID of the Role Definition') +@sys.description('The GUID of the Role Definition.') output name string = empty(subscriptionId) && empty(resourceGroupName) ? roleDefinition_mg.outputs.name : (!empty(subscriptionId) && empty(resourceGroupName) ? roleDefinition_sub.outputs.name : roleDefinition_rg.outputs.name) -@sys.description('The resource ID of the Role Definition') +@sys.description('The resource ID of the Role Definition.') output resourceId string = empty(subscriptionId) && empty(resourceGroupName) ? roleDefinition_mg.outputs.resourceId : (!empty(subscriptionId) && empty(resourceGroupName) ? roleDefinition_sub.outputs.resourceId : roleDefinition_rg.outputs.resourceId) -@sys.description('The scope this Role Definition applies to') +@sys.description('The scope this Role Definition applies to.') output roleDefinitionScope string = empty(subscriptionId) && empty(resourceGroupName) ? roleDefinition_mg.outputs.scope : (!empty(subscriptionId) && empty(resourceGroupName) ? roleDefinition_sub.outputs.scope : roleDefinition_rg.outputs.scope) diff --git a/arm/Microsoft.Authorization/roleDefinitions/managementGroup/deploy.bicep b/arm/Microsoft.Authorization/roleDefinitions/managementGroup/deploy.bicep index 1b1bafe1ea..694c24bb7c 100644 --- a/arm/Microsoft.Authorization/roleDefinitions/managementGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/roleDefinitions/managementGroup/deploy.bicep @@ -53,11 +53,11 @@ resource roleDefinition 'Microsoft.Authorization/roleDefinitions@2018-01-01-prev } } -@sys.description('The GUID of the Role Definition') +@sys.description('The GUID of the Role Definition.') output name string = roleDefinition.name -@sys.description('The scope this Role Definition applies to') +@sys.description('The scope this Role Definition applies to.') output scope string = tenantResourceId('Microsoft.Management/managementGroups', managementGroupId) -@sys.description('The resource ID of the Role Definition') +@sys.description('The resource ID of the Role Definition.') output resourceId string = extensionResourceId(tenantResourceId('Microsoft.Management/managementGroups', managementGroupId), 'Microsoft.Authorization/roleDefinitions', roleDefinition.name) diff --git a/arm/Microsoft.Authorization/roleDefinitions/resourceGroup/deploy.bicep b/arm/Microsoft.Authorization/roleDefinitions/resourceGroup/deploy.bicep index 9ba0c6ec47..ea92fc6016 100644 --- a/arm/Microsoft.Authorization/roleDefinitions/resourceGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/roleDefinitions/resourceGroup/deploy.bicep @@ -12,10 +12,10 @@ param actions array = [] @sys.description('Optional. List of denied actions.') param notActions array = [] -@sys.description('Optional. List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes') +@sys.description('Optional. List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes.') param dataActions array = [] -@sys.description('Optional. List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes') +@sys.description('Optional. List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes.') param notDataActions array = [] @sys.description('Optional. The subscription ID where the Role Definition and Target Scope will be applied to. If not provided, will use the current scope for deployment.') @@ -60,14 +60,14 @@ resource roleDefinition 'Microsoft.Authorization/roleDefinitions@2018-01-01-prev } } -@sys.description('The GUID of the Role Definition') +@sys.description('The GUID of the Role Definition.') output name string = roleDefinition.name -@sys.description('The scope this Role Definition applies to') +@sys.description('The scope this Role Definition applies to.') output scope string = resourceGroup().id -@sys.description('The resource ID of the Role Definition') +@sys.description('The resource ID of the Role Definition.') output resourceId string = roleDefinition.id -@sys.description('The name of the resource group the role definition was created at') +@sys.description('The name of the resource group the role definition was created at.') output resourceGroupName string = resourceGroup().name diff --git a/arm/Microsoft.Authorization/roleDefinitions/subscription/deploy.bicep b/arm/Microsoft.Authorization/roleDefinitions/subscription/deploy.bicep index bb0746034f..d01745b2c6 100644 --- a/arm/Microsoft.Authorization/roleDefinitions/subscription/deploy.bicep +++ b/arm/Microsoft.Authorization/roleDefinitions/subscription/deploy.bicep @@ -12,10 +12,10 @@ param actions array = [] @sys.description('Optional. List of denied actions.') param notActions array = [] -@sys.description('Optional. List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes') +@sys.description('Optional. List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes.') param dataActions array = [] -@sys.description('Optional. List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes') +@sys.description('Optional. List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes.') param notDataActions array = [] @sys.description('Optional. The subscription ID where the Role Definition and Target Scope will be applied to. If not provided, will use the current scope for deployment.') @@ -61,11 +61,11 @@ resource roleDefinition 'Microsoft.Authorization/roleDefinitions@2018-01-01-prev } } -@sys.description('The GUID of the Role Definition') +@sys.description('The GUID of the Role Definition.') output name string = roleDefinition.name -@sys.description('The scope this Role Definition applies to') +@sys.description('The scope this Role Definition applies to.') output scope string = subscription().id -@sys.description('The resource ID of the Role Definition') +@sys.description('The resource ID of the Role Definition.') output resourceId string = subscriptionResourceId(subscriptionId, 'Microsoft.Authorization/roleDefinitions', roleDefinition.name) diff --git a/arm/Microsoft.Automation/automationAccounts/variables/deploy.bicep b/arm/Microsoft.Automation/automationAccounts/variables/deploy.bicep index f9b7b324f8..5b94ca5b0b 100644 --- a/arm/Microsoft.Automation/automationAccounts/variables/deploy.bicep +++ b/arm/Microsoft.Automation/automationAccounts/variables/deploy.bicep @@ -10,7 +10,7 @@ param value string @sys.description('Optional. The description of the variable.') param description string = '' -@sys.description('Optional. If the variable should be encrypted. For security reasons encryption of variables should be enabled') +@sys.description('Optional. If the variable should be encrypted. For security reasons encryption of variables should be enabled.') param isEncrypted bool = true @sys.description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).') @@ -42,11 +42,11 @@ resource variable 'Microsoft.Automation/automationAccounts/variables@2020-01-13- } } -@sys.description('The name of the deployed variable') +@sys.description('The name of the deployed variable.') output name string = variable.name -@sys.description('The resource ID of the deployed variable') +@sys.description('The resource ID of the deployed variable.') output resourceId string = variable.id -@sys.description('The resource group of the deployed variable') +@sys.description('The resource group of the deployed variable.') output resourceGroupName string = resourceGroup().name diff --git a/arm/Microsoft.DesktopVirtualization/applicationgroups/deploy.bicep b/arm/Microsoft.DesktopVirtualization/applicationgroups/deploy.bicep index c773a31689..6b305a6a2b 100644 --- a/arm/Microsoft.DesktopVirtualization/applicationgroups/deploy.bicep +++ b/arm/Microsoft.DesktopVirtualization/applicationgroups/deploy.bicep @@ -5,7 +5,7 @@ param name string @sys.description('Optional. Location for all resources.') param location string = resourceGroup().location -@sys.description('Required. The type of the Application Group to be created. Allowed values: RemoteApp or Desktop') +@sys.description('Required. The type of the Application Group to be created. Allowed values: RemoteApp or Desktop.') @allowed([ 'RemoteApp' 'Desktop' @@ -159,13 +159,13 @@ module appGroup_rbac '.bicep/nested_rbac.bicep' = [for (roleAssignment, index) i } }] -@sys.description('The resource ID of the AVD application group') +@sys.description('The resource ID of the AVD application group.') output resourceId string = appGroup.id -@sys.description('The resource group the AVD application group was deployed into') +@sys.description('The resource group the AVD application group was deployed into.') output resourceGroupName string = resourceGroup().name -@sys.description('The name of the AVD application group') +@sys.description('The name of the AVD application group.') output name string = appGroup.name @sys.description('The location the resource was deployed into.') diff --git a/arm/Microsoft.MachineLearningServices/workspaces/deploy.bicep b/arm/Microsoft.MachineLearningServices/workspaces/deploy.bicep index f574487786..30993bc327 100644 --- a/arm/Microsoft.MachineLearningServices/workspaces/deploy.bicep +++ b/arm/Microsoft.MachineLearningServices/workspaces/deploy.bicep @@ -280,13 +280,13 @@ module workspace_rbac '.bicep/nested_rbac.bicep' = [for (roleAssignment, index) // Outputs // // ================// -@sys.description('The resource ID of the machine learning service') +@sys.description('The resource ID of the machine learning service.') output resourceId string = workspace.id -@sys.description('The resource group the machine learning service was deployed into') +@sys.description('The resource group the machine learning service was deployed into.') output resourceGroupName string = resourceGroup().name -@sys.description('The name of the machine learning service') +@sys.description('The name of the machine learning service.') output name string = workspace.name @sys.description('The principal ID of the system assigned identity.') diff --git a/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep b/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep index 01848e0184..fdfc4f3703 100644 --- a/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep +++ b/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep @@ -7,7 +7,7 @@ param domainName string = '' @description('Optional. Required if domainName is specified. Username of Active Directory domain administrator, with permissions to create SMB server machine account in the AD domain.') param domainJoinUser string = '' -@description('Optional. Required if domainName is specified. Password of the user specified in domainJoinUser parameter') +@description('Optional. Required if domainName is specified. Password of the user specified in domainJoinUser parameter.') @secure() param domainJoinPassword string = '' @@ -17,7 +17,7 @@ param domainJoinOU string = '' @description('Optional. Required if domainName is specified. Comma separated list of DNS server IP addresses (IPv4 only) required for the Active Directory (AD) domain join and SMB authentication operations to succeed.') param dnsServers string = '' -@description('Optional. Required if domainName is specified. NetBIOS name of the SMB server. A computer account with this prefix will be registered in the AD and used to mount volumes') +@description('Optional. Required if domainName is specified. NetBIOS name of the SMB server. A computer account with this prefix will be registered in the AD and used to mount volumes.') param smbServerNamePrefix string = '' @description('Optional. Capacity pools to create.') diff --git a/arm/Microsoft.Network/networkSecurityGroups/securityRules/deploy.bicep b/arm/Microsoft.Network/networkSecurityGroups/securityRules/deploy.bicep index af7e9f32c3..2b7f0ca3dc 100644 --- a/arm/Microsoft.Network/networkSecurityGroups/securityRules/deploy.bicep +++ b/arm/Microsoft.Network/networkSecurityGroups/securityRules/deploy.bicep @@ -1,4 +1,4 @@ -@sys.description('Required. The name of the security rule') +@sys.description('Required. The name of the security rule.') param name string @sys.description('Conditional. The name of the parent network security group to deploy the security rule into. Required if the template is used in a standalone deployment.') @@ -107,11 +107,11 @@ resource securityRule 'Microsoft.Network/networkSecurityGroups/securityRules@202 } } -@sys.description('The resource group the security rule was deployed into') +@sys.description('The resource group the security rule was deployed into.') output resourceGroupName string = resourceGroup().name -@sys.description('The resource ID of the security rule') +@sys.description('The resource ID of the security rule.') output resourceId string = securityRule.id -@sys.description('The name of the security rule') +@sys.description('The name of the security rule.') output name string = securityRule.name diff --git a/arm/Microsoft.Network/privateDnsZones/A/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/A/deploy.bicep index f8a17941cf..918e2a2e4c 100644 --- a/arm/Microsoft.Network/privateDnsZones/A/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/A/deploy.bicep @@ -56,7 +56,7 @@ module A_rbac '.bicep/nested_rbac.bicep' = [for (roleAssignment, index) in roleA } }] -@description('The name of the deployed A record') +@description('The name of the deployed A record.') output name string = A.name @description('The resource ID of the deployed A record.') diff --git a/arm/Microsoft.Network/privateDnsZones/AAAA/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/AAAA/deploy.bicep index d9287b6505..9055983598 100644 --- a/arm/Microsoft.Network/privateDnsZones/AAAA/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/AAAA/deploy.bicep @@ -56,7 +56,7 @@ module AAAA_rbac '.bicep/nested_rbac.bicep' = [for (roleAssignment, index) in ro } }] -@description('The name of the deployed AAAA record') +@description('The name of the deployed AAAA record.') output name string = AAAA.name @description('The resource ID of the deployed AAAA record.') diff --git a/arm/Microsoft.Network/privateDnsZones/CNAME/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/CNAME/deploy.bicep index b6aab9ca2f..819666ba7b 100644 --- a/arm/Microsoft.Network/privateDnsZones/CNAME/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/CNAME/deploy.bicep @@ -56,7 +56,7 @@ module CNAME_rbac '.bicep/nested_rbac.bicep' = [for (roleAssignment, index) in r } }] -@description('The name of the deployed CNAME record') +@description('The name of the deployed CNAME record.') output name string = CNAME.name @description('The resource ID of the deployed CNAME record.') diff --git a/arm/Microsoft.Network/privateDnsZones/MX/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/MX/deploy.bicep index 5e3a5d9d0b..1bb6e60114 100644 --- a/arm/Microsoft.Network/privateDnsZones/MX/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/MX/deploy.bicep @@ -56,7 +56,7 @@ module MX_rbac '.bicep/nested_rbac.bicep' = [for (roleAssignment, index) in role } }] -@description('The name of the deployed MX record') +@description('The name of the deployed MX record.') output name string = MX.name @description('The resource ID of the deployed MX record.') diff --git a/arm/Microsoft.Network/privateDnsZones/SOA/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/SOA/deploy.bicep index a77e9d38bb..a89c211971 100644 --- a/arm/Microsoft.Network/privateDnsZones/SOA/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/SOA/deploy.bicep @@ -56,7 +56,7 @@ module SOA_rbac '.bicep/nested_rbac.bicep' = [for (roleAssignment, index) in rol } }] -@description('The name of the deployed SOA record') +@description('The name of the deployed SOA record.') output name string = SOA.name @description('The resource ID of the deployed SOA record.') diff --git a/arm/Microsoft.Network/privateDnsZones/SRV/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/SRV/deploy.bicep index 8d417889d8..1ffde640db 100644 --- a/arm/Microsoft.Network/privateDnsZones/SRV/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/SRV/deploy.bicep @@ -56,7 +56,7 @@ module SRV_rbac '.bicep/nested_rbac.bicep' = [for (roleAssignment, index) in rol } }] -@description('The name of the deployed SRV record') +@description('The name of the deployed SRV record.') output name string = SRV.name @description('The resource ID of the deployed SRV record.') diff --git a/arm/Microsoft.Network/privateDnsZones/TXT/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/TXT/deploy.bicep index 9324c6a192..8bf49155c0 100644 --- a/arm/Microsoft.Network/privateDnsZones/TXT/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/TXT/deploy.bicep @@ -56,7 +56,7 @@ module TXT_rbac '.bicep/nested_rbac.bicep' = [for (roleAssignment, index) in rol } }] -@description('The name of the deployed TXT record') +@description('The name of the deployed TXT record.') output name string = TXT.name @description('The resource ID of the deployed TXT record.') diff --git a/arm/Microsoft.Sql/servers/deploy.bicep b/arm/Microsoft.Sql/servers/deploy.bicep index c754c94264..da5bed7faa 100644 --- a/arm/Microsoft.Sql/servers/deploy.bicep +++ b/arm/Microsoft.Sql/servers/deploy.bicep @@ -56,7 +56,7 @@ var identity = identityType != 'None' ? { userAssignedIdentities: !empty(userAssignedIdentities) ? userAssignedIdentities : null } : null -@description('Optional. The vulnerability assessment configuration') +@description('Optional. The vulnerability assessment configuration.') param vulnerabilityAssessmentsObj object = {} resource defaultTelemetry 'Microsoft.Resources/deployments@2021-04-01' = if (enableDefaultTelemetry) { diff --git a/arm/Microsoft.Sql/servers/vulnerabilityAssessments/deploy.bicep b/arm/Microsoft.Sql/servers/vulnerabilityAssessments/deploy.bicep index 1a9bf98fa3..777f905259 100644 --- a/arm/Microsoft.Sql/servers/vulnerabilityAssessments/deploy.bicep +++ b/arm/Microsoft.Sql/servers/vulnerabilityAssessments/deploy.bicep @@ -1,7 +1,7 @@ -@description('Required. The name of the vulnerability assessment') +@description('Required. The name of the vulnerability assessment.') param name string -@description('Required. The Name of SQL Server') +@description('Required. The Name of SQL Server.') param serverName string @description('Optional. Recurring scans state.') @@ -49,11 +49,11 @@ resource vulnerabilityAssessment 'Microsoft.Sql/servers/vulnerabilityAssessments } } -@description('The name of the deployed vulnerability assessment') +@description('The name of the deployed vulnerability assessment.') output name string = vulnerabilityAssessment.name -@description('The resource ID of the deployed vulnerability assessment') +@description('The resource ID of the deployed vulnerability assessment.') output resourceId string = vulnerabilityAssessment.id -@description('The resource group of the deployed vulnerability assessment') +@description('The resource group of the deployed vulnerability assessment.') output resourceGroupName string = resourceGroup().name diff --git a/constructs/Microsoft.Compute/virtualMachinesMultiple/deploy.bicep b/constructs/Microsoft.Compute/virtualMachinesMultiple/deploy.bicep index c6109a9d87..f9c8484976 100644 --- a/constructs/Microsoft.Compute/virtualMachinesMultiple/deploy.bicep +++ b/constructs/Microsoft.Compute/virtualMachinesMultiple/deploy.bicep @@ -20,7 +20,7 @@ param vmNumberOfInstances int = 1 ]) param vmComputerNamesTransformation string = 'none' -@description('Required. Specifies the size for the VMs') +@description('Required. Specifies the size for the VMs.') param vmSize string @description('Optional. This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For security reasons, it is recommended to set encryptionAtHost to True. Restrictions: Cannot be enabled if Azure Disk Encryption (guest-VM encryption using bitlocker/DM-Crypt) is enabled on your VMs.') @@ -50,11 +50,11 @@ param dataDisks array = [] @description('Optional. 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.') param ultraSSDEnabled bool = false -@description('Required. Administrator username') +@description('Required. Administrator username.') @secure() param adminUsername string -@description('Optional. When specifying a Windows Virtual Machine, this value should be passed') +@description('Optional. When specifying a Windows Virtual Machine, this value should be passed.') @secure() param adminPassword string = '' @@ -89,7 +89,7 @@ param dedicatedHostId string = '' ]) param licenseType string = '' -@description('Optional. The list of SSH public keys used to authenticate with linux based VMs') +@description('Optional. The list of SSH public keys used to authenticate with linux based VMs.') param publicKeys array = [] @description('Optional. Enables system assigned managed identity on the resource.') @@ -173,21 +173,21 @@ param enableServerSideEncryption bool = false @description('Optional. Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.') param allowExtensionOperations bool = true -@description('Optional. Required if domainName is specified. Password of the user specified in domainJoinUser parameter') +@description('Optional. Required if domainName is specified. Password of the user specified in domainJoinUser parameter.') @secure() param extensionDomainJoinPassword string = '' -@description('Optional. The configuration for the [Domain Join] extension. Must at least contain the ["enabled": true] property to be executed') +@description('Optional. The configuration for the [Domain Join] extension. Must at least contain the ["enabled": true] property to be executed.') param extensionDomainJoinConfig object = { enabled: false } -@description('Optional. The configuration for the [Anti Malware] extension. Must at least contain the ["enabled": true] property to be executed') +@description('Optional. The configuration for the [Anti Malware] extension. Must at least contain the ["enabled": true] property to be executed.') param extensionAntiMalwareConfig object = { enabled: false } -@description('Optional. The configuration for the [Monitoring Agent] extension. Must at least contain the ["enabled": true] property to be executed') +@description('Optional. The configuration for the [Monitoring Agent] extension. Must at least contain the ["enabled": true] property to be executed.') param extensionMonitoringAgentConfig object = { enabled: false } @@ -195,33 +195,33 @@ param extensionMonitoringAgentConfig object = { @description('Optional. Resource ID of the monitoring log analytics workspace. Must be set when extensionMonitoringAgentConfig is set to true.') param monitoringWorkspaceId string = '' -@description('Optional. The configuration for the [Dependency Agent] extension. Must at least contain the ["enabled": true] property to be executed') +@description('Optional. The configuration for the [Dependency Agent] extension. Must at least contain the ["enabled": true] property to be executed.') param extensionDependencyAgentConfig object = { enabled: false } -@description('Optional. The configuration for the [Network Watcher Agent] extension. Must at least contain the ["enabled": true] property to be executed') +@description('Optional. The configuration for the [Network Watcher Agent] extension. Must at least contain the ["enabled": true] property to be executed.') param extensionNetworkWatcherAgentConfig object = { enabled: false } -@description('Optional. The configuration for the [Disk Encryption] extension. Must at least contain the ["enabled": true] property to be executed') +@description('Optional. The configuration for the [Disk Encryption] extension. Must at least contain the ["enabled": true] property to be executed.') param extensionDiskEncryptionConfig object = { enabled: false } -@description('Optional. The configuration for the [Desired State Configuration] extension. Must at least contain the ["enabled": true] property to be executed') +@description('Optional. The configuration for the [Desired State Configuration] extension. Must at least contain the ["enabled": true] property to be executed.') param extensionDSCConfig object = { enabled: false } -@description('Optional. The configuration for the [Custom Script] extension. Must at least contain the ["enabled": true] property to be executed') +@description('Optional. The configuration for the [Custom Script] extension. Must at least contain the ["enabled": true] property to be executed.') param extensionCustomScriptConfig object = { enabled: false fileData: [] } -@description('Optional. Any object that contains the extension specific protected settings') +@description('Optional. Any object that contains the extension specific protected settings.') @secure() param extensionCustomScriptProtectedSetting object = {} @@ -269,7 +269,7 @@ param baseTime string = utcNow('u') @description('Optional. SAS token validity length to use to download files from storage accounts. Usage: \'PT8H\' - valid for 8 hours; \'P5D\' - valid for 5 days; \'P1Y\' - valid for 1 year. When not provided, the SAS token will be valid for 8 hours.') param sasTokenValidityLength string = 'PT8H' -@description('Required. The chosen OS type') +@description('Required. The chosen OS type.') @allowed([ 'Windows' 'Linux' @@ -288,13 +288,13 @@ 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.') 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') +@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.') param additionalUnattendContent array = [] @description('Optional. Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - WinRMConfiguration object.') param winRM object = {} -@description('Optional. Any VM configuration profile assignments') +@description('Optional. Any VM configuration profile assignments.') param configurationProfileAssignments array = [] var vmGeneratedNames = [for instance in range(0, vmNumberOfInstances): '${vmNamePrefix}${padLeft((instance + vmInitialNumber), 3, '0')}'] From f1d23b99d056774a0d7eefae1e5be372268f9158 Mon Sep 17 00:00:00 2001 From: Erika Gressi Date: Sat, 14 May 2022 14:46:59 +0200 Subject: [PATCH 4/7] reset readme --- .../policyAssignments/managementGroup/readme.md | 12 ++++++------ .../policyAssignments/readme.md | 16 ++++++++-------- .../policyAssignments/resourceGroup/readme.md | 14 +++++++------- .../policyAssignments/subscription/readme.md | 12 ++++++------ .../policyDefinitions/managementGroup/readme.md | 8 ++++---- .../policyDefinitions/readme.md | 10 +++++----- .../policyDefinitions/subscription/readme.md | 10 +++++----- .../policyExemptions/managementGroup/readme.md | 8 ++++---- .../policyExemptions/readme.md | 8 ++++---- .../policyExemptions/resourceGroup/readme.md | 10 +++++----- .../policyExemptions/subscription/readme.md | 8 ++++---- .../managementGroup/readme.md | 6 +++--- .../policySetDefinitions/readme.md | 8 ++++---- .../policySetDefinitions/subscription/readme.md | 8 ++++---- .../roleAssignments/managementGroup/readme.md | 10 +++++----- .../roleAssignments/readme.md | 10 +++++----- .../roleAssignments/resourceGroup/readme.md | 12 ++++++------ .../roleAssignments/subscription/readme.md | 10 +++++----- .../roleDefinitions/managementGroup/readme.md | 6 +++--- .../roleDefinitions/readme.md | 6 +++--- .../roleDefinitions/resourceGroup/readme.md | 12 ++++++------ .../roleDefinitions/subscription/readme.md | 10 +++++----- .../automationAccounts/variables/readme.md | 8 ++++---- .../applicationgroups/readme.md | 8 ++++---- .../workspaces/readme.md | 6 +++--- arm/Microsoft.NetApp/netAppAccounts/readme.md | 4 ++-- .../localNetworkGateways/readme.md | 2 +- .../securityRules/readme.md | 8 ++++---- .../privateDnsZones/A/readme.md | 2 +- .../privateDnsZones/AAAA/readme.md | 2 +- .../privateDnsZones/CNAME/readme.md | 2 +- .../privateDnsZones/MX/readme.md | 2 +- .../privateDnsZones/SOA/readme.md | 2 +- .../privateDnsZones/SRV/readme.md | 2 +- .../privateDnsZones/TXT/readme.md | 2 +- arm/Microsoft.Sql/servers/readme.md | 2 +- .../servers/vulnerabilityAssessments/readme.md | 10 +++++----- 37 files changed, 138 insertions(+), 138 deletions(-) diff --git a/arm/Microsoft.Authorization/policyAssignments/managementGroup/readme.md b/arm/Microsoft.Authorization/policyAssignments/managementGroup/readme.md index ec36dd295c..4eff559a18 100644 --- a/arm/Microsoft.Authorization/policyAssignments/managementGroup/readme.md +++ b/arm/Microsoft.Authorization/policyAssignments/managementGroup/readme.md @@ -22,7 +22,7 @@ With this module you can perform policy assignments on a management group level. | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy assignment. Maximum length is 24 characters for management group scope. | | `policyDefinitionId` | string | Specifies the ID of the policy definition or policy set definition being assigned. | -| `roleDefinitionIds` | array | The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition | +| `roleDefinitionIds` | array | The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition. | **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | @@ -30,13 +30,13 @@ With this module you can perform policy assignments on a management group level. | `description` | string | `''` | | This message will be part of response in case of policy violation. | | `displayName` | string | `''` | | The display name of the policy assignment. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `enforcementMode` | string | `'Default'` | `[Default, DoNotEnforce]` | The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce | +| `enforcementMode` | string | `'Default'` | `[Default, DoNotEnforce]` | The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce. | | `identity` | string | `'SystemAssigned'` | `[SystemAssigned, UserAssigned, None]` | The managed identity associated with the policy assignment. Policy assignments must include a resource identity when assigning 'Modify' policy definitions. | | `location` | string | `[deployment().location]` | | Location for all resources. | | `managementGroupId` | string | `[managementGroup().name]` | | The Target Scope for the Policy. The name of the management group for the policy assignment. If not provided, will use the current scope for deployment. | | `metadata` | object | `{object}` | | The policy assignment metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `nonComplianceMessage` | string | `''` | | The messages that describe why a resource is non-compliant with the policy. | -| `notScopes` | array | `[]` | | The policy excluded scopes | +| `notScopes` | array | `[]` | | The policy excluded scopes. | | `parameters` | object | `{object}` | | Parameters for the policy assignment if needed. | | `userAssignedIdentityId` | string | `''` | | The Resource ID for the user assigned identity to assign to the policy assignment. | @@ -46,6 +46,6 @@ With this module you can perform policy assignments on a management group level. | Output Name | Type | Description | | :-- | :-- | :-- | | `location` | string | The location the resource was deployed into. | -| `name` | string | Policy Assignment Name | -| `principalId` | string | Policy Assignment principal ID | -| `resourceId` | string | Policy Assignment resource ID | +| `name` | string | Policy Assignment Name. | +| `principalId` | string | Policy Assignment principal ID. | +| `resourceId` | string | Policy Assignment resource ID. | diff --git a/arm/Microsoft.Authorization/policyAssignments/readme.md b/arm/Microsoft.Authorization/policyAssignments/readme.md index 483fdcca30..590cb6b76d 100644 --- a/arm/Microsoft.Authorization/policyAssignments/readme.md +++ b/arm/Microsoft.Authorization/policyAssignments/readme.md @@ -23,7 +23,7 @@ With this module you can perform policy assignments across the management group, | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy assignment. Maximum length is 24 characters for management group scope, 64 characters for subscription and resource group scopes. | | `policyDefinitionId` | string | Specifies the ID of the policy definition or policy set definition being assigned. | -| `roleDefinitionIds` | array | The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition | +| `roleDefinitionIds` | array | The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition. | **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | @@ -31,16 +31,16 @@ With this module you can perform policy assignments across the management group, | `description` | string | `''` | | This message will be part of response in case of policy violation. | | `displayName` | string | `''` | | The display name of the policy assignment. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `enforcementMode` | string | `'Default'` | `[Default, DoNotEnforce]` | The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce | +| `enforcementMode` | string | `'Default'` | `[Default, DoNotEnforce]` | The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce. | | `identity` | string | `'SystemAssigned'` | `[SystemAssigned, UserAssigned, None]` | The managed identity associated with the policy assignment. Policy assignments must include a resource identity when assigning 'Modify' policy definitions. | | `location` | string | `[deployment().location]` | | Location for all resources. | | `managementGroupId` | string | `[managementGroup().name]` | | The Target Scope for the Policy. The name of the management group for the policy assignment. If not provided, will use the current scope for deployment. | | `metadata` | object | `{object}` | | The policy assignment metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `nonComplianceMessage` | string | `''` | | The messages that describe why a resource is non-compliant with the policy. | -| `notScopes` | array | `[]` | | The policy excluded scopes | +| `notScopes` | array | `[]` | | The policy excluded scopes. | | `parameters` | object | `{object}` | | Parameters for the policy assignment if needed. | -| `resourceGroupName` | string | `''` | | The Target Scope for the Policy. The name of the resource group for the policy assignment | -| `subscriptionId` | string | `''` | | The Target Scope for the Policy. The subscription ID of the subscription for the policy assignment | +| `resourceGroupName` | string | `''` | | The Target Scope for the Policy. The name of the resource group for the policy assignment. | +| `subscriptionId` | string | `''` | | The Target Scope for the Policy. The subscription ID of the subscription for the policy assignment. | | `userAssignedIdentityId` | string | `''` | | The Resource ID for the user assigned identity to assign to the policy assignment. | @@ -107,6 +107,6 @@ module policyassignment 'yourpath/arm/Microsoft.Authorization.policyAssignments/ | Output Name | Type | Description | | :-- | :-- | :-- | | `location` | string | The location the resource was deployed into. | -| `name` | string | Policy Assignment Name | -| `principalId` | string | Policy Assignment principal ID | -| `resourceId` | string | Policy Assignment resource ID | +| `name` | string | Policy Assignment Name. | +| `principalId` | string | Policy Assignment principal ID. | +| `resourceId` | string | Policy Assignment resource ID. | diff --git a/arm/Microsoft.Authorization/policyAssignments/resourceGroup/readme.md b/arm/Microsoft.Authorization/policyAssignments/resourceGroup/readme.md index 24292c7874..5d9b3c2238 100644 --- a/arm/Microsoft.Authorization/policyAssignments/resourceGroup/readme.md +++ b/arm/Microsoft.Authorization/policyAssignments/resourceGroup/readme.md @@ -22,7 +22,7 @@ With this module you can perform policy assignments on a resource group level | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy assignment. Maximum length is 64 characters for resource group scope. | | `policyDefinitionId` | string | Specifies the ID of the policy definition or policy set definition being assigned. | -| `roleDefinitionIds` | array | The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition | +| `roleDefinitionIds` | array | The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition. | **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | @@ -30,12 +30,12 @@ With this module you can perform policy assignments on a resource group level | `description` | string | `''` | | This message will be part of response in case of policy violation. | | `displayName` | string | `''` | | The display name of the policy assignment. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `enforcementMode` | string | `'Default'` | `[Default, DoNotEnforce]` | The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce | +| `enforcementMode` | string | `'Default'` | `[Default, DoNotEnforce]` | The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce. | | `identity` | string | `'SystemAssigned'` | `[SystemAssigned, UserAssigned, None]` | The managed identity associated with the policy assignment. Policy assignments must include a resource identity when assigning 'Modify' policy definitions. | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `metadata` | object | `{object}` | | The policy assignment metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `nonComplianceMessage` | string | `''` | | The messages that describe why a resource is non-compliant with the policy. | -| `notScopes` | array | `[]` | | The policy excluded scopes | +| `notScopes` | array | `[]` | | The policy excluded scopes. | | `parameters` | object | `{object}` | | Parameters for the policy assignment if needed. | | `resourceGroupName` | string | `[resourceGroup().name]` | | The Target Scope for the Policy. The name of the resource group for the policy assignment. If not provided, will use the current scope for deployment. | | `subscriptionId` | string | `[subscription().subscriptionId]` | | The Target Scope for the Policy. The subscription ID of the subscription for the policy assignment. If not provided, will use the current scope for deployment. | @@ -47,7 +47,7 @@ With this module you can perform policy assignments on a resource group level | Output Name | Type | Description | | :-- | :-- | :-- | | `location` | string | The location the resource was deployed into. | -| `name` | string | Policy Assignment Name | -| `principalId` | string | Policy Assignment principal ID | -| `resourceGroupName` | string | The name of the resource group the policy was assigned to | -| `resourceId` | string | Policy Assignment resource ID | +| `name` | string | Policy Assignment Name. | +| `principalId` | string | Policy Assignment principal ID. | +| `resourceGroupName` | string | The name of the resource group the policy was assigned to. | +| `resourceId` | string | Policy Assignment resource ID. | diff --git a/arm/Microsoft.Authorization/policyAssignments/subscription/readme.md b/arm/Microsoft.Authorization/policyAssignments/subscription/readme.md index 086abe5af3..2d54ce0747 100644 --- a/arm/Microsoft.Authorization/policyAssignments/subscription/readme.md +++ b/arm/Microsoft.Authorization/policyAssignments/subscription/readme.md @@ -22,7 +22,7 @@ With this module you can perform policy assignments on a subscription level. | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy assignment. Maximum length is 64 characters for subscription scope. | | `policyDefinitionId` | string | Specifies the ID of the policy definition or policy set definition being assigned. | -| `roleDefinitionIds` | array | The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition | +| `roleDefinitionIds` | array | The IDs Of the Azure Role Definition list that is used to assign permissions to the identity. You need to provide either the fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.. See https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles for the list IDs for built-in Roles. They must match on what is on the policy definition. | **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | @@ -30,12 +30,12 @@ With this module you can perform policy assignments on a subscription level. | `description` | string | `''` | | This message will be part of response in case of policy violation. | | `displayName` | string | `''` | | The display name of the policy assignment. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `enforcementMode` | string | `'Default'` | `[Default, DoNotEnforce]` | The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce | +| `enforcementMode` | string | `'Default'` | `[Default, DoNotEnforce]` | The policy assignment enforcement mode. Possible values are Default and DoNotEnforce. - Default or DoNotEnforce. | | `identity` | string | `'SystemAssigned'` | `[SystemAssigned, UserAssigned, None]` | The managed identity associated with the policy assignment. Policy assignments must include a resource identity when assigning 'Modify' policy definitions. | | `location` | string | `[deployment().location]` | | Location for all resources. | | `metadata` | object | `{object}` | | The policy assignment metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `nonComplianceMessage` | string | `''` | | The messages that describe why a resource is non-compliant with the policy. | -| `notScopes` | array | `[]` | | The policy excluded scopes | +| `notScopes` | array | `[]` | | The policy excluded scopes. | | `parameters` | object | `{object}` | | Parameters for the policy assignment if needed. | | `subscriptionId` | string | `[subscription().subscriptionId]` | | The Target Scope for the Policy. The subscription ID of the subscription for the policy assignment. If not provided, will use the current scope for deployment. | | `userAssignedIdentityId` | string | `''` | | The Resource ID for the user assigned identity to assign to the policy assignment. | @@ -46,6 +46,6 @@ With this module you can perform policy assignments on a subscription level. | Output Name | Type | Description | | :-- | :-- | :-- | | `location` | string | The location the resource was deployed into. | -| `name` | string | Policy Assignment Name | -| `principalId` | string | Policy Assignment principal ID | -| `resourceId` | string | Policy Assignment resource ID | +| `name` | string | Policy Assignment Name. | +| `principalId` | string | Policy Assignment principal ID. | +| `resourceId` | string | Policy Assignment resource ID. | diff --git a/arm/Microsoft.Authorization/policyDefinitions/managementGroup/readme.md b/arm/Microsoft.Authorization/policyDefinitions/managementGroup/readme.md index ffda1f8355..a229004038 100644 --- a/arm/Microsoft.Authorization/policyDefinitions/managementGroup/readme.md +++ b/arm/Microsoft.Authorization/policyDefinitions/managementGroup/readme.md @@ -20,7 +20,7 @@ With this module you can create policy definitions on a management group level. | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy definition. Maximum length is 64 characters. | -| `policyRule` | object | The Policy Rule details for the Policy Definition | +| `policyRule` | object | The Policy Rule details for the Policy Definition. | **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | @@ -39,6 +39,6 @@ With this module you can create policy definitions on a management group level. | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | Policy Definition Name | -| `resourceId` | string | Policy Definition resource ID | -| `roleDefinitionIds` | array | Policy Definition Role Definition IDs | +| `name` | string | Policy Definition Name. | +| `resourceId` | string | Policy Definition resource ID. | +| `roleDefinitionIds` | array | Policy Definition Role Definition IDs. | diff --git a/arm/Microsoft.Authorization/policyDefinitions/readme.md b/arm/Microsoft.Authorization/policyDefinitions/readme.md index 2aeb5d4885..063983246d 100644 --- a/arm/Microsoft.Authorization/policyDefinitions/readme.md +++ b/arm/Microsoft.Authorization/policyDefinitions/readme.md @@ -21,7 +21,7 @@ With this module you can create policy definitions across the management group o | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy definition. Maximum length is 64 characters for management group scope and subscription scope. | -| `policyRule` | object | The Policy Rule details for the Policy Definition | +| `policyRule` | object | The Policy Rule details for the Policy Definition. | **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | @@ -34,7 +34,7 @@ With this module you can create policy definitions across the management group o | `metadata` | object | `{object}` | | The policy Definition metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `mode` | string | `'All'` | `[All, Indexed, Microsoft.KeyVault.Data, Microsoft.ContainerService.Data, Microsoft.Kubernetes.Data]` | The policy definition mode. Default is All, Some examples are All, Indexed, Microsoft.KeyVault.Data. | | `parameters` | object | `{object}` | | The policy definition parameters that can be used in policy definition references. | -| `subscriptionId` | string | `''` | | The subscription ID of the subscription (Scope). Cannot be used with managementGroupId | +| `subscriptionId` | string | `''` | | The subscription ID of the subscription (Scope). Cannot be used with managementGroupId. | ### Parameter Usage: `managementGroupId` @@ -84,6 +84,6 @@ module policydefinition 'yourpath/arm/Microsoft.Authorization.policyDefinitions/ | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | Policy Definition Name | -| `resourceId` | string | Policy Definition resource ID | -| `roleDefinitionIds` | array | Policy Definition Role Definition IDs | +| `name` | string | Policy Definition Name. | +| `resourceId` | string | Policy Definition resource ID. | +| `roleDefinitionIds` | array | Policy Definition Role Definition IDs. | diff --git a/arm/Microsoft.Authorization/policyDefinitions/subscription/readme.md b/arm/Microsoft.Authorization/policyDefinitions/subscription/readme.md index 36cfcf9e18..5c4b5f5c39 100644 --- a/arm/Microsoft.Authorization/policyDefinitions/subscription/readme.md +++ b/arm/Microsoft.Authorization/policyDefinitions/subscription/readme.md @@ -20,7 +20,7 @@ With this module you can create policy definitions on a subscription level. | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy definition. Maximum length is 64 characters. | -| `policyRule` | object | The Policy Rule details for the Policy Definition | +| `policyRule` | object | The Policy Rule details for the Policy Definition. | **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | @@ -32,13 +32,13 @@ With this module you can create policy definitions on a subscription level. | `metadata` | object | `{object}` | | The policy Definition metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `mode` | string | `'All'` | `[All, Indexed, Microsoft.KeyVault.Data, Microsoft.ContainerService.Data, Microsoft.Kubernetes.Data]` | The policy definition mode. Default is All, Some examples are All, Indexed, Microsoft.KeyVault.Data. | | `parameters` | object | `{object}` | | The policy definition parameters that can be used in policy definition references. | -| `subscriptionId` | string | `[subscription().subscriptionId]` | | The subscription ID of the subscription | +| `subscriptionId` | string | `[subscription().subscriptionId]` | | The subscription ID of the subscription. | ## Outputs | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | Policy Definition Name | -| `resourceId` | string | Policy Definition resource ID | -| `roleDefinitionIds` | array | Policy Definition Role Definition IDs | +| `name` | string | Policy Definition Name. | +| `resourceId` | string | Policy Definition resource ID. | +| `roleDefinitionIds` | array | Policy Definition Role Definition IDs. | diff --git a/arm/Microsoft.Authorization/policyExemptions/managementGroup/readme.md b/arm/Microsoft.Authorization/policyExemptions/managementGroup/readme.md index 0c340c034a..c3735ca00b 100644 --- a/arm/Microsoft.Authorization/policyExemptions/managementGroup/readme.md +++ b/arm/Microsoft.Authorization/policyExemptions/managementGroup/readme.md @@ -28,7 +28,7 @@ With this module you can create policy exemptions on a management group level. | `description` | string | `''` | | The description of the policy exemption. | | `displayName` | string | `''` | | The display name of the policy assignment. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated | +| `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated. | | `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z | | `location` | string | `[deployment().location]` | | Location deployment metadata. | | `managementGroupId` | string | `[managementGroup().name]` | | The group ID of the management group to be exempted from the policy assignment. If not provided, will use the current scope for deployment. | @@ -40,6 +40,6 @@ With this module you can create policy exemptions on a management group level. | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | Policy Exemption Name | -| `resourceId` | string | Policy Exemption resource ID | -| `scope` | string | Policy Exemption Scope | +| `name` | string | Policy Exemption Name. | +| `resourceId` | string | Policy Exemption resource ID. | +| `scope` | string | Policy Exemption Scope. | diff --git a/arm/Microsoft.Authorization/policyExemptions/readme.md b/arm/Microsoft.Authorization/policyExemptions/readme.md index a67b1b96c9..79c453fc8f 100644 --- a/arm/Microsoft.Authorization/policyExemptions/readme.md +++ b/arm/Microsoft.Authorization/policyExemptions/readme.md @@ -30,7 +30,7 @@ With this module you can create policy exemptions across the management group, s | `description` | string | `''` | | The description of the policy exemption. | | `displayName` | string | `''` | | The display name of the policy exemption. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated | +| `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated. | | `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z | | `location` | string | `[deployment().location]` | | Location deployment metadata. | | `managementGroupId` | string | `[managementGroup().name]` | | The group ID of the management group to be exempted from the policy assignment. If not provided, will use the current scope for deployment. | @@ -102,9 +102,9 @@ module policyexemption 'yourpath/arm/Microsoft.Authorization.policyExemptions/su | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | Policy Exemption Name | -| `resourceId` | string | Policy Exemption resource ID | -| `scope` | string | Policy Exemption Scope | +| `name` | string | Policy Exemption Name. | +| `resourceId` | string | Policy Exemption resource ID. | +| `scope` | string | Policy Exemption Scope. | ## Considerations diff --git a/arm/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md b/arm/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md index 321bba04f9..f94e6b2b74 100644 --- a/arm/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md +++ b/arm/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md @@ -28,7 +28,7 @@ With this module you can create policy exemptions on a resource group level. | `description` | string | `''` | | The description of the policy exemption. | | `displayName` | string | `''` | | The display name of the policy exemption. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated | +| `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated. | | `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z | | `metadata` | object | `{object}` | | The policy exemption metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `policyDefinitionReferenceIds` | array | `[]` | | The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. | @@ -40,7 +40,7 @@ With this module you can create policy exemptions on a resource group level. | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | Policy Exemption Name | -| `resourceGroupName` | string | The name of the resource group the policy exemption was applied at | -| `resourceId` | string | Policy Exemption resource ID | -| `scope` | string | Policy Exemption Scope | +| `name` | string | Policy Exemption Name. | +| `resourceGroupName` | string | The name of the resource group the policy exemption was applied at. | +| `resourceId` | string | Policy Exemption resource ID. | +| `scope` | string | Policy Exemption Scope. | diff --git a/arm/Microsoft.Authorization/policyExemptions/subscription/readme.md b/arm/Microsoft.Authorization/policyExemptions/subscription/readme.md index b537a59747..1e5601bd1d 100644 --- a/arm/Microsoft.Authorization/policyExemptions/subscription/readme.md +++ b/arm/Microsoft.Authorization/policyExemptions/subscription/readme.md @@ -28,7 +28,7 @@ With this module you can create policy exemptions on a subscription level. | `description` | string | `''` | | The description of the policy exemption. | | `displayName` | string | `''` | | The display name of the policy exemption. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated | +| `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated. | | `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z | | `location` | string | `[deployment().location]` | | Location deployment metadata. | | `metadata` | object | `{object}` | | The policy exemption metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | @@ -40,6 +40,6 @@ With this module you can create policy exemptions on a subscription level. | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | Policy Exemption Name | -| `resourceId` | string | Policy Exemption resource ID | -| `scope` | string | Policy Exemption Scope | +| `name` | string | Policy Exemption Name. | +| `resourceId` | string | Policy Exemption resource ID. | +| `scope` | string | Policy Exemption Scope. | diff --git a/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md b/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md index e3a6d312bd..1da3a9a4d7 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md +++ b/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md @@ -20,7 +20,7 @@ With this module you can create policy set definitions on a management group lev | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy Set Definition (Initiative). Maximum length is 24 characters for management group scope. | -| `policyDefinitions` | array | The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters | +| `policyDefinitions` | array | The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters. | **Optional parameters** | Parameter Name | Type | Default Value | Description | @@ -39,5 +39,5 @@ With this module you can create policy set definitions on a management group lev | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | Policy Set Definition Name | -| `resourceId` | string | Policy Set Definition resource ID | +| `name` | string | Policy Set Definition Name. | +| `resourceId` | string | Policy Set Definition resource ID. | diff --git a/arm/Microsoft.Authorization/policySetDefinitions/readme.md b/arm/Microsoft.Authorization/policySetDefinitions/readme.md index cd72d84be1..4d52643b36 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/readme.md +++ b/arm/Microsoft.Authorization/policySetDefinitions/readme.md @@ -22,7 +22,7 @@ With this module you can create policy set definitions across the management gro | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy Set Definition (Initiative). Maximum length is 24 characters for management group scope and 64 characters for subscription scope. | -| `policyDefinitions` | array | The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters | +| `policyDefinitions` | array | The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters. | **Optional parameters** | Parameter Name | Type | Default Value | Description | @@ -35,7 +35,7 @@ With this module you can create policy set definitions across the management gro | `metadata` | object | `{object}` | The Set Definition (Initiative) metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `parameters` | object | `{object}` | The Set Definition (Initiative) parameters that can be used in policy definition references. | | `policyDefinitionGroups` | array | `[]` | The metadata describing groups of policy definition references within the Policy Set Definition (Initiative). | -| `subscriptionId` | string | `''` | The subscription ID of the subscription (Scope). Cannot be used with managementGroupId | +| `subscriptionId` | string | `''` | The subscription ID of the subscription (Scope). Cannot be used with managementGroupId. | ### Parameter Usage: `managementGroupId` @@ -85,8 +85,8 @@ module policysetdefinition 'yourpath/arm/Microsoft.Authorization.policySetDefini | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | Policy Set Definition Name | -| `resourceId` | string | Policy Set Definition resource ID | +| `name` | string | Policy Set Definition Name. | +| `resourceId` | string | Policy Set Definition resource ID. | ## Considerations diff --git a/arm/Microsoft.Authorization/policySetDefinitions/subscription/readme.md b/arm/Microsoft.Authorization/policySetDefinitions/subscription/readme.md index fcd9c1d696..6636329efc 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/subscription/readme.md +++ b/arm/Microsoft.Authorization/policySetDefinitions/subscription/readme.md @@ -20,7 +20,7 @@ With this module you can create policy set definitions on a subscription level. | Parameter Name | Type | Description | | :-- | :-- | :-- | | `name` | string | Specifies the name of the policy Set Definition (Initiative). Maximum length is 64 characters for subscription scope. | -| `policyDefinitions` | array | The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters | +| `policyDefinitions` | array | The array of Policy definitions object to include for this policy set. Each object must include the Policy definition ID, and optionally other properties like parameters. | **Optional parameters** | Parameter Name | Type | Default Value | Description | @@ -32,12 +32,12 @@ With this module you can create policy set definitions on a subscription level. | `metadata` | object | `{object}` | The Set Definition (Initiative) metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `parameters` | object | `{object}` | The Set Definition (Initiative) parameters that can be used in policy definition references. | | `policyDefinitionGroups` | array | `[]` | The metadata describing groups of policy definition references within the Policy Set Definition (Initiative). | -| `subscriptionId` | string | `[subscription().subscriptionId]` | The subscription ID of the subscription | +| `subscriptionId` | string | `[subscription().subscriptionId]` | The subscription ID of the subscription. | ## Outputs | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | Policy Set Definition Name | -| `resourceId` | string | Policy Set Definition resource ID | +| `name` | string | Policy Set Definition Name. | +| `resourceId` | string | Policy Set Definition resource ID. | diff --git a/arm/Microsoft.Authorization/roleAssignments/managementGroup/readme.md b/arm/Microsoft.Authorization/roleAssignments/managementGroup/readme.md index 2464661bd8..fd93bc7b53 100644 --- a/arm/Microsoft.Authorization/roleAssignments/managementGroup/readme.md +++ b/arm/Microsoft.Authorization/roleAssignments/managementGroup/readme.md @@ -25,9 +25,9 @@ With this module you can perform role assignments on a management group level **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to | +| `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to. | | `conditionVersion` | string | `'2.0'` | `[2.0]` | Version of the condition. Currently accepted value is "2.0" | -| `delegatedManagedIdentityResourceId` | string | `''` | | ID of the delegated managed identity resource | +| `delegatedManagedIdentityResourceId` | string | `''` | | ID of the delegated managed identity resource. | | `description` | string | `''` | | The description of the role assignment. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `location` | string | `[deployment().location]` | | Location deployment metadata. | @@ -39,6 +39,6 @@ With this module you can perform role assignments on a management group level | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The GUID of the Role Assignment | -| `resourceId` | string | The scope this Role Assignment applies to | -| `scope` | string | The resource ID of the Role Assignment | +| `name` | string | The GUID of the Role Assignment. | +| `resourceId` | string | The scope this Role Assignment applies to. | +| `scope` | string | The resource ID of the Role Assignment. | diff --git a/arm/Microsoft.Authorization/roleAssignments/readme.md b/arm/Microsoft.Authorization/roleAssignments/readme.md index 0d8a7ceda8..2197cf509d 100644 --- a/arm/Microsoft.Authorization/roleAssignments/readme.md +++ b/arm/Microsoft.Authorization/roleAssignments/readme.md @@ -27,9 +27,9 @@ This module deploys Role Assignments across the management group, subscription o **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to | +| `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to. | | `conditionVersion` | string | `'2.0'` | `[2.0]` | Version of the condition. Currently accepted value is "2.0" | -| `delegatedManagedIdentityResourceId` | string | `''` | | ID of the delegated managed identity resource | +| `delegatedManagedIdentityResourceId` | string | `''` | | ID of the delegated managed identity resource. | | `description` | string | `''` | | The description of the role assignment. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `location` | string | `[deployment().location]` | | Location deployment metadata. | @@ -101,9 +101,9 @@ module roleassignment 'yourpath/arm/Microsoft.Authorization.roleAssignments/subs | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The GUID of the Role Assignment | -| `resourceId` | string | The resource ID of the Role Assignment | -| `scope` | string | The scope this Role Assignment applies to | +| `name` | string | The GUID of the Role Assignment. | +| `resourceId` | string | The resource ID of the Role Assignment. | +| `scope` | string | The scope this Role Assignment applies to. | ## Considerations diff --git a/arm/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md b/arm/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md index 18a66be9c5..f6bb83955d 100644 --- a/arm/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md +++ b/arm/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md @@ -25,9 +25,9 @@ With this module you can perform role assignments on a resource group level **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to | +| `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to. | | `conditionVersion` | string | `'2.0'` | `[2.0]` | Version of the condition. Currently accepted value is "2.0" | -| `delegatedManagedIdentityResourceId` | string | `''` | | ID of the delegated managed identity resource | +| `delegatedManagedIdentityResourceId` | string | `''` | | ID of the delegated managed identity resource. | | `description` | string | `''` | | The description of the role assignment. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `principalType` | string | `''` | `[ServicePrincipal, Group, User, ForeignGroup, Device, ]` | The principal type of the assigned principal ID. | @@ -39,7 +39,7 @@ With this module you can perform role assignments on a resource group level | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The GUID of the Role Assignment | -| `resourceGroupName` | string | The name of the resource group the role assignment was applied at | -| `resourceId` | string | The scope this Role Assignment applies to | -| `scope` | string | The resource ID of the Role Assignment | +| `name` | string | The GUID of the Role Assignment. | +| `resourceGroupName` | string | The name of the resource group the role assignment was applied at. | +| `resourceId` | string | The scope this Role Assignment applies to. | +| `scope` | string | The resource ID of the Role Assignment. | diff --git a/arm/Microsoft.Authorization/roleAssignments/subscription/readme.md b/arm/Microsoft.Authorization/roleAssignments/subscription/readme.md index fa2d3c2e13..47830f930e 100644 --- a/arm/Microsoft.Authorization/roleAssignments/subscription/readme.md +++ b/arm/Microsoft.Authorization/roleAssignments/subscription/readme.md @@ -25,9 +25,9 @@ With this module you can perform role assignments on a subscription level **Optional parameters** | Parameter Name | Type | Default Value | Allowed Values | Description | | :-- | :-- | :-- | :-- | :-- | -| `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to | +| `condition` | string | `''` | | The conditions on the role assignment. This limits the resources it can be assigned to. | | `conditionVersion` | string | `'2.0'` | `[2.0]` | Version of the condition. Currently accepted value is "2.0" | -| `delegatedManagedIdentityResourceId` | string | `''` | | ID of the delegated managed identity resource | +| `delegatedManagedIdentityResourceId` | string | `''` | | ID of the delegated managed identity resource. | | `description` | string | `''` | | The description of the role assignment. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `location` | string | `[deployment().location]` | | Location deployment metadata. | @@ -39,6 +39,6 @@ With this module you can perform role assignments on a subscription level | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The GUID of the Role Assignment | -| `resourceId` | string | The scope this Role Assignment applies to | -| `scope` | string | The resource ID of the Role Assignment | +| `name` | string | The GUID of the Role Assignment. | +| `resourceId` | string | The scope this Role Assignment applies to. | +| `scope` | string | The resource ID of the Role Assignment. | diff --git a/arm/Microsoft.Authorization/roleDefinitions/managementGroup/readme.md b/arm/Microsoft.Authorization/roleDefinitions/managementGroup/readme.md index 9e85855e12..6c3b711db5 100644 --- a/arm/Microsoft.Authorization/roleDefinitions/managementGroup/readme.md +++ b/arm/Microsoft.Authorization/roleDefinitions/managementGroup/readme.md @@ -37,6 +37,6 @@ With this module you can create role definitions on a management group level | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The GUID of the Role Definition | -| `resourceId` | string | The resource ID of the Role Definition | -| `scope` | string | The scope this Role Definition applies to | +| `name` | string | The GUID of the Role Definition. | +| `resourceId` | string | The resource ID of the Role Definition. | +| `scope` | string | The scope this Role Definition applies to. | diff --git a/arm/Microsoft.Authorization/roleDefinitions/readme.md b/arm/Microsoft.Authorization/roleDefinitions/readme.md index 191a56c5da..b006beb4f0 100644 --- a/arm/Microsoft.Authorization/roleDefinitions/readme.md +++ b/arm/Microsoft.Authorization/roleDefinitions/readme.md @@ -101,9 +101,9 @@ module roledefinition 'yourpath/arm/Microsoft.Authorization.roleDefinitions/subs | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The GUID of the Role Definition | -| `resourceId` | string | The resource ID of the Role Definition | -| `roleDefinitionScope` | string | The scope this Role Definition applies to | +| `name` | string | The GUID of the Role Definition. | +| `resourceId` | string | The resource ID of the Role Definition. | +| `roleDefinitionScope` | string | The scope this Role Definition applies to. | ## Considerations diff --git a/arm/Microsoft.Authorization/roleDefinitions/resourceGroup/readme.md b/arm/Microsoft.Authorization/roleDefinitions/resourceGroup/readme.md index 1055a81f65..62716b11e7 100644 --- a/arm/Microsoft.Authorization/roleDefinitions/resourceGroup/readme.md +++ b/arm/Microsoft.Authorization/roleDefinitions/resourceGroup/readme.md @@ -26,11 +26,11 @@ With this module you can create role definitions on a resource group level | :-- | :-- | :-- | :-- | | `actions` | array | `[]` | List of allowed actions. | | `assignableScopes` | array | `[]` | Role definition assignable scopes. If not provided, will use the current scope provided. | -| `dataActions` | array | `[]` | List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes | +| `dataActions` | array | `[]` | List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes. | | `description` | string | `''` | Description of the custom RBAC role to be created. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `notActions` | array | `[]` | List of denied actions. | -| `notDataActions` | array | `[]` | List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes | +| `notDataActions` | array | `[]` | List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes. | | `resourceGroupName` | string | `[resourceGroup().name]` | The name of the Resource Group where the Role Definition and Target Scope will be applied to. If not provided, will use the current scope for deployment. | | `subscriptionId` | string | `[subscription().subscriptionId]` | The subscription ID where the Role Definition and Target Scope will be applied to. If not provided, will use the current scope for deployment. | @@ -39,7 +39,7 @@ With this module you can create role definitions on a resource group level | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The GUID of the Role Definition | -| `resourceGroupName` | string | The name of the resource group the role definition was created at | -| `resourceId` | string | The resource ID of the Role Definition | -| `scope` | string | The scope this Role Definition applies to | +| `name` | string | The GUID of the Role Definition. | +| `resourceGroupName` | string | The name of the resource group the role definition was created at. | +| `resourceId` | string | The resource ID of the Role Definition. | +| `scope` | string | The scope this Role Definition applies to. | diff --git a/arm/Microsoft.Authorization/roleDefinitions/subscription/readme.md b/arm/Microsoft.Authorization/roleDefinitions/subscription/readme.md index bb26e18773..39bcf3eaee 100644 --- a/arm/Microsoft.Authorization/roleDefinitions/subscription/readme.md +++ b/arm/Microsoft.Authorization/roleDefinitions/subscription/readme.md @@ -26,12 +26,12 @@ With this module you can create role definitions on a subscription level | :-- | :-- | :-- | :-- | | `actions` | array | `[]` | List of allowed actions. | | `assignableScopes` | array | `[]` | Role definition assignable scopes. If not provided, will use the current scope provided. | -| `dataActions` | array | `[]` | List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes | +| `dataActions` | array | `[]` | List of allowed data actions. This is not supported if the assignableScopes contains Management Group Scopes. | | `description` | string | `''` | Description of the custom RBAC role to be created. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `location` | string | `[deployment().location]` | Location deployment metadata. | | `notActions` | array | `[]` | List of denied actions. | -| `notDataActions` | array | `[]` | List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes | +| `notDataActions` | array | `[]` | List of denied data actions. This is not supported if the assignableScopes contains Management Group Scopes. | | `subscriptionId` | string | `[subscription().subscriptionId]` | The subscription ID where the Role Definition and Target Scope will be applied to. If not provided, will use the current scope for deployment. | @@ -39,6 +39,6 @@ With this module you can create role definitions on a subscription level | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The GUID of the Role Definition | -| `resourceId` | string | The resource ID of the Role Definition | -| `scope` | string | The scope this Role Definition applies to | +| `name` | string | The GUID of the Role Definition. | +| `resourceId` | string | The resource ID of the Role Definition. | +| `scope` | string | The scope this Role Definition applies to. | diff --git a/arm/Microsoft.Automation/automationAccounts/variables/readme.md b/arm/Microsoft.Automation/automationAccounts/variables/readme.md index c5349e116b..86f68e0c75 100644 --- a/arm/Microsoft.Automation/automationAccounts/variables/readme.md +++ b/arm/Microsoft.Automation/automationAccounts/variables/readme.md @@ -32,7 +32,7 @@ This module deploys a variable to an Azure Automation Account. | :-- | :-- | :-- | :-- | | `description` | string | `''` | The description of the variable. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | -| `isEncrypted` | bool | `True` | If the variable should be encrypted. For security reasons encryption of variables should be enabled | +| `isEncrypted` | bool | `True` | If the variable should be encrypted. For security reasons encryption of variables should be enabled. | ### Parameter Usage: `value` @@ -63,6 +63,6 @@ This module deploys a variable to an Azure Automation Account. | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the deployed variable | -| `resourceGroupName` | string | The resource group of the deployed variable | -| `resourceId` | string | The resource ID of the deployed variable | +| `name` | string | The name of the deployed variable. | +| `resourceGroupName` | string | The resource group of the deployed variable. | +| `resourceId` | string | The resource ID of the deployed variable. | diff --git a/arm/Microsoft.DesktopVirtualization/applicationgroups/readme.md b/arm/Microsoft.DesktopVirtualization/applicationgroups/readme.md index 7daef6fc1d..91ab40487f 100644 --- a/arm/Microsoft.DesktopVirtualization/applicationgroups/readme.md +++ b/arm/Microsoft.DesktopVirtualization/applicationgroups/readme.md @@ -23,7 +23,7 @@ This module deploys an Azure virtual desktop application group. **Required parameters** | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | -| `applicationGroupType` | string | `[RemoteApp, Desktop]` | The type of the Application Group to be created. Allowed values: RemoteApp or Desktop | +| `applicationGroupType` | string | `[RemoteApp, Desktop]` | The type of the Application Group to be created. Allowed values: RemoteApp or Desktop. | | `hostpoolName` | string | | Name of the Host Pool to be linked to this Application Group. | | `name` | string | | Name of the Application Group to create this application in. | @@ -95,6 +95,6 @@ Tag names and tag values can be provided as needed. A tag can be left without a | Output Name | Type | Description | | :-- | :-- | :-- | | `location` | string | The location the resource was deployed into. | -| `name` | string | The name of the AVD application group | -| `resourceGroupName` | string | The resource group the AVD application group was deployed into | -| `resourceId` | string | The resource ID of the AVD application group | +| `name` | string | The name of the AVD application group. | +| `resourceGroupName` | string | The resource group the AVD application group was deployed into. | +| `resourceId` | string | The resource ID of the AVD application group. | diff --git a/arm/Microsoft.MachineLearningServices/workspaces/readme.md b/arm/Microsoft.MachineLearningServices/workspaces/readme.md index d66d772e01..a2acdf96dc 100644 --- a/arm/Microsoft.MachineLearningServices/workspaces/readme.md +++ b/arm/Microsoft.MachineLearningServices/workspaces/readme.md @@ -216,7 +216,7 @@ You can specify multiple user assigned identities to a resource by providing add | Output Name | Type | Description | | :-- | :-- | :-- | | `location` | string | The location the resource was deployed into. | -| `name` | string | The name of the machine learning service | +| `name` | string | The name of the machine learning service. | | `principalId` | string | The principal ID of the system assigned identity. | -| `resourceGroupName` | string | The resource group the machine learning service was deployed into | -| `resourceId` | string | The resource ID of the machine learning service | +| `resourceGroupName` | string | The resource group the machine learning service was deployed into. | +| `resourceId` | string | The resource ID of the machine learning service. | diff --git a/arm/Microsoft.NetApp/netAppAccounts/readme.md b/arm/Microsoft.NetApp/netAppAccounts/readme.md index ea58a2cdce..59453cfbad 100644 --- a/arm/Microsoft.NetApp/netAppAccounts/readme.md +++ b/arm/Microsoft.NetApp/netAppAccounts/readme.md @@ -31,14 +31,14 @@ This template deploys Azure NetApp Files. | `capacityPools` | _[capacityPools](capacityPools/readme.md)_ array | `[]` | | Capacity pools to create. | | `dnsServers` | string | `''` | | Required if domainName is specified. Comma separated list of DNS server IP addresses (IPv4 only) required for the Active Directory (AD) domain join and SMB authentication operations to succeed. | | `domainJoinOU` | string | `''` | | Used only if domainName is specified. LDAP Path for the Organization Unit (OU) where SMB Server machine accounts will be created (i.e. 'OU=SecondLevel,OU=FirstLevel'). | -| `domainJoinPassword` | secureString | `''` | | Required if domainName is specified. Password of the user specified in domainJoinUser parameter | +| `domainJoinPassword` | secureString | `''` | | Required if domainName is specified. Password of the user specified in domainJoinUser parameter. | | `domainJoinUser` | string | `''` | | Required if domainName is specified. Username of Active Directory domain administrator, with permissions to create SMB server machine account in the AD domain. | | `domainName` | string | `''` | | Fully Qualified Active Directory DNS Domain Name (e.g. 'contoso.com') | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `location` | string | `[resourceGroup().location]` | | Location for all resources. | | `lock` | string | `'NotSpecified'` | `[CanNotDelete, NotSpecified, ReadOnly]` | Specify the type of lock. | | `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' | -| `smbServerNamePrefix` | string | `''` | | Required if domainName is specified. NetBIOS name of the SMB server. A computer account with this prefix will be registered in the AD and used to mount volumes | +| `smbServerNamePrefix` | string | `''` | | Required if domainName is specified. NetBIOS name of the SMB server. A computer account with this prefix will be registered in the AD and used to mount volumes. | | `tags` | object | `{object}` | | Tags for all resources. | diff --git a/arm/Microsoft.Network/localNetworkGateways/readme.md b/arm/Microsoft.Network/localNetworkGateways/readme.md index 6751d040b4..cb6bd07246 100644 --- a/arm/Microsoft.Network/localNetworkGateways/readme.md +++ b/arm/Microsoft.Network/localNetworkGateways/readme.md @@ -14,7 +14,7 @@ This module deploys a local network gateway. | :-- | :-- | | `Microsoft.Authorization/locks` | [2017-04-01](https://docs.microsoft.com/en-us/azure/templates/Microsoft.Authorization/2017-04-01/locks) | | `Microsoft.Authorization/roleAssignments` | [2020-10-01-preview](https://docs.microsoft.com/en-us/azure/templates/Microsoft.Authorization/2020-10-01-preview/roleAssignments) | -| `Microsoft.Network/localNetworkGateways` | [2021-08-01](https://docs.microsoft.com/en-us/azure/templates/Microsoft.Network/localNetworkGateways) | +| `Microsoft.Network/localNetworkGateways` | [2021-08-01](https://docs.microsoft.com/en-us/azure/templates/Microsoft.Network/2021-08-01/localNetworkGateways) | ## Parameters diff --git a/arm/Microsoft.Network/networkSecurityGroups/securityRules/readme.md b/arm/Microsoft.Network/networkSecurityGroups/securityRules/readme.md index 222eee66e2..e4740f90de 100644 --- a/arm/Microsoft.Network/networkSecurityGroups/securityRules/readme.md +++ b/arm/Microsoft.Network/networkSecurityGroups/securityRules/readme.md @@ -20,7 +20,7 @@ This module deploys Network Security Group Security Rules. | Parameter Name | Type | Allowed Values | Description | | :-- | :-- | :-- | :-- | | `direction` | string | `[Inbound, Outbound]` | The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. | -| `name` | string | | The name of the security rule | +| `name` | string | | The name of the security rule. | | `priority` | int | | The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. | | `protocol` | string | `[*, Ah, Esp, Icmp, Tcp, Udp]` | Network protocol this rule applies to. | @@ -51,6 +51,6 @@ This module deploys Network Security Group Security Rules. | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the security rule | -| `resourceGroupName` | string | The resource group the security rule was deployed into | -| `resourceId` | string | The resource ID of the security rule | +| `name` | string | The name of the security rule. | +| `resourceGroupName` | string | The resource group the security rule was deployed into. | +| `resourceId` | string | The resource ID of the security rule. | diff --git a/arm/Microsoft.Network/privateDnsZones/A/readme.md b/arm/Microsoft.Network/privateDnsZones/A/readme.md index 4dbaec0520..e1edc70ae5 100644 --- a/arm/Microsoft.Network/privateDnsZones/A/readme.md +++ b/arm/Microsoft.Network/privateDnsZones/A/readme.md @@ -79,6 +79,6 @@ Create a role assignment for the given resource. If you want to assign a service | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the deployed A record | +| `name` | string | The name of the deployed A record. | | `resourceGroupName` | string | The resource group of the deployed A record. | | `resourceId` | string | The resource ID of the deployed A record. | diff --git a/arm/Microsoft.Network/privateDnsZones/AAAA/readme.md b/arm/Microsoft.Network/privateDnsZones/AAAA/readme.md index 10c4f59722..f6e652df75 100644 --- a/arm/Microsoft.Network/privateDnsZones/AAAA/readme.md +++ b/arm/Microsoft.Network/privateDnsZones/AAAA/readme.md @@ -79,6 +79,6 @@ Create a role assignment for the given resource. If you want to assign a service | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the deployed AAAA record | +| `name` | string | The name of the deployed AAAA record. | | `resourceGroupName` | string | The resource group of the deployed AAAA record. | | `resourceId` | string | The resource ID of the deployed AAAA record. | diff --git a/arm/Microsoft.Network/privateDnsZones/CNAME/readme.md b/arm/Microsoft.Network/privateDnsZones/CNAME/readme.md index 7098fd450f..b6a69258b6 100644 --- a/arm/Microsoft.Network/privateDnsZones/CNAME/readme.md +++ b/arm/Microsoft.Network/privateDnsZones/CNAME/readme.md @@ -67,6 +67,6 @@ Create a role assignment for the given resource. If you want to assign a service | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the deployed CNAME record | +| `name` | string | The name of the deployed CNAME record. | | `resourceGroupName` | string | The resource group of the deployed CNAME record. | | `resourceId` | string | The resource ID of the deployed CNAME record. | diff --git a/arm/Microsoft.Network/privateDnsZones/MX/readme.md b/arm/Microsoft.Network/privateDnsZones/MX/readme.md index bedbe17a7a..3d91bd10b4 100644 --- a/arm/Microsoft.Network/privateDnsZones/MX/readme.md +++ b/arm/Microsoft.Network/privateDnsZones/MX/readme.md @@ -80,6 +80,6 @@ Create a role assignment for the given resource. If you want to assign a service | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the deployed MX record | +| `name` | string | The name of the deployed MX record. | | `resourceGroupName` | string | The resource group of the deployed MX record. | | `resourceId` | string | The resource ID of the deployed MX record. | diff --git a/arm/Microsoft.Network/privateDnsZones/SOA/readme.md b/arm/Microsoft.Network/privateDnsZones/SOA/readme.md index 51a6c9fdcb..1142121cf0 100644 --- a/arm/Microsoft.Network/privateDnsZones/SOA/readme.md +++ b/arm/Microsoft.Network/privateDnsZones/SOA/readme.md @@ -83,6 +83,6 @@ Create a role assignment for the given resource. If you want to assign a service | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the deployed SOA record | +| `name` | string | The name of the deployed SOA record. | | `resourceGroupName` | string | The resource group of the deployed SOA record. | | `resourceId` | string | The resource ID of the deployed SOA record. | diff --git a/arm/Microsoft.Network/privateDnsZones/SRV/readme.md b/arm/Microsoft.Network/privateDnsZones/SRV/readme.md index 6022d66206..3120ee78c1 100644 --- a/arm/Microsoft.Network/privateDnsZones/SRV/readme.md +++ b/arm/Microsoft.Network/privateDnsZones/SRV/readme.md @@ -82,6 +82,6 @@ Create a role assignment for the given resource. If you want to assign a service | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the deployed SRV record | +| `name` | string | The name of the deployed SRV record. | | `resourceGroupName` | string | The resource group of the deployed SRV record. | | `resourceId` | string | The resource ID of the deployed SRV record. | diff --git a/arm/Microsoft.Network/privateDnsZones/TXT/readme.md b/arm/Microsoft.Network/privateDnsZones/TXT/readme.md index 3c245f67f5..9cb888be0a 100644 --- a/arm/Microsoft.Network/privateDnsZones/TXT/readme.md +++ b/arm/Microsoft.Network/privateDnsZones/TXT/readme.md @@ -79,6 +79,6 @@ Create a role assignment for the given resource. If you want to assign a service | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the deployed TXT record | +| `name` | string | The name of the deployed TXT record. | | `resourceGroupName` | string | The resource group of the deployed TXT record. | | `resourceId` | string | The resource ID of the deployed TXT record. | diff --git a/arm/Microsoft.Sql/servers/readme.md b/arm/Microsoft.Sql/servers/readme.md index fe4fe57da4..13f40eac69 100644 --- a/arm/Microsoft.Sql/servers/readme.md +++ b/arm/Microsoft.Sql/servers/readme.md @@ -51,7 +51,7 @@ This module deploys a SQL server. | `systemAssignedIdentity` | bool | `False` | | Enables system assigned managed identity on the resource. | | `tags` | object | `{object}` | | Tags of the resource. | | `userAssignedIdentities` | object | `{object}` | | The ID(s) to assign to the resource. | -| `vulnerabilityAssessmentsObj` | _[vulnerabilityAssessments](vulnerabilityAssessments/readme.md)_ object | `{object}` | | The vulnerability assessment configuration | +| `vulnerabilityAssessmentsObj` | _[vulnerabilityAssessments](vulnerabilityAssessments/readme.md)_ object | `{object}` | | The vulnerability assessment configuration. | ### Parameter Usage: `roleAssignments` diff --git a/arm/Microsoft.Sql/servers/vulnerabilityAssessments/readme.md b/arm/Microsoft.Sql/servers/vulnerabilityAssessments/readme.md index c86bdeedce..e9aae9829c 100644 --- a/arm/Microsoft.Sql/servers/vulnerabilityAssessments/readme.md +++ b/arm/Microsoft.Sql/servers/vulnerabilityAssessments/readme.md @@ -19,8 +19,8 @@ This module deploys a vulnerability assessment for a SQL server. **Required parameters** | Parameter Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the vulnerability assessment | -| `serverName` | string | The Name of SQL Server | +| `name` | string | The name of the vulnerability assessment. | +| `serverName` | string | The Name of SQL Server. | **Optional parameters** | Parameter Name | Type | Default Value | Description | @@ -36,6 +36,6 @@ This module deploys a vulnerability assessment for a SQL server. | Output Name | Type | Description | | :-- | :-- | :-- | -| `name` | string | The name of the deployed vulnerability assessment | -| `resourceGroupName` | string | The resource group of the deployed vulnerability assessment | -| `resourceId` | string | The resource ID of the deployed vulnerability assessment | +| `name` | string | The name of the deployed vulnerability assessment. | +| `resourceGroupName` | string | The resource group of the deployed vulnerability assessment. | +| `resourceId` | string | The resource ID of the deployed vulnerability assessment. | From 1954475c8a0b528f0cacc55513ef01de36ad1cb4 Mon Sep 17 00:00:00 2001 From: Erika Gressi Date: Sat, 14 May 2022 16:03:23 +0200 Subject: [PATCH 5/7] missing dots and readmes --- arm/Microsoft.Authorization/policyExemptions/deploy.bicep | 2 +- .../policyExemptions/managementGroup/deploy.bicep | 2 +- .../policyExemptions/managementGroup/readme.md | 2 +- arm/Microsoft.Authorization/policyExemptions/readme.md | 2 +- .../policyExemptions/resourceGroup/deploy.bicep | 2 +- .../policyExemptions/resourceGroup/readme.md | 2 +- .../policyExemptions/subscription/deploy.bicep | 2 +- .../policyExemptions/subscription/readme.md | 2 +- .../automationAccounts/.bicep/nested_linkedService.bicep | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/arm/Microsoft.Authorization/policyExemptions/deploy.bicep b/arm/Microsoft.Authorization/policyExemptions/deploy.bicep index 707c60191d..2a54b37c77 100644 --- a/arm/Microsoft.Authorization/policyExemptions/deploy.bicep +++ b/arm/Microsoft.Authorization/policyExemptions/deploy.bicep @@ -27,7 +27,7 @@ param policyAssignmentId string @sys.description('Optional. The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.') param policyDefinitionReferenceIds array = [] -@sys.description('Optional. The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z ') +@sys.description('Optional. The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z.') param expiresOn string = '' @sys.description('Optional. The group ID of the management group to be exempted from the policy assignment. If not provided, will use the current scope for deployment.') diff --git a/arm/Microsoft.Authorization/policyExemptions/managementGroup/deploy.bicep b/arm/Microsoft.Authorization/policyExemptions/managementGroup/deploy.bicep index 1136f4b082..1e0318589b 100644 --- a/arm/Microsoft.Authorization/policyExemptions/managementGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/policyExemptions/managementGroup/deploy.bicep @@ -27,7 +27,7 @@ param policyAssignmentId string @sys.description('Optional. The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.') param policyDefinitionReferenceIds array = [] -@sys.description('Optional. The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z ') +@sys.description('Optional. The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z.') param expiresOn string = '' @sys.description('Optional. The group ID of the management group to be exempted from the policy assignment. If not provided, will use the current scope for deployment.') diff --git a/arm/Microsoft.Authorization/policyExemptions/managementGroup/readme.md b/arm/Microsoft.Authorization/policyExemptions/managementGroup/readme.md index c3735ca00b..d3deb48a4d 100644 --- a/arm/Microsoft.Authorization/policyExemptions/managementGroup/readme.md +++ b/arm/Microsoft.Authorization/policyExemptions/managementGroup/readme.md @@ -29,7 +29,7 @@ With this module you can create policy exemptions on a management group level. | `displayName` | string | `''` | | The display name of the policy assignment. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated. | -| `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z | +| `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z. | | `location` | string | `[deployment().location]` | | Location deployment metadata. | | `managementGroupId` | string | `[managementGroup().name]` | | The group ID of the management group to be exempted from the policy assignment. If not provided, will use the current scope for deployment. | | `metadata` | object | `{object}` | | The policy exemption metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | diff --git a/arm/Microsoft.Authorization/policyExemptions/readme.md b/arm/Microsoft.Authorization/policyExemptions/readme.md index 79c453fc8f..c0e3277c2d 100644 --- a/arm/Microsoft.Authorization/policyExemptions/readme.md +++ b/arm/Microsoft.Authorization/policyExemptions/readme.md @@ -31,7 +31,7 @@ With this module you can create policy exemptions across the management group, s | `displayName` | string | `''` | | The display name of the policy exemption. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated. | -| `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z | +| `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z. | | `location` | string | `[deployment().location]` | | Location deployment metadata. | | `managementGroupId` | string | `[managementGroup().name]` | | The group ID of the management group to be exempted from the policy assignment. If not provided, will use the current scope for deployment. | | `metadata` | object | `{object}` | | The policy exemption metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | diff --git a/arm/Microsoft.Authorization/policyExemptions/resourceGroup/deploy.bicep b/arm/Microsoft.Authorization/policyExemptions/resourceGroup/deploy.bicep index 43bd651eab..6941d76608 100644 --- a/arm/Microsoft.Authorization/policyExemptions/resourceGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/policyExemptions/resourceGroup/deploy.bicep @@ -27,7 +27,7 @@ param policyAssignmentId string @sys.description('Optional. The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.') param policyDefinitionReferenceIds array = [] -@sys.description('Optional. The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z ') +@sys.description('Optional. The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z.') param expiresOn string = '' @sys.description('Optional. The subscription ID of the subscription to be exempted from the policy assignment. If not provided, will use the current scope for deployment.') diff --git a/arm/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md b/arm/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md index f94e6b2b74..a5487847a0 100644 --- a/arm/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md +++ b/arm/Microsoft.Authorization/policyExemptions/resourceGroup/readme.md @@ -29,7 +29,7 @@ With this module you can create policy exemptions on a resource group level. | `displayName` | string | `''` | | The display name of the policy exemption. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated. | -| `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z | +| `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z. | | `metadata` | object | `{object}` | | The policy exemption metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `policyDefinitionReferenceIds` | array | `[]` | | The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. | | `resourceGroupName` | string | `[resourceGroup().name]` | | The name of the resource group to be exempted from the policy assignment. If not provided, will use the current scope for deployment. | diff --git a/arm/Microsoft.Authorization/policyExemptions/subscription/deploy.bicep b/arm/Microsoft.Authorization/policyExemptions/subscription/deploy.bicep index c510b3cb51..be4535a126 100644 --- a/arm/Microsoft.Authorization/policyExemptions/subscription/deploy.bicep +++ b/arm/Microsoft.Authorization/policyExemptions/subscription/deploy.bicep @@ -27,7 +27,7 @@ param policyAssignmentId string @sys.description('Optional. The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition.') param policyDefinitionReferenceIds array = [] -@sys.description('Optional. The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z ') +@sys.description('Optional. The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z.') param expiresOn string = '' @sys.description('Optional. The subscription ID of the subscription to be exempted from the policy assignment. If not provided, will use the current scope for deployment.') diff --git a/arm/Microsoft.Authorization/policyExemptions/subscription/readme.md b/arm/Microsoft.Authorization/policyExemptions/subscription/readme.md index 1e5601bd1d..2a2e6a36e7 100644 --- a/arm/Microsoft.Authorization/policyExemptions/subscription/readme.md +++ b/arm/Microsoft.Authorization/policyExemptions/subscription/readme.md @@ -29,7 +29,7 @@ With this module you can create policy exemptions on a subscription level. | `displayName` | string | `''` | | The display name of the policy exemption. Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `exemptionCategory` | string | `'Mitigated'` | `[Mitigated, Waiver]` | The policy exemption category. Possible values are Waiver and Mitigated. Default is Mitigated. | -| `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z | +| `expiresOn` | string | `''` | | The expiration date and time (in UTC ISO 8601 format yyyy-MM-ddTHH:mm:ssZ) of the policy exemption. e.g. 2021-10-02T03:57:00.000Z. | | `location` | string | `[deployment().location]` | | Location deployment metadata. | | `metadata` | object | `{object}` | | The policy exemption metadata. Metadata is an open ended object and is typically a collection of key-value pairs. | | `policyDefinitionReferenceIds` | array | `[]` | | The policy definition reference ID list when the associated policy assignment is an assignment of a policy set definition. | diff --git a/arm/Microsoft.Automation/automationAccounts/.bicep/nested_linkedService.bicep b/arm/Microsoft.Automation/automationAccounts/.bicep/nested_linkedService.bicep index a5db7f1425..651118484b 100644 --- a/arm/Microsoft.Automation/automationAccounts/.bicep/nested_linkedService.bicep +++ b/arm/Microsoft.Automation/automationAccounts/.bicep/nested_linkedService.bicep @@ -7,7 +7,7 @@ param logAnalyticsWorkspaceName string @description('Required. The resource ID of the resource that will be linked to the workspace. This should be used for linking resources which require read access.') param resourceId string = '' -@description('Optional. The resource ID of the resource that will be linked to the workspace. This should be used for linking resources which require write access. ') +@description('Optional. The resource ID of the resource that will be linked to the workspace. This should be used for linking resources which require write access.') param writeAccessResourceId string = '' @description('Optional. Tags to configure in the resource.') From 6620b40c87a78400553136cf7ae5330665061a84 Mon Sep 17 00:00:00 2001 From: Erika Gressi Date: Tue, 17 May 2022 19:29:37 +0200 Subject: [PATCH 6/7] add new test --- arm/.global/global.module.tests.ps1 | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/arm/.global/global.module.tests.ps1 b/arm/.global/global.module.tests.ps1 index df57354dff..f876c834f5 100644 --- a/arm/.global/global.module.tests.ps1 +++ b/arm/.global/global.module.tests.ps1 @@ -764,7 +764,7 @@ Describe 'Deployment template tests' -Tag Template { $outputs | Should -Contain 'resourceId' } - It "[] parameters' description shoud start with a one word category followed by a dot, a space and the actual description text ending with a dot." -TestCases $deploymentFolderTestCases { + It "[] parameters' description should start with a one word category followed by a dot, a space and the actual description text ending with a dot." -TestCases $deploymentFolderTestCases { param( $moduleFolderName, $templateContent @@ -787,6 +787,29 @@ Describe 'Deployment template tests' -Tag Template { $IncorrectParameters | Should -BeNullOrEmpty } + It "[] outputs' description should start with a capital letter and contain text ending with a dot." -TestCases $deploymentFolderTestCases { + param( + $moduleFolderName, + $templateContent + ) + + if (-not $templateContent.outputs) { + # Skip test + $true | Should -Be $true + return + } + + $incorrectOutputs = @() + $templateOutputs = $templateContent.outputs.Keys + foreach ($output in $templateOutputs) { + $data = ($templateContent.outputs.$output.metadata).description + if ($data -notmatch '^[A-Z].+\.$') { + $incorrectOutputs += $output + } + } + $incorrectOutputs | Should -BeNullOrEmpty + } + # PARAMETER Tests It '[] All parameters in parameters files exist in template file (deploy.json)' -TestCases $deploymentFolderTestCases { param ( From 75468335833b27545189daab23aeae847035abe8 Mon Sep 17 00:00:00 2001 From: Erika Gressi Date: Tue, 17 May 2022 19:41:07 +0200 Subject: [PATCH 7/7] align param description regex --- arm/.global/global.module.tests.ps1 | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/arm/.global/global.module.tests.ps1 b/arm/.global/global.module.tests.ps1 index f876c834f5..6a2bdb822c 100644 --- a/arm/.global/global.module.tests.ps1 +++ b/arm/.global/global.module.tests.ps1 @@ -764,7 +764,7 @@ Describe 'Deployment template tests' -Tag Template { $outputs | Should -Contain 'resourceId' } - It "[] parameters' description should start with a one word category followed by a dot, a space and the actual description text ending with a dot." -TestCases $deploymentFolderTestCases { + It "[] parameters' description should start with a one word category starting with a capital letter, followed by a dot, a space and the actual description text ending with a dot." -TestCases $deploymentFolderTestCases { param( $moduleFolderName, $templateContent @@ -776,15 +776,15 @@ Describe 'Deployment template tests' -Tag Template { return } - $IncorrectParameters = @() - $Paramdescoutput = $templateContent.parameters.Keys - foreach ($Param in $Paramdescoutput) { - $Data = ($templateContent.parameters.$Param.metadata).description - if ($Data -notmatch '^[a-zA-Z]+\. .+\.$') { - $IncorrectParameters += $Param + $incorrectParameters = @() + $templateParameters = $templateContent.parameters.Keys + foreach ($parameter in $templateParameters) { + $data = ($templateContent.parameters.$parameter.metadata).description + if ($data -notmatch '^[A-Z][a-zA-Z]+\. .+\.$') { + $incorrectParameters += $parameter } } - $IncorrectParameters | Should -BeNullOrEmpty + $incorrectParameters | Should -BeNullOrEmpty } It "[] outputs' description should start with a capital letter and contain text ending with a dot." -TestCases $deploymentFolderTestCases {