From 03d84c78b34bf1792165b164a9ba8c3e9e2cc622 Mon Sep 17 00:00:00 2001 From: Kris Baranek Date: Sun, 3 Dec 2023 00:12:00 +0100 Subject: [PATCH] Readme update --- avm/res/network/public-ip-prefix/README.md | 132 +++++++++++++-------- 1 file changed, 84 insertions(+), 48 deletions(-) diff --git a/avm/res/network/public-ip-prefix/README.md b/avm/res/network/public-ip-prefix/README.md index b64be7421f..9a63cf9d4e 100644 --- a/avm/res/network/public-ip-prefix/README.md +++ b/avm/res/network/public-ip-prefix/README.md @@ -277,9 +277,24 @@ module publicIpPrefix 'br/public:avm/res/network/public-ip-prefix:' = { | [`roleAssignments`](#parameter-roleassignments) | array | Array of role assignments to create. | | [`tags`](#parameter-tags) | object | Tags of the resource. | +### Parameter: `name` + +Name of the Public IP Prefix. + +- Required: Yes +- Type: string + +### Parameter: `prefixLength` + +Length of the Public IP Prefix. + +- Required: Yes +- Type: int + ### Parameter: `customIPPrefix` The customIpPrefix that this prefix is associated with. A custom IP address prefix is a contiguous range of IP addresses owned by an external customer and provisioned into a subscription. When a custom IP prefix is in Provisioned, Commissioning, or Commissioned state, a linked public IP prefix can be created. Either as a subset of the custom IP prefix range or the entire range. + - Required: No - Type: object - Default: `{}` @@ -287,6 +302,7 @@ The customIpPrefix that this prefix is associated with. A custom IP address pref ### Parameter: `enableTelemetry` Enable/Disable usage telemetry for module. + - Required: No - Type: bool - Default: `True` @@ -294,6 +310,7 @@ Enable/Disable usage telemetry for module. ### Parameter: `location` Location for all resources. + - Required: No - Type: string - Default: `[resourceGroup().location]` @@ -301,113 +318,132 @@ Location for all resources. ### Parameter: `lock` The lock settings of the service. + - Required: No - Type: object +**Optional parameters** -| Name | Required | Type | Description | -| :-- | :-- | :--| :-- | -| [`kind`](#parameter-lockkind) | No | string | Optional. Specify the type of lock. | -| [`name`](#parameter-lockname) | No | string | Optional. Specify the name of lock. | +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`kind`](#parameter-lockkind) | string | Specify the type of lock. | +| [`name`](#parameter-lockname) | string | Specify the name of lock. | ### Parameter: `lock.kind` -Optional. Specify the type of lock. +Specify the type of lock. - Required: No - Type: string -- Allowed: `[CanNotDelete, None, ReadOnly]` +- Allowed: + ```Bicep + [ + 'CanNotDelete' + 'None' + 'ReadOnly' + ] + ``` ### Parameter: `lock.name` -Optional. Specify the name of lock. +Specify the name of lock. - Required: No - Type: string -### Parameter: `name` - -Name of the Public IP Prefix. -- Required: Yes -- Type: string - -### Parameter: `prefixLength` - -Length of the Public IP Prefix. -- Required: Yes -- Type: int - ### Parameter: `roleAssignments` Array of role assignments to create. + - Required: No - Type: array +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`principalId`](#parameter-roleassignmentsprincipalid) | string | The principal ID of the principal (user/group/identity) to assign the role to. | +| [`roleDefinitionIdOrName`](#parameter-roleassignmentsroledefinitionidorname) | string | The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | -| Name | Required | Type | Description | -| :-- | :-- | :--| :-- | -| [`condition`](#parameter-roleassignmentscondition) | No | string | Optional. The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container" | -| [`conditionVersion`](#parameter-roleassignmentsconditionversion) | No | string | Optional. Version of the condition. | -| [`delegatedManagedIdentityResourceId`](#parameter-roleassignmentsdelegatedmanagedidentityresourceid) | No | string | Optional. The Resource Id of the delegated managed identity resource. | -| [`description`](#parameter-roleassignmentsdescription) | No | string | Optional. The description of the role assignment. | -| [`principalId`](#parameter-roleassignmentsprincipalid) | Yes | string | Required. The principal ID of the principal (user/group/identity) to assign the role to. | -| [`principalType`](#parameter-roleassignmentsprincipaltype) | No | string | Optional. The principal type of the assigned principal ID. | -| [`roleDefinitionIdOrName`](#parameter-roleassignmentsroledefinitionidorname) | Yes | string | Required. The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. | +**Optional parameters** -### Parameter: `roleAssignments.condition` +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`condition`](#parameter-roleassignmentscondition) | string | The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container" | +| [`conditionVersion`](#parameter-roleassignmentsconditionversion) | string | Version of the condition. | +| [`delegatedManagedIdentityResourceId`](#parameter-roleassignmentsdelegatedmanagedidentityresourceid) | string | The Resource Id of the delegated managed identity resource. | +| [`description`](#parameter-roleassignmentsdescription) | string | The description of the role assignment. | +| [`principalType`](#parameter-roleassignmentsprincipaltype) | string | The principal type of the assigned principal ID. | + +### Parameter: `roleAssignments.principalId` -Optional. The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container" +The principal ID of the principal (user/group/identity) to assign the role to. -- Required: No +- Required: Yes - Type: string -### Parameter: `roleAssignments.conditionVersion` +### Parameter: `roleAssignments.roleDefinitionIdOrName` -Optional. Version of the condition. +The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. -- Required: No +- Required: Yes - Type: string -- Allowed: `[2.0]` -### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` +### Parameter: `roleAssignments.condition` -Optional. The Resource Id of the delegated managed identity resource. +The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container" - Required: No - Type: string -### Parameter: `roleAssignments.description` +### Parameter: `roleAssignments.conditionVersion` -Optional. The description of the role assignment. +Version of the condition. - Required: No - Type: string +- Allowed: + ```Bicep + [ + '2.0' + ] + ``` -### Parameter: `roleAssignments.principalId` +### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` -Required. The principal ID of the principal (user/group/identity) to assign the role to. +The Resource Id of the delegated managed identity resource. -- Required: Yes +- Required: No - Type: string -### Parameter: `roleAssignments.principalType` +### Parameter: `roleAssignments.description` -Optional. The principal type of the assigned principal ID. +The description of the role assignment. - Required: No - Type: string -- Allowed: `[Device, ForeignGroup, Group, ServicePrincipal, User]` -### Parameter: `roleAssignments.roleDefinitionIdOrName` +### Parameter: `roleAssignments.principalType` -Required. The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. +The principal type of the assigned principal ID. -- Required: Yes +- Required: No - Type: string +- Allowed: + ```Bicep + [ + 'Device' + 'ForeignGroup' + 'Group' + 'ServicePrincipal' + 'User' + ] + ``` ### Parameter: `tags` Tags of the resource. + - Required: No - Type: object