From 81870d067b6cd839f0893e3d763fe4affd128f9b Mon Sep 17 00:00:00 2001 From: Erika Gressi Date: Thu, 19 May 2022 16:42:59 +0200 Subject: [PATCH 1/2] add dots --- arm/Microsoft.Authorization/roleAssignments/deploy.bicep | 2 +- .../roleAssignments/managementGroup/deploy.bicep | 2 +- .../roleAssignments/resourceGroup/deploy.bicep | 2 +- .../roleAssignments/subscription/deploy.bicep | 2 +- .../applicationgroups/deploy.bicep | 2 +- arm/Microsoft.MachineLearningServices/workspaces/deploy.bicep | 2 +- arm/Microsoft.NetApp/netAppAccounts/deploy.bicep | 2 +- .../bastionHosts/.bicep/nested_publicIPAddress.bicep | 2 +- arm/Microsoft.Network/privateDnsZones/A/deploy.bicep | 2 +- arm/Microsoft.Network/privateDnsZones/AAAA/deploy.bicep | 2 +- arm/Microsoft.Network/privateDnsZones/CNAME/deploy.bicep | 2 +- arm/Microsoft.Network/privateDnsZones/MX/deploy.bicep | 2 +- arm/Microsoft.Network/privateDnsZones/PTR/deploy.bicep | 2 +- arm/Microsoft.Network/privateDnsZones/SOA/deploy.bicep | 2 +- arm/Microsoft.Network/privateDnsZones/SRV/deploy.bicep | 2 +- arm/Microsoft.Network/privateDnsZones/TXT/deploy.bicep | 2 +- .../Microsoft.Compute/virtualMachinesMultiple/deploy.bicep | 2 +- docs/wiki/The library - Module design.md | 2 +- 18 files changed, 18 insertions(+), 18 deletions(-) diff --git a/arm/Microsoft.Authorization/roleAssignments/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/deploy.bicep index 9717ee05b4..a37d6815b9 100644 --- a/arm/Microsoft.Authorization/roleAssignments/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/deploy.bicep @@ -1,6 +1,6 @@ targetScope = 'managementGroup' -@sys.description('Required. 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\'') +@sys.description('Required. 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\'.') param roleDefinitionIdOrName string @sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity)') diff --git a/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep index 356e891cab..5d7a743c0c 100644 --- a/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep @@ -1,6 +1,6 @@ targetScope = 'managementGroup' -@sys.description('Required. 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\'') +@sys.description('Required. 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\'.') param roleDefinitionIdOrName string @sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity)') diff --git a/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep index 6e65bd5d34..da1b9e4a9a 100644 --- a/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep @@ -1,6 +1,6 @@ targetScope = 'resourceGroup' -@sys.description('Required. 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\'') +@sys.description('Required. 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\'.') param roleDefinitionIdOrName string @sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity)') diff --git a/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep index 623229a5bf..dfec959e08 100644 --- a/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep @@ -1,6 +1,6 @@ targetScope = 'subscription' -@sys.description('Required. 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\'') +@sys.description('Required. 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\'.') param roleDefinitionIdOrName string @sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity)') diff --git a/arm/Microsoft.DesktopVirtualization/applicationgroups/deploy.bicep b/arm/Microsoft.DesktopVirtualization/applicationgroups/deploy.bicep index 6b305a6a2b..c2611431cd 100644 --- a/arm/Microsoft.DesktopVirtualization/applicationgroups/deploy.bicep +++ b/arm/Microsoft.DesktopVirtualization/applicationgroups/deploy.bicep @@ -21,7 +21,7 @@ param friendlyName string = '' @sys.description('Optional. The description of the Application Group to be created.') param description string = '' -@sys.description('Optional. Array of role assignment objects that contain the \'roleDefinitionIdOrName\' and \'principalIds\' 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\'') +@sys.description('Optional. Array of role assignment objects that contain the \'roleDefinitionIdOrName\' and \'principalIds\' 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\'.') param roleAssignments array = [] @sys.description('Optional. Specifies the number of days that logs will be kept for; a value of 0 will retain data indefinitely.') diff --git a/arm/Microsoft.MachineLearningServices/workspaces/deploy.bicep b/arm/Microsoft.MachineLearningServices/workspaces/deploy.bicep index 30993bc327..b627b8f31b 100644 --- a/arm/Microsoft.MachineLearningServices/workspaces/deploy.bicep +++ b/arm/Microsoft.MachineLearningServices/workspaces/deploy.bicep @@ -40,7 +40,7 @@ param hbiWorkspace bool = false @sys.description('Optional. The flag to indicate whether to allow public access when behind VNet.') param allowPublicAccessWhenBehindVnet bool = false -@sys.description('Optional. 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\'') +@sys.description('Optional. 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\'.') param roleAssignments array = [] @sys.description('Optional. Configuration Details for private endpoints.') diff --git a/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep b/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep index fdfc4f3703..5a600d5c95 100644 --- a/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep +++ b/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep @@ -23,7 +23,7 @@ param smbServerNamePrefix string = '' @description('Optional. Capacity pools to create.') param capacityPools array = [] -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] @description('Optional. Location for all resources.') diff --git a/arm/Microsoft.Network/bastionHosts/.bicep/nested_publicIPAddress.bicep b/arm/Microsoft.Network/bastionHosts/.bicep/nested_publicIPAddress.bicep index cc9a0eb90c..9d6ee4e273 100644 --- a/arm/Microsoft.Network/bastionHosts/.bicep/nested_publicIPAddress.bicep +++ b/arm/Microsoft.Network/bastionHosts/.bicep/nested_publicIPAddress.bicep @@ -41,7 +41,7 @@ param lock string = 'NotSpecified' @description('Optional. Location for all resources.') param location string = resourceGroup().location -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] @description('Optional. Tags of the resource.') diff --git a/arm/Microsoft.Network/privateDnsZones/A/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/A/deploy.bicep index 918e2a2e4c..3c88b840e1 100644 --- a/arm/Microsoft.Network/privateDnsZones/A/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/A/deploy.bicep @@ -16,7 +16,7 @@ param ttl int = 3600 @description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).') param enableDefaultTelemetry bool = true -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] resource defaultTelemetry 'Microsoft.Resources/deployments@2021-04-01' = if (enableDefaultTelemetry) { diff --git a/arm/Microsoft.Network/privateDnsZones/AAAA/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/AAAA/deploy.bicep index 9055983598..29c7a66879 100644 --- a/arm/Microsoft.Network/privateDnsZones/AAAA/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/AAAA/deploy.bicep @@ -16,7 +16,7 @@ param ttl int = 3600 @description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).') param enableDefaultTelemetry bool = true -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] resource defaultTelemetry 'Microsoft.Resources/deployments@2021-04-01' = if (enableDefaultTelemetry) { diff --git a/arm/Microsoft.Network/privateDnsZones/CNAME/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/CNAME/deploy.bicep index 819666ba7b..de45e6d935 100644 --- a/arm/Microsoft.Network/privateDnsZones/CNAME/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/CNAME/deploy.bicep @@ -13,7 +13,7 @@ param metadata object = {} @description('Optional. The TTL (time-to-live) of the records in the record set.') param ttl int = 3600 -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] @description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).') diff --git a/arm/Microsoft.Network/privateDnsZones/MX/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/MX/deploy.bicep index 1bb6e60114..3e182064f0 100644 --- a/arm/Microsoft.Network/privateDnsZones/MX/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/MX/deploy.bicep @@ -13,7 +13,7 @@ param mxRecords array = [] @description('Optional. The TTL (time-to-live) of the records in the record set.') param ttl int = 3600 -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] @description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).') diff --git a/arm/Microsoft.Network/privateDnsZones/PTR/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/PTR/deploy.bicep index fdc6d72b3e..cbc32f2f90 100644 --- a/arm/Microsoft.Network/privateDnsZones/PTR/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/PTR/deploy.bicep @@ -13,7 +13,7 @@ param ptrRecords array = [] @description('Optional. The TTL (time-to-live) of the records in the record set.') param ttl int = 3600 -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] @description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).') diff --git a/arm/Microsoft.Network/privateDnsZones/SOA/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/SOA/deploy.bicep index a89c211971..3bbb21a150 100644 --- a/arm/Microsoft.Network/privateDnsZones/SOA/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/SOA/deploy.bicep @@ -13,7 +13,7 @@ param soaRecord object = {} @description('Optional. The TTL (time-to-live) of the records in the record set.') param ttl int = 3600 -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] @description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).') diff --git a/arm/Microsoft.Network/privateDnsZones/SRV/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/SRV/deploy.bicep index 1ffde640db..d17d2468bf 100644 --- a/arm/Microsoft.Network/privateDnsZones/SRV/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/SRV/deploy.bicep @@ -13,7 +13,7 @@ param srvRecords array = [] @description('Optional. The TTL (time-to-live) of the records in the record set.') param ttl int = 3600 -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] @description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).') diff --git a/arm/Microsoft.Network/privateDnsZones/TXT/deploy.bicep b/arm/Microsoft.Network/privateDnsZones/TXT/deploy.bicep index 8bf49155c0..f4b71e4bb0 100644 --- a/arm/Microsoft.Network/privateDnsZones/TXT/deploy.bicep +++ b/arm/Microsoft.Network/privateDnsZones/TXT/deploy.bicep @@ -13,7 +13,7 @@ param ttl int = 3600 @description('Optional. The list of TXT records in the record set.') param txtRecords array = [] -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] @description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).') diff --git a/constructs/Microsoft.Compute/virtualMachinesMultiple/deploy.bicep b/constructs/Microsoft.Compute/virtualMachinesMultiple/deploy.bicep index f9c8484976..1393c31784 100644 --- a/constructs/Microsoft.Compute/virtualMachinesMultiple/deploy.bicep +++ b/constructs/Microsoft.Compute/virtualMachinesMultiple/deploy.bicep @@ -254,7 +254,7 @@ param diagnosticEventHubName string = '' @description('Optional. Specify the type of lock.') param lock string = 'NotSpecified' -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] @description('Optional. Tags of the resource.') diff --git a/docs/wiki/The library - Module design.md b/docs/wiki/The library - Module design.md index caf9b2a67a..c42a00b564 100644 --- a/docs/wiki/The library - Module design.md +++ b/docs/wiki/The library - Module design.md @@ -157,7 +157,7 @@ The RBAC deployment has 2 elements to it. A module that contains the implementat #### 1st Element in main resource ```bicep -@description('Optional. 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\'') +@description('Optional. 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\'.') param roleAssignments array = [] module _rbac '.bicep/nested_rbac.bicep' = [for (roleAssignment, index) in roleAssignments: { From 4352abe3b0d12669aebbfb004dd538f13d5e9c2d Mon Sep 17 00:00:00 2001 From: Erika Gressi Date: Fri, 20 May 2022 02:05:08 +0200 Subject: [PATCH 2/2] additional dots --- arm/Microsoft.Authorization/policySetDefinitions/deploy.bicep | 2 +- .../policySetDefinitions/managementGroup/deploy.bicep | 2 +- .../policySetDefinitions/managementGroup/readme.md | 2 +- arm/Microsoft.Authorization/policySetDefinitions/readme.md | 2 +- .../policySetDefinitions/subscription/deploy.bicep | 2 +- .../policySetDefinitions/subscription/readme.md | 2 +- arm/Microsoft.Authorization/roleAssignments/deploy.bicep | 2 +- .../roleAssignments/managementGroup/deploy.bicep | 2 +- .../roleAssignments/managementGroup/readme.md | 2 +- arm/Microsoft.Authorization/roleAssignments/readme.md | 2 +- .../roleAssignments/resourceGroup/deploy.bicep | 2 +- .../roleAssignments/resourceGroup/readme.md | 2 +- .../roleAssignments/subscription/deploy.bicep | 2 +- .../roleAssignments/subscription/readme.md | 2 +- arm/Microsoft.NetApp/netAppAccounts/deploy.bicep | 2 +- arm/Microsoft.NetApp/netAppAccounts/readme.md | 2 +- 16 files changed, 16 insertions(+), 16 deletions(-) diff --git a/arm/Microsoft.Authorization/policySetDefinitions/deploy.bicep b/arm/Microsoft.Authorization/policySetDefinitions/deploy.bicep index 547f880c5b..9d2d553998 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/deploy.bicep +++ b/arm/Microsoft.Authorization/policySetDefinitions/deploy.bicep @@ -8,7 +8,7 @@ param name string @maxLength(128) param displayName string = '' -@sys.description('Optional. The description name of the Set Definition (Initiative)') +@sys.description('Optional. The description name of the Set Definition (Initiative).') param description string = '' @sys.description('Optional. The group ID of the Management Group (Scope). If not provided, will use the current scope for deployment.') diff --git a/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/deploy.bicep b/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/deploy.bicep index 6a2162d57c..e477cb8161 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/deploy.bicep @@ -8,7 +8,7 @@ param name string @maxLength(128) param displayName string = '' -@sys.description('Optional. The description name of the Set Definition (Initiative)') +@sys.description('Optional. The description name of the Set Definition (Initiative).') param description string = '' @sys.description('Optional. The group ID of the Management Group. If not provided, will use the current scope for deployment.') diff --git a/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md b/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md index 1da3a9a4d7..30ffcb68a4 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md +++ b/arm/Microsoft.Authorization/policySetDefinitions/managementGroup/readme.md @@ -25,7 +25,7 @@ With this module you can create policy set definitions on a management group lev **Optional parameters** | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | -| `description` | string | `''` | The description name of the Set Definition (Initiative) | +| `description` | string | `''` | The description name of the Set Definition (Initiative). | | `displayName` | string | `''` | The display name of the Set Definition (Initiative). Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `location` | string | `[deployment().location]` | Location deployment metadata. | diff --git a/arm/Microsoft.Authorization/policySetDefinitions/readme.md b/arm/Microsoft.Authorization/policySetDefinitions/readme.md index 4d52643b36..9ea43f4646 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/readme.md +++ b/arm/Microsoft.Authorization/policySetDefinitions/readme.md @@ -27,7 +27,7 @@ With this module you can create policy set definitions across the management gro **Optional parameters** | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | -| `description` | string | `''` | The description name of the Set Definition (Initiative) | +| `description` | string | `''` | The description name of the Set Definition (Initiative). | | `displayName` | string | `''` | The display name of the Set Definition (Initiative). Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `location` | string | `[deployment().location]` | Location deployment metadata. | diff --git a/arm/Microsoft.Authorization/policySetDefinitions/subscription/deploy.bicep b/arm/Microsoft.Authorization/policySetDefinitions/subscription/deploy.bicep index f261a56ad5..dd74aeab62 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/subscription/deploy.bicep +++ b/arm/Microsoft.Authorization/policySetDefinitions/subscription/deploy.bicep @@ -8,7 +8,7 @@ param name string @maxLength(128) param displayName string = '' -@sys.description('Optional. The description name of the Set Definition (Initiative)') +@sys.description('Optional. The description name of the Set Definition (Initiative).') param description string = '' @sys.description('Optional. The subscription ID of the subscription.') diff --git a/arm/Microsoft.Authorization/policySetDefinitions/subscription/readme.md b/arm/Microsoft.Authorization/policySetDefinitions/subscription/readme.md index 6636329efc..78b1b60421 100644 --- a/arm/Microsoft.Authorization/policySetDefinitions/subscription/readme.md +++ b/arm/Microsoft.Authorization/policySetDefinitions/subscription/readme.md @@ -25,7 +25,7 @@ With this module you can create policy set definitions on a subscription level. **Optional parameters** | Parameter Name | Type | Default Value | Description | | :-- | :-- | :-- | :-- | -| `description` | string | `''` | The description name of the Set Definition (Initiative) | +| `description` | string | `''` | The description name of the Set Definition (Initiative). | | `displayName` | string | `''` | The display name of the Set Definition (Initiative). Maximum length is 128 characters. | | `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). | | `location` | string | `[deployment().location]` | Location deployment metadata. | diff --git a/arm/Microsoft.Authorization/roleAssignments/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/deploy.bicep index a37d6815b9..f7c5fe2036 100644 --- a/arm/Microsoft.Authorization/roleAssignments/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/deploy.bicep @@ -3,7 +3,7 @@ targetScope = 'managementGroup' @sys.description('Required. 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\'.') param roleDefinitionIdOrName string -@sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity)') +@sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity).') param principalId string @sys.description('Optional. Name of the Resource Group to assign the RBAC role to. If Resource Group name is provided, and Subscription ID is provided, the module deploys at resource group level, therefore assigns the provided RBAC role to the resource group.') diff --git a/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep index 5d7a743c0c..638e0b7616 100644 --- a/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/managementGroup/deploy.bicep @@ -3,7 +3,7 @@ targetScope = 'managementGroup' @sys.description('Required. 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\'.') param roleDefinitionIdOrName string -@sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity)') +@sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity).') param principalId string @sys.description('Optional. Group ID of the Management Group to assign the RBAC role to. If not provided, will use the current scope for deployment.') diff --git a/arm/Microsoft.Authorization/roleAssignments/managementGroup/readme.md b/arm/Microsoft.Authorization/roleAssignments/managementGroup/readme.md index 5446a5a7e5..7a2f56e579 100644 --- a/arm/Microsoft.Authorization/roleAssignments/managementGroup/readme.md +++ b/arm/Microsoft.Authorization/roleAssignments/managementGroup/readme.md @@ -19,7 +19,7 @@ With this module you can perform role assignments on a management group level **Required parameters** | Parameter Name | Type | Description | | :-- | :-- | :-- | -| `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity) | +| `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity). | | `roleDefinitionIdOrName` | string | 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'. | **Optional parameters** diff --git a/arm/Microsoft.Authorization/roleAssignments/readme.md b/arm/Microsoft.Authorization/roleAssignments/readme.md index d3e62beb2a..c937f2578e 100644 --- a/arm/Microsoft.Authorization/roleAssignments/readme.md +++ b/arm/Microsoft.Authorization/roleAssignments/readme.md @@ -21,7 +21,7 @@ This module deploys Role Assignments across the management group, subscription o **Required parameters** | Parameter Name | Type | Description | | :-- | :-- | :-- | -| `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity) | +| `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity). | | `roleDefinitionIdOrName` | string | 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'. | **Optional parameters** diff --git a/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep index da1b9e4a9a..b33ae6231c 100644 --- a/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/resourceGroup/deploy.bicep @@ -3,7 +3,7 @@ targetScope = 'resourceGroup' @sys.description('Required. 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\'.') param roleDefinitionIdOrName string -@sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity)') +@sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity).') param principalId string @sys.description('Optional. Name of the Resource Group to assign the RBAC role to. If not provided, will use the current scope for deployment.') diff --git a/arm/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md b/arm/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md index 1d4433ea39..fcd1250e9c 100644 --- a/arm/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md +++ b/arm/Microsoft.Authorization/roleAssignments/resourceGroup/readme.md @@ -19,7 +19,7 @@ With this module you can perform role assignments on a resource group level **Required parameters** | Parameter Name | Type | Description | | :-- | :-- | :-- | -| `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity) | +| `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity). | | `roleDefinitionIdOrName` | string | 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'. | **Optional parameters** diff --git a/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep b/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep index dfec959e08..0a3a5ecf26 100644 --- a/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep +++ b/arm/Microsoft.Authorization/roleAssignments/subscription/deploy.bicep @@ -3,7 +3,7 @@ targetScope = 'subscription' @sys.description('Required. 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\'.') param roleDefinitionIdOrName string -@sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity)') +@sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity).') param principalId string @sys.description('Optional. Subscription ID of the subscription to assign the RBAC role to. If not provided, will use the current scope for deployment.') diff --git a/arm/Microsoft.Authorization/roleAssignments/subscription/readme.md b/arm/Microsoft.Authorization/roleAssignments/subscription/readme.md index 58d2ff8ca2..a9ec982e90 100644 --- a/arm/Microsoft.Authorization/roleAssignments/subscription/readme.md +++ b/arm/Microsoft.Authorization/roleAssignments/subscription/readme.md @@ -19,7 +19,7 @@ With this module you can perform role assignments on a subscription level **Required parameters** | Parameter Name | Type | Description | | :-- | :-- | :-- | -| `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity) | +| `principalId` | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity). | | `roleDefinitionIdOrName` | string | 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'. | **Optional parameters** diff --git a/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep b/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep index 5a600d5c95..2f670a5681 100644 --- a/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep +++ b/arm/Microsoft.NetApp/netAppAccounts/deploy.bicep @@ -1,7 +1,7 @@ @description('Required. The name of the NetApp account.') param name string -@description('Optional. Fully Qualified Active Directory DNS Domain Name (e.g. \'contoso.com\')') +@description('Optional. Fully Qualified Active Directory DNS Domain Name (e.g. \'contoso.com\').') 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.') diff --git a/arm/Microsoft.NetApp/netAppAccounts/readme.md b/arm/Microsoft.NetApp/netAppAccounts/readme.md index 38726c23b7..1c3829c9ba 100644 --- a/arm/Microsoft.NetApp/netAppAccounts/readme.md +++ b/arm/Microsoft.NetApp/netAppAccounts/readme.md @@ -33,7 +33,7 @@ This template deploys Azure NetApp Files. | `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. | | `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') | +| `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. |