From 6c06b687575e83b469a45d6887c7da01549378fd Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 14:27:56 +0100 Subject: [PATCH 01/43] Added Variant support --- .../insights/data-collection-rule/README.md | 326 +++++++++++++++++- .../insights/data-collection-rule/main.bicep | 1 + .../sharedScripts/Set-ModuleReadMe.ps1 | 46 +++ 3 files changed, 364 insertions(+), 9 deletions(-) diff --git a/avm/res/insights/data-collection-rule/README.md b/avm/res/insights/data-collection-rule/README.md index 073628f6c0..cd0ed3f07d 100644 --- a/avm/res/insights/data-collection-rule/README.md +++ b/avm/res/insights/data-collection-rule/README.md @@ -8,7 +8,6 @@ This module deploys a Data Collection Rule. - [Usage examples](#Usage-examples) - [Parameters](#Parameters) - [Outputs](#Outputs) -- [Cross-referenced modules](#Cross-referenced-modules) - [Data Collection](#Data-Collection) ## Resource Types @@ -2815,6 +2814,323 @@ The kind of data collection rule. - Required: Yes - Type: object +- Type deciding property: kind + +| Variant | Description | +| :-- | :-- | +| [`Linux`](#variant-datacollectionruleproperties-linux) | Type for a Linux DSR collection rule. | +| [`Windows`](#variant-datacollectionruleproperties-windows) | | +| [`All`](#variant-datacollectionruleproperties-all) | | +| [`AgentSettings`](#variant-datacollectionruleproperties-agentsettings) | | + +### Variant: `dataCollectionRuleProperties-Linux` +To use this variant, choose the value `Linux` for the property `kind`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`dataFlows`](#variant-datacollectionruleproperties-linuxdataflows) | array | The specification of data flows. | +| [`dataSources`](#variant-datacollectionruleproperties-linuxdatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#variant-datacollectionruleproperties-linuxdestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#variant-datacollectionruleproperties-linuxkind) | string | The platform type specifies the type of resources this rule can apply to. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties-linuxdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#variant-datacollectionruleproperties-linuxdescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#variant-datacollectionruleproperties-linuxstreamdeclarations) | object | Declaration of custom streams used in this rule. | + +### Parameter: `dataCollectionRuleProperties-Linux.dataFlows` + +The specification of data flows. + +- Required: Yes +- Type: array + +### Parameter: `dataCollectionRuleProperties-Linux.dataSources` + +Specification of data sources that will be collected. + +- Required: Yes +- Type: object + +### Parameter: `dataCollectionRuleProperties-Linux.destinations` + +Specification of destinations that can be used in data flows. + +- Required: Yes +- Type: object + +### Parameter: `dataCollectionRuleProperties-Linux.kind` + +The platform type specifies the type of resources this rule can apply to. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Linux' + ] + ``` + +### Parameter: `dataCollectionRuleProperties-Linux.dataCollectionEndpointResourceId` + +The resource ID of the data collection endpoint that this rule can be used with. + +- Required: No +- Type: string + +### Parameter: `dataCollectionRuleProperties-Linux.description` + +Description of the data collection rule. + +- Required: No +- Type: string + +### Parameter: `dataCollectionRuleProperties-Linux.streamDeclarations` + +Declaration of custom streams used in this rule. + +- Required: No +- Type: object + +### Variant: `dataCollectionRuleProperties-Windows` +To use this variant, choose the value `Windows` for the property `kind`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`dataFlows`](#variant-datacollectionruleproperties-windowsdataflows) | array | The specification of data flows. | +| [`dataSources`](#variant-datacollectionruleproperties-windowsdatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#variant-datacollectionruleproperties-windowsdestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#variant-datacollectionruleproperties-windowskind) | string | The platform type specifies the type of resources this rule can apply to. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties-windowsdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#variant-datacollectionruleproperties-windowsdescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#variant-datacollectionruleproperties-windowsstreamdeclarations) | object | Declaration of custom streams used in this rule. | + +### Parameter: `dataCollectionRuleProperties-Windows.dataFlows` + +The specification of data flows. + +- Required: Yes +- Type: array + +### Parameter: `dataCollectionRuleProperties-Windows.dataSources` + +Specification of data sources that will be collected. + +- Required: Yes +- Type: object + +### Parameter: `dataCollectionRuleProperties-Windows.destinations` + +Specification of destinations that can be used in data flows. + +- Required: Yes +- Type: object + +### Parameter: `dataCollectionRuleProperties-Windows.kind` + +The platform type specifies the type of resources this rule can apply to. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Windows' + ] + ``` + +### Parameter: `dataCollectionRuleProperties-Windows.dataCollectionEndpointResourceId` + +The resource ID of the data collection endpoint that this rule can be used with. + +- Required: No +- Type: string + +### Parameter: `dataCollectionRuleProperties-Windows.description` + +Description of the data collection rule. + +- Required: No +- Type: string + +### Parameter: `dataCollectionRuleProperties-Windows.streamDeclarations` + +Declaration of custom streams used in this rule. + +- Required: No +- Type: object + +### Variant: `dataCollectionRuleProperties-All` +To use this variant, choose the value `All` for the property `kind`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`dataFlows`](#variant-datacollectionruleproperties-alldataflows) | array | The specification of data flows. | +| [`dataSources`](#variant-datacollectionruleproperties-alldatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#variant-datacollectionruleproperties-alldestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#variant-datacollectionruleproperties-allkind) | string | The platform type specifies the type of resources this rule can apply to. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties-alldatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#variant-datacollectionruleproperties-alldescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#variant-datacollectionruleproperties-allstreamdeclarations) | object | Declaration of custom streams used in this rule. | + +### Parameter: `dataCollectionRuleProperties-All.dataFlows` + +The specification of data flows. + +- Required: Yes +- Type: array + +### Parameter: `dataCollectionRuleProperties-All.dataSources` + +Specification of data sources that will be collected. + +- Required: Yes +- Type: object + +### Parameter: `dataCollectionRuleProperties-All.destinations` + +Specification of destinations that can be used in data flows. + +- Required: Yes +- Type: object + +### Parameter: `dataCollectionRuleProperties-All.kind` + +The platform type specifies the type of resources this rule can apply to. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'All' + ] + ``` + +### Parameter: `dataCollectionRuleProperties-All.dataCollectionEndpointResourceId` + +The resource ID of the data collection endpoint that this rule can be used with. + +- Required: No +- Type: string + +### Parameter: `dataCollectionRuleProperties-All.description` + +Description of the data collection rule. + +- Required: No +- Type: string + +### Parameter: `dataCollectionRuleProperties-All.streamDeclarations` + +Declaration of custom streams used in this rule. + +- Required: No +- Type: object + +### Variant: `dataCollectionRuleProperties-AgentSettings` +To use this variant, choose the value `AgentSettings` for the property `kind`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`agentSettings`](#variant-datacollectionruleproperties-agentsettingsagentsettings) | object | Agent settings used to modify agent behavior on a given host. | +| [`kind`](#variant-datacollectionruleproperties-agentsettingskind) | string | The platform type specifies the type of resources this rule can apply to. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`description`](#variant-datacollectionruleproperties-agentsettingsdescription) | string | Description of the data collection rule. | + +### Parameter: `dataCollectionRuleProperties-AgentSettings.agentSettings` + +Agent settings used to modify agent behavior on a given host. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`logs`](#variant-datacollectionruleproperties-agentsettingsagentsettingslogs) | array | All the settings that are applicable to the logs agent (AMA). | + +### Parameter: `dataCollectionRuleProperties-AgentSettings.agentSettings.logs` + +All the settings that are applicable to the logs agent (AMA). + +- Required: Yes +- Type: array + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`name`](#variant-datacollectionruleproperties-agentsettingsagentsettingslogsname) | string | The name of the agent setting. | +| [`value`](#variant-datacollectionruleproperties-agentsettingsagentsettingslogsvalue) | string | The value of the agent setting. | + +### Parameter: `dataCollectionRuleProperties-AgentSettings.agentSettings.logs.name` + +The name of the agent setting. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'MaxDiskQuotaInMB' + 'UseTimeReceivedForForwardedEvents' + ] + ``` + +### Parameter: `dataCollectionRuleProperties-AgentSettings.agentSettings.logs.value` + +The value of the agent setting. + +- Required: Yes +- Type: string + +### Parameter: `dataCollectionRuleProperties-AgentSettings.kind` + +The platform type specifies the type of resources this rule can apply to. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AgentSettings' + ] + ``` + +### Parameter: `dataCollectionRuleProperties-AgentSettings.description` + +Description of the data collection rule. + +- Required: No +- Type: string ### Parameter: `name` @@ -3023,14 +3339,6 @@ Resource tags. | `resourceId` | string | The resource ID of the dataCollectionRule. | | `systemAssignedMIPrincipalId` | string | The principal ID of the system assigned identity. | -## Cross-referenced modules - -This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs). - -| Reference | Type | -| :-- | :-- | -| `br/public:avm/utl/types/avm-common-types:0.3.0` | Remote reference | - ## Data Collection The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the [repository](https://aka.ms/avm/telemetry). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at . You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. diff --git a/avm/res/insights/data-collection-rule/main.bicep b/avm/res/insights/data-collection-rule/main.bicep index 55797d4a15..58acc0f631 100644 --- a/avm/res/insights/data-collection-rule/main.bicep +++ b/avm/res/insights/data-collection-rule/main.bicep @@ -170,6 +170,7 @@ type dataCollectionRulePropertiesType = | allPlatformsDcrPropertiesType | agentSettingsDcrPropertiesType +@description('Type for a Linux DSR collection rule.') type linuxDcrPropertiesType = { @description('Required. The platform type specifies the type of resources this rule can apply to.') kind: 'Linux' diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index dd7ea68267..b441f6efe4 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -493,6 +493,7 @@ function Set-DefinitionSection { ((-not [String]::IsNullOrEmpty($formattedMaxValue)) ? $formattedMaxValue : $null), ((-not [String]::IsNullOrEmpty($formattedRoleNames)) ? $formattedRoleNames : $null), ((-not [String]::IsNullOrEmpty($formattedExample)) ? $formattedExample : $null), + (($definition.discriminator.propertyName) ? ('- Type deciding property: {0}' -f $definition.discriminator.propertyName) : $null), '' ) | Where-Object { $null -ne $_ } @@ -524,6 +525,51 @@ function Set-DefinitionSection { $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $formattedProperties -ParentName $paramIdentifier -ParentIdentifierLink $paramIdentifierLink -ColumnsInOrder $ColumnsInOrder $listSectionContent += $sectionContent } + } elseif ($definition.type -eq 'object' -and $definition.keys -contains 'discriminator') { + <# + Discriminator type. E.g., + + @discriminator('kind') + type mainType = subTypeA | subTypeB | subTypeC + #> + + $variantTableSectionContent += @( + '| Variant | Description |', + '| :-- | :-- |' + ) + + $variantContent = @() + foreach ($typeVariantName in $definition.discriminator.mapping.Keys) { + $typeVariant = $definition.discriminator.mapping[$typeVariantName] + $resolvedTypeVariant = $TemplateFileContent.definitions[(Split-Path $typeVariant.'$ref' -Leaf)] + $variantDescription = ($resolvedTypeVariant.metadata.description ?? '').Replace("`r`n", '

').Replace("`n", '

') + + $variantIdentifier = '{0}-{1}' -f $paramIdentifier, $typeVariantName + $variantIdentifierHeader = "### Variant: ``$variantIdentifier``" + $variantIdentifierLink = '#{0}' -f ($variantIdentifierHeader -replace '^#+ ', '' -replace '\s', '-' -replace '`|\:', '').ToLower() + + $variantContent += @( + $variantIdentifierHeader, + ('To use this variant, choose the value `{0}` for the property `{1}`.' -f $typeVariantName, $definition.discriminator.propertyName) + '' + ) + + $variantTableSectionContent += ('| [`{0}`]({1}) | {2} |' -f $typeVariantName, $variantIdentifierLink, $variantDescription) + + $definitionSectionInputObject = @{ + TemplateFileContent = $TemplateFileContent + Properties = $resolvedTypeVariant.properties + ParentName = $variantIdentifier + ParentIdentifierLink = $variantIdentifierLink + ColumnsInOrder = $ColumnsInOrder + } + $sectionContent = Set-DefinitionSection @definitionSectionInputObject + $variantContent += $sectionContent + } + + $variantTableSectionContent += '' + $listSectionContent += $variantTableSectionContent + $listSectionContent += $variantContent } } } From dbbfcb32613332b3389aa29cb13b974e1a0b682b Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 15:01:08 +0100 Subject: [PATCH 02/43] Update to latest --- .../insights/data-collection-rule/README.md | 126 +++++++++--------- .../sharedScripts/Set-ModuleReadMe.ps1 | 10 +- 2 files changed, 70 insertions(+), 66 deletions(-) diff --git a/avm/res/insights/data-collection-rule/README.md b/avm/res/insights/data-collection-rule/README.md index cd0ed3f07d..b1af194671 100644 --- a/avm/res/insights/data-collection-rule/README.md +++ b/avm/res/insights/data-collection-rule/README.md @@ -2816,55 +2816,57 @@ The kind of data collection rule. - Type: object - Type deciding property: kind +

The available variants are:

+ | Variant | Description | | :-- | :-- | -| [`Linux`](#variant-datacollectionruleproperties-linux) | Type for a Linux DSR collection rule. | -| [`Windows`](#variant-datacollectionruleproperties-windows) | | -| [`All`](#variant-datacollectionruleproperties-all) | | -| [`AgentSettings`](#variant-datacollectionruleproperties-agentsettings) | | +| [`Linux`](#variant-datacollectionruleproperties.kind-linux) | Type for a Linux DSR collection rule. | +| [`Windows`](#variant-datacollectionruleproperties.kind-windows) | | +| [`All`](#variant-datacollectionruleproperties.kind-all) | | +| [`AgentSettings`](#variant-datacollectionruleproperties.kind-agentsettings) | | -### Variant: `dataCollectionRuleProperties-Linux` +### Variant: `dataCollectionRuleProperties.kind-Linux` To use this variant, choose the value `Linux` for the property `kind`. **Required parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#variant-datacollectionruleproperties-linuxdataflows) | array | The specification of data flows. | -| [`dataSources`](#variant-datacollectionruleproperties-linuxdatasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#variant-datacollectionruleproperties-linuxdestinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#variant-datacollectionruleproperties-linuxkind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#variant-datacollectionruleproperties.kind-linuxdataflows) | array | The specification of data flows. | +| [`dataSources`](#variant-datacollectionruleproperties.kind-linuxdatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#variant-datacollectionruleproperties.kind-linuxdestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#variant-datacollectionruleproperties.kind-linuxkind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties-linuxdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#variant-datacollectionruleproperties-linuxdescription) | string | Description of the data collection rule. | -| [`streamDeclarations`](#variant-datacollectionruleproperties-linuxstreamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties.kind-linuxdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#variant-datacollectionruleproperties.kind-linuxdescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#variant-datacollectionruleproperties.kind-linuxstreamdeclarations) | object | Declaration of custom streams used in this rule. | -### Parameter: `dataCollectionRuleProperties-Linux.dataFlows` +### Parameter: `dataCollectionRuleProperties.kind-Linux.dataFlows` The specification of data flows. - Required: Yes - Type: array -### Parameter: `dataCollectionRuleProperties-Linux.dataSources` +### Parameter: `dataCollectionRuleProperties.kind-Linux.dataSources` Specification of data sources that will be collected. - Required: Yes - Type: object -### Parameter: `dataCollectionRuleProperties-Linux.destinations` +### Parameter: `dataCollectionRuleProperties.kind-Linux.destinations` Specification of destinations that can be used in data flows. - Required: Yes - Type: object -### Parameter: `dataCollectionRuleProperties-Linux.kind` +### Parameter: `dataCollectionRuleProperties.kind-Linux.kind` The platform type specifies the type of resources this rule can apply to. @@ -2877,69 +2879,69 @@ The platform type specifies the type of resources this rule can apply to. ] ``` -### Parameter: `dataCollectionRuleProperties-Linux.dataCollectionEndpointResourceId` +### Parameter: `dataCollectionRuleProperties.kind-Linux.dataCollectionEndpointResourceId` The resource ID of the data collection endpoint that this rule can be used with. - Required: No - Type: string -### Parameter: `dataCollectionRuleProperties-Linux.description` +### Parameter: `dataCollectionRuleProperties.kind-Linux.description` Description of the data collection rule. - Required: No - Type: string -### Parameter: `dataCollectionRuleProperties-Linux.streamDeclarations` +### Parameter: `dataCollectionRuleProperties.kind-Linux.streamDeclarations` Declaration of custom streams used in this rule. - Required: No - Type: object -### Variant: `dataCollectionRuleProperties-Windows` +### Variant: `dataCollectionRuleProperties.kind-Windows` To use this variant, choose the value `Windows` for the property `kind`. **Required parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#variant-datacollectionruleproperties-windowsdataflows) | array | The specification of data flows. | -| [`dataSources`](#variant-datacollectionruleproperties-windowsdatasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#variant-datacollectionruleproperties-windowsdestinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#variant-datacollectionruleproperties-windowskind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#variant-datacollectionruleproperties.kind-windowsdataflows) | array | The specification of data flows. | +| [`dataSources`](#variant-datacollectionruleproperties.kind-windowsdatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#variant-datacollectionruleproperties.kind-windowsdestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#variant-datacollectionruleproperties.kind-windowskind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties-windowsdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#variant-datacollectionruleproperties-windowsdescription) | string | Description of the data collection rule. | -| [`streamDeclarations`](#variant-datacollectionruleproperties-windowsstreamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties.kind-windowsdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#variant-datacollectionruleproperties.kind-windowsdescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#variant-datacollectionruleproperties.kind-windowsstreamdeclarations) | object | Declaration of custom streams used in this rule. | -### Parameter: `dataCollectionRuleProperties-Windows.dataFlows` +### Parameter: `dataCollectionRuleProperties.kind-Windows.dataFlows` The specification of data flows. - Required: Yes - Type: array -### Parameter: `dataCollectionRuleProperties-Windows.dataSources` +### Parameter: `dataCollectionRuleProperties.kind-Windows.dataSources` Specification of data sources that will be collected. - Required: Yes - Type: object -### Parameter: `dataCollectionRuleProperties-Windows.destinations` +### Parameter: `dataCollectionRuleProperties.kind-Windows.destinations` Specification of destinations that can be used in data flows. - Required: Yes - Type: object -### Parameter: `dataCollectionRuleProperties-Windows.kind` +### Parameter: `dataCollectionRuleProperties.kind-Windows.kind` The platform type specifies the type of resources this rule can apply to. @@ -2952,69 +2954,69 @@ The platform type specifies the type of resources this rule can apply to. ] ``` -### Parameter: `dataCollectionRuleProperties-Windows.dataCollectionEndpointResourceId` +### Parameter: `dataCollectionRuleProperties.kind-Windows.dataCollectionEndpointResourceId` The resource ID of the data collection endpoint that this rule can be used with. - Required: No - Type: string -### Parameter: `dataCollectionRuleProperties-Windows.description` +### Parameter: `dataCollectionRuleProperties.kind-Windows.description` Description of the data collection rule. - Required: No - Type: string -### Parameter: `dataCollectionRuleProperties-Windows.streamDeclarations` +### Parameter: `dataCollectionRuleProperties.kind-Windows.streamDeclarations` Declaration of custom streams used in this rule. - Required: No - Type: object -### Variant: `dataCollectionRuleProperties-All` +### Variant: `dataCollectionRuleProperties.kind-All` To use this variant, choose the value `All` for the property `kind`. **Required parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#variant-datacollectionruleproperties-alldataflows) | array | The specification of data flows. | -| [`dataSources`](#variant-datacollectionruleproperties-alldatasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#variant-datacollectionruleproperties-alldestinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#variant-datacollectionruleproperties-allkind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#variant-datacollectionruleproperties.kind-alldataflows) | array | The specification of data flows. | +| [`dataSources`](#variant-datacollectionruleproperties.kind-alldatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#variant-datacollectionruleproperties.kind-alldestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#variant-datacollectionruleproperties.kind-allkind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties-alldatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#variant-datacollectionruleproperties-alldescription) | string | Description of the data collection rule. | -| [`streamDeclarations`](#variant-datacollectionruleproperties-allstreamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties.kind-alldatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#variant-datacollectionruleproperties.kind-alldescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#variant-datacollectionruleproperties.kind-allstreamdeclarations) | object | Declaration of custom streams used in this rule. | -### Parameter: `dataCollectionRuleProperties-All.dataFlows` +### Parameter: `dataCollectionRuleProperties.kind-All.dataFlows` The specification of data flows. - Required: Yes - Type: array -### Parameter: `dataCollectionRuleProperties-All.dataSources` +### Parameter: `dataCollectionRuleProperties.kind-All.dataSources` Specification of data sources that will be collected. - Required: Yes - Type: object -### Parameter: `dataCollectionRuleProperties-All.destinations` +### Parameter: `dataCollectionRuleProperties.kind-All.destinations` Specification of destinations that can be used in data flows. - Required: Yes - Type: object -### Parameter: `dataCollectionRuleProperties-All.kind` +### Parameter: `dataCollectionRuleProperties.kind-All.kind` The platform type specifies the type of resources this rule can apply to. @@ -3027,44 +3029,44 @@ The platform type specifies the type of resources this rule can apply to. ] ``` -### Parameter: `dataCollectionRuleProperties-All.dataCollectionEndpointResourceId` +### Parameter: `dataCollectionRuleProperties.kind-All.dataCollectionEndpointResourceId` The resource ID of the data collection endpoint that this rule can be used with. - Required: No - Type: string -### Parameter: `dataCollectionRuleProperties-All.description` +### Parameter: `dataCollectionRuleProperties.kind-All.description` Description of the data collection rule. - Required: No - Type: string -### Parameter: `dataCollectionRuleProperties-All.streamDeclarations` +### Parameter: `dataCollectionRuleProperties.kind-All.streamDeclarations` Declaration of custom streams used in this rule. - Required: No - Type: object -### Variant: `dataCollectionRuleProperties-AgentSettings` +### Variant: `dataCollectionRuleProperties.kind-AgentSettings` To use this variant, choose the value `AgentSettings` for the property `kind`. **Required parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`agentSettings`](#variant-datacollectionruleproperties-agentsettingsagentsettings) | object | Agent settings used to modify agent behavior on a given host. | -| [`kind`](#variant-datacollectionruleproperties-agentsettingskind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`agentSettings`](#variant-datacollectionruleproperties.kind-agentsettingsagentsettings) | object | Agent settings used to modify agent behavior on a given host. | +| [`kind`](#variant-datacollectionruleproperties.kind-agentsettingskind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`description`](#variant-datacollectionruleproperties-agentsettingsdescription) | string | Description of the data collection rule. | +| [`description`](#variant-datacollectionruleproperties.kind-agentsettingsdescription) | string | Description of the data collection rule. | -### Parameter: `dataCollectionRuleProperties-AgentSettings.agentSettings` +### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings` Agent settings used to modify agent behavior on a given host. @@ -3075,9 +3077,9 @@ Agent settings used to modify agent behavior on a given host. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`logs`](#variant-datacollectionruleproperties-agentsettingsagentsettingslogs) | array | All the settings that are applicable to the logs agent (AMA). | +| [`logs`](#variant-datacollectionruleproperties.kind-agentsettingsagentsettingslogs) | array | All the settings that are applicable to the logs agent (AMA). | -### Parameter: `dataCollectionRuleProperties-AgentSettings.agentSettings.logs` +### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings.logs` All the settings that are applicable to the logs agent (AMA). @@ -3088,10 +3090,10 @@ All the settings that are applicable to the logs agent (AMA). | Parameter | Type | Description | | :-- | :-- | :-- | -| [`name`](#variant-datacollectionruleproperties-agentsettingsagentsettingslogsname) | string | The name of the agent setting. | -| [`value`](#variant-datacollectionruleproperties-agentsettingsagentsettingslogsvalue) | string | The value of the agent setting. | +| [`name`](#variant-datacollectionruleproperties.kind-agentsettingsagentsettingslogsname) | string | The name of the agent setting. | +| [`value`](#variant-datacollectionruleproperties.kind-agentsettingsagentsettingslogsvalue) | string | The value of the agent setting. | -### Parameter: `dataCollectionRuleProperties-AgentSettings.agentSettings.logs.name` +### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings.logs.name` The name of the agent setting. @@ -3105,14 +3107,14 @@ The name of the agent setting. ] ``` -### Parameter: `dataCollectionRuleProperties-AgentSettings.agentSettings.logs.value` +### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings.logs.value` The value of the agent setting. - Required: Yes - Type: string -### Parameter: `dataCollectionRuleProperties-AgentSettings.kind` +### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.kind` The platform type specifies the type of resources this rule can apply to. @@ -3125,7 +3127,7 @@ The platform type specifies the type of resources this rule can apply to. ] ``` -### Parameter: `dataCollectionRuleProperties-AgentSettings.description` +### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.description` Description of the data collection rule. diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index b441f6efe4..44c8c6b2e2 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -534,6 +534,8 @@ function Set-DefinitionSection { #> $variantTableSectionContent += @( + '

The available variants are:

', + '' '| Variant | Description |', '| :-- | :-- |' ) @@ -544,17 +546,17 @@ function Set-DefinitionSection { $resolvedTypeVariant = $TemplateFileContent.definitions[(Split-Path $typeVariant.'$ref' -Leaf)] $variantDescription = ($resolvedTypeVariant.metadata.description ?? '').Replace("`r`n", '

').Replace("`n", '

') - $variantIdentifier = '{0}-{1}' -f $paramIdentifier, $typeVariantName + $variantIdentifier = '{0}.{1}-{2}' -f $paramIdentifier, $definition.discriminator.propertyName, $typeVariantName $variantIdentifierHeader = "### Variant: ``$variantIdentifier``" $variantIdentifierLink = '#{0}' -f ($variantIdentifierHeader -replace '^#+ ', '' -replace '\s', '-' -replace '`|\:', '').ToLower() $variantContent += @( $variantIdentifierHeader, - ('To use this variant, choose the value `{0}` for the property `{1}`.' -f $typeVariantName, $definition.discriminator.propertyName) + ('To use this variant, choose the value `{0}` for the property `{1}`.' -f $typeVariantName, $definition.discriminator.propertyName), '' ) - $variantTableSectionContent += ('| [`{0}`]({1}) | {2} |' -f $typeVariantName, $variantIdentifierLink, $variantDescription) + $variantTableSectionContent += ('| [`{0}`]({1}) | {2} | ' -f $typeVariantName, $variantIdentifierLink, $variantDescription) $definitionSectionInputObject = @{ TemplateFileContent = $TemplateFileContent @@ -602,7 +604,7 @@ Optional. The identifier of the 'outputs' section. Defaults to '## Outputs' Set-OutputsSection -TemplateFileContent @{ resource = @{}; ... } -ReadMeFileContent @('# Title', '', '## Section 1', ...) Update the given readme file's 'Outputs' section based on the given template file content -#> + #> function Set-OutputsSection { [CmdletBinding(SupportsShouldProcess)] From 0c166325e60454d2a55334c2828f3d53dd89f1e9 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 15:06:09 +0100 Subject: [PATCH 03/43] Update to latest --- .../insights/data-collection-rule/README.md | 62 +++++++++---------- .../sharedScripts/Set-ModuleReadMe.ps1 | 2 +- 2 files changed, 32 insertions(+), 32 deletions(-) diff --git a/avm/res/insights/data-collection-rule/README.md b/avm/res/insights/data-collection-rule/README.md index b1af194671..d04f7febe0 100644 --- a/avm/res/insights/data-collection-rule/README.md +++ b/avm/res/insights/data-collection-rule/README.md @@ -2820,10 +2820,10 @@ The kind of data collection rule. | Variant | Description | | :-- | :-- | -| [`Linux`](#variant-datacollectionruleproperties.kind-linux) | Type for a Linux DSR collection rule. | -| [`Windows`](#variant-datacollectionruleproperties.kind-windows) | | -| [`All`](#variant-datacollectionruleproperties.kind-all) | | -| [`AgentSettings`](#variant-datacollectionruleproperties.kind-agentsettings) | | +| [`Linux`](#variant-datacollectionrulepropertieskind-linux) | Type for a Linux DSR collection rule. | +| [`Windows`](#variant-datacollectionrulepropertieskind-windows) | | +| [`All`](#variant-datacollectionrulepropertieskind-all) | | +| [`AgentSettings`](#variant-datacollectionrulepropertieskind-agentsettings) | | ### Variant: `dataCollectionRuleProperties.kind-Linux` To use this variant, choose the value `Linux` for the property `kind`. @@ -2832,18 +2832,18 @@ To use this variant, choose the value `Linux` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#variant-datacollectionruleproperties.kind-linuxdataflows) | array | The specification of data flows. | -| [`dataSources`](#variant-datacollectionruleproperties.kind-linuxdatasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#variant-datacollectionruleproperties.kind-linuxdestinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#variant-datacollectionruleproperties.kind-linuxkind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#variant-datacollectionrulepropertieskind-linuxdataflows) | array | The specification of data flows. | +| [`dataSources`](#variant-datacollectionrulepropertieskind-linuxdatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#variant-datacollectionrulepropertieskind-linuxdestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#variant-datacollectionrulepropertieskind-linuxkind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties.kind-linuxdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#variant-datacollectionruleproperties.kind-linuxdescription) | string | Description of the data collection rule. | -| [`streamDeclarations`](#variant-datacollectionruleproperties.kind-linuxstreamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#variant-datacollectionrulepropertieskind-linuxdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#variant-datacollectionrulepropertieskind-linuxdescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#variant-datacollectionrulepropertieskind-linuxstreamdeclarations) | object | Declaration of custom streams used in this rule. | ### Parameter: `dataCollectionRuleProperties.kind-Linux.dataFlows` @@ -2907,18 +2907,18 @@ To use this variant, choose the value `Windows` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#variant-datacollectionruleproperties.kind-windowsdataflows) | array | The specification of data flows. | -| [`dataSources`](#variant-datacollectionruleproperties.kind-windowsdatasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#variant-datacollectionruleproperties.kind-windowsdestinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#variant-datacollectionruleproperties.kind-windowskind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#variant-datacollectionrulepropertieskind-windowsdataflows) | array | The specification of data flows. | +| [`dataSources`](#variant-datacollectionrulepropertieskind-windowsdatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#variant-datacollectionrulepropertieskind-windowsdestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#variant-datacollectionrulepropertieskind-windowskind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties.kind-windowsdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#variant-datacollectionruleproperties.kind-windowsdescription) | string | Description of the data collection rule. | -| [`streamDeclarations`](#variant-datacollectionruleproperties.kind-windowsstreamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#variant-datacollectionrulepropertieskind-windowsdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#variant-datacollectionrulepropertieskind-windowsdescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#variant-datacollectionrulepropertieskind-windowsstreamdeclarations) | object | Declaration of custom streams used in this rule. | ### Parameter: `dataCollectionRuleProperties.kind-Windows.dataFlows` @@ -2982,18 +2982,18 @@ To use this variant, choose the value `All` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#variant-datacollectionruleproperties.kind-alldataflows) | array | The specification of data flows. | -| [`dataSources`](#variant-datacollectionruleproperties.kind-alldatasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#variant-datacollectionruleproperties.kind-alldestinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#variant-datacollectionruleproperties.kind-allkind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#variant-datacollectionrulepropertieskind-alldataflows) | array | The specification of data flows. | +| [`dataSources`](#variant-datacollectionrulepropertieskind-alldatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#variant-datacollectionrulepropertieskind-alldestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#variant-datacollectionrulepropertieskind-allkind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#variant-datacollectionruleproperties.kind-alldatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#variant-datacollectionruleproperties.kind-alldescription) | string | Description of the data collection rule. | -| [`streamDeclarations`](#variant-datacollectionruleproperties.kind-allstreamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#variant-datacollectionrulepropertieskind-alldatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#variant-datacollectionrulepropertieskind-alldescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#variant-datacollectionrulepropertieskind-allstreamdeclarations) | object | Declaration of custom streams used in this rule. | ### Parameter: `dataCollectionRuleProperties.kind-All.dataFlows` @@ -3057,14 +3057,14 @@ To use this variant, choose the value `AgentSettings` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`agentSettings`](#variant-datacollectionruleproperties.kind-agentsettingsagentsettings) | object | Agent settings used to modify agent behavior on a given host. | -| [`kind`](#variant-datacollectionruleproperties.kind-agentsettingskind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`agentSettings`](#variant-datacollectionrulepropertieskind-agentsettingsagentsettings) | object | Agent settings used to modify agent behavior on a given host. | +| [`kind`](#variant-datacollectionrulepropertieskind-agentsettingskind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`description`](#variant-datacollectionruleproperties.kind-agentsettingsdescription) | string | Description of the data collection rule. | +| [`description`](#variant-datacollectionrulepropertieskind-agentsettingsdescription) | string | Description of the data collection rule. | ### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings` @@ -3077,7 +3077,7 @@ Agent settings used to modify agent behavior on a given host. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`logs`](#variant-datacollectionruleproperties.kind-agentsettingsagentsettingslogs) | array | All the settings that are applicable to the logs agent (AMA). | +| [`logs`](#variant-datacollectionrulepropertieskind-agentsettingsagentsettingslogs) | array | All the settings that are applicable to the logs agent (AMA). | ### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings.logs` @@ -3090,8 +3090,8 @@ All the settings that are applicable to the logs agent (AMA). | Parameter | Type | Description | | :-- | :-- | :-- | -| [`name`](#variant-datacollectionruleproperties.kind-agentsettingsagentsettingslogsname) | string | The name of the agent setting. | -| [`value`](#variant-datacollectionruleproperties.kind-agentsettingsagentsettingslogsvalue) | string | The value of the agent setting. | +| [`name`](#variant-datacollectionrulepropertieskind-agentsettingsagentsettingslogsname) | string | The name of the agent setting. | +| [`value`](#variant-datacollectionrulepropertieskind-agentsettingsagentsettingslogsvalue) | string | The value of the agent setting. | ### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings.logs.name` diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 44c8c6b2e2..e940a3a92d 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -548,7 +548,7 @@ function Set-DefinitionSection { $variantIdentifier = '{0}.{1}-{2}' -f $paramIdentifier, $definition.discriminator.propertyName, $typeVariantName $variantIdentifierHeader = "### Variant: ``$variantIdentifier``" - $variantIdentifierLink = '#{0}' -f ($variantIdentifierHeader -replace '^#+ ', '' -replace '\s', '-' -replace '`|\:', '').ToLower() + $variantIdentifierLink = '#{0}' -f ($variantIdentifierHeader -replace '^#+ ', '' -replace '\s', '-' -replace '`|\:|\.', '').ToLower() $variantContent += @( $variantIdentifierHeader, From 2529217cb23f0c68977df7bb27e8fdd2356eaf49 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 15:18:43 +0100 Subject: [PATCH 04/43] Update to latest --- .../insights/data-collection-rule/README.md | 54 +++++++++---------- .../sharedScripts/Set-ModuleReadMe.ps1 | 2 +- 2 files changed, 28 insertions(+), 28 deletions(-) diff --git a/avm/res/insights/data-collection-rule/README.md b/avm/res/insights/data-collection-rule/README.md index d04f7febe0..d6366808d0 100644 --- a/avm/res/insights/data-collection-rule/README.md +++ b/avm/res/insights/data-collection-rule/README.md @@ -2832,18 +2832,18 @@ To use this variant, choose the value `Linux` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#variant-datacollectionrulepropertieskind-linuxdataflows) | array | The specification of data flows. | -| [`dataSources`](#variant-datacollectionrulepropertieskind-linuxdatasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#variant-datacollectionrulepropertieskind-linuxdestinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#variant-datacollectionrulepropertieskind-linuxkind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#parameter-datacollectionruleproperties.kind-linux.dataflows) | array | The specification of data flows. | +| [`dataSources`](#parameter-datacollectionruleproperties.kind-linux.datasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#parameter-datacollectionruleproperties.kind-linux.destinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#parameter-datacollectionruleproperties.kind-linux.kind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#variant-datacollectionrulepropertieskind-linuxdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#variant-datacollectionrulepropertieskind-linuxdescription) | string | Description of the data collection rule. | -| [`streamDeclarations`](#variant-datacollectionrulepropertieskind-linuxstreamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#parameter-datacollectionruleproperties.kind-linux.datacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#parameter-datacollectionruleproperties.kind-linux.description) | string | Description of the data collection rule. | +| [`streamDeclarations`](#parameter-datacollectionruleproperties.kind-linux.streamdeclarations) | object | Declaration of custom streams used in this rule. | ### Parameter: `dataCollectionRuleProperties.kind-Linux.dataFlows` @@ -2907,18 +2907,18 @@ To use this variant, choose the value `Windows` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#variant-datacollectionrulepropertieskind-windowsdataflows) | array | The specification of data flows. | -| [`dataSources`](#variant-datacollectionrulepropertieskind-windowsdatasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#variant-datacollectionrulepropertieskind-windowsdestinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#variant-datacollectionrulepropertieskind-windowskind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#parameter-datacollectionruleproperties.kind-windows.dataflows) | array | The specification of data flows. | +| [`dataSources`](#parameter-datacollectionruleproperties.kind-windows.datasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#parameter-datacollectionruleproperties.kind-windows.destinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#parameter-datacollectionruleproperties.kind-windows.kind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#variant-datacollectionrulepropertieskind-windowsdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#variant-datacollectionrulepropertieskind-windowsdescription) | string | Description of the data collection rule. | -| [`streamDeclarations`](#variant-datacollectionrulepropertieskind-windowsstreamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#parameter-datacollectionruleproperties.kind-windows.datacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#parameter-datacollectionruleproperties.kind-windows.description) | string | Description of the data collection rule. | +| [`streamDeclarations`](#parameter-datacollectionruleproperties.kind-windows.streamdeclarations) | object | Declaration of custom streams used in this rule. | ### Parameter: `dataCollectionRuleProperties.kind-Windows.dataFlows` @@ -2982,18 +2982,18 @@ To use this variant, choose the value `All` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#variant-datacollectionrulepropertieskind-alldataflows) | array | The specification of data flows. | -| [`dataSources`](#variant-datacollectionrulepropertieskind-alldatasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#variant-datacollectionrulepropertieskind-alldestinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#variant-datacollectionrulepropertieskind-allkind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#parameter-datacollectionruleproperties.kind-all.dataflows) | array | The specification of data flows. | +| [`dataSources`](#parameter-datacollectionruleproperties.kind-all.datasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#parameter-datacollectionruleproperties.kind-all.destinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#parameter-datacollectionruleproperties.kind-all.kind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#variant-datacollectionrulepropertieskind-alldatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#variant-datacollectionrulepropertieskind-alldescription) | string | Description of the data collection rule. | -| [`streamDeclarations`](#variant-datacollectionrulepropertieskind-allstreamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#parameter-datacollectionruleproperties.kind-all.datacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#parameter-datacollectionruleproperties.kind-all.description) | string | Description of the data collection rule. | +| [`streamDeclarations`](#parameter-datacollectionruleproperties.kind-all.streamdeclarations) | object | Declaration of custom streams used in this rule. | ### Parameter: `dataCollectionRuleProperties.kind-All.dataFlows` @@ -3057,14 +3057,14 @@ To use this variant, choose the value `AgentSettings` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`agentSettings`](#variant-datacollectionrulepropertieskind-agentsettingsagentsettings) | object | Agent settings used to modify agent behavior on a given host. | -| [`kind`](#variant-datacollectionrulepropertieskind-agentsettingskind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`agentSettings`](#parameter-datacollectionruleproperties.kind-agentsettings.agentsettings) | object | Agent settings used to modify agent behavior on a given host. | +| [`kind`](#parameter-datacollectionruleproperties.kind-agentsettings.kind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`description`](#variant-datacollectionrulepropertieskind-agentsettingsdescription) | string | Description of the data collection rule. | +| [`description`](#parameter-datacollectionruleproperties.kind-agentsettings.description) | string | Description of the data collection rule. | ### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings` @@ -3077,7 +3077,7 @@ Agent settings used to modify agent behavior on a given host. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`logs`](#variant-datacollectionrulepropertieskind-agentsettingsagentsettingslogs) | array | All the settings that are applicable to the logs agent (AMA). | +| [`logs`](#parameter-datacollectionruleproperties.kind-agentsettings.agentsettingslogs) | array | All the settings that are applicable to the logs agent (AMA). | ### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings.logs` @@ -3090,8 +3090,8 @@ All the settings that are applicable to the logs agent (AMA). | Parameter | Type | Description | | :-- | :-- | :-- | -| [`name`](#variant-datacollectionrulepropertieskind-agentsettingsagentsettingslogsname) | string | The name of the agent setting. | -| [`value`](#variant-datacollectionrulepropertieskind-agentsettingsagentsettingslogsvalue) | string | The value of the agent setting. | +| [`name`](#parameter-datacollectionruleproperties.kind-agentsettings.agentsettingslogsname) | string | The name of the agent setting. | +| [`value`](#parameter-datacollectionruleproperties.kind-agentsettings.agentsettingslogsvalue) | string | The value of the agent setting. | ### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings.logs.name` diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index e940a3a92d..a2e308f46c 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -562,7 +562,7 @@ function Set-DefinitionSection { TemplateFileContent = $TemplateFileContent Properties = $resolvedTypeVariant.properties ParentName = $variantIdentifier - ParentIdentifierLink = $variantIdentifierLink + ParentIdentifierLink = $null ColumnsInOrder = $ColumnsInOrder } $sectionContent = Set-DefinitionSection @definitionSectionInputObject From 7d7ad9b33a008487ed670ca9b907393f28b6b3a0 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 15:23:43 +0100 Subject: [PATCH 05/43] Update to latest --- .../insights/data-collection-rule/README.md | 54 +++++++++---------- .../sharedScripts/Set-ModuleReadMe.ps1 | 15 +++++- 2 files changed, 40 insertions(+), 29 deletions(-) diff --git a/avm/res/insights/data-collection-rule/README.md b/avm/res/insights/data-collection-rule/README.md index d6366808d0..e6e1ae4965 100644 --- a/avm/res/insights/data-collection-rule/README.md +++ b/avm/res/insights/data-collection-rule/README.md @@ -2832,18 +2832,18 @@ To use this variant, choose the value `Linux` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#parameter-datacollectionruleproperties.kind-linux.dataflows) | array | The specification of data flows. | -| [`dataSources`](#parameter-datacollectionruleproperties.kind-linux.datasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#parameter-datacollectionruleproperties.kind-linux.destinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#parameter-datacollectionruleproperties.kind-linux.kind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#parameter-datacollectionrulepropertieskind-linuxdataflows) | array | The specification of data flows. | +| [`dataSources`](#parameter-datacollectionrulepropertieskind-linuxdatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#parameter-datacollectionrulepropertieskind-linuxdestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#parameter-datacollectionrulepropertieskind-linuxkind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#parameter-datacollectionruleproperties.kind-linux.datacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#parameter-datacollectionruleproperties.kind-linux.description) | string | Description of the data collection rule. | -| [`streamDeclarations`](#parameter-datacollectionruleproperties.kind-linux.streamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#parameter-datacollectionrulepropertieskind-linuxdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#parameter-datacollectionrulepropertieskind-linuxdescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#parameter-datacollectionrulepropertieskind-linuxstreamdeclarations) | object | Declaration of custom streams used in this rule. | ### Parameter: `dataCollectionRuleProperties.kind-Linux.dataFlows` @@ -2907,18 +2907,18 @@ To use this variant, choose the value `Windows` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#parameter-datacollectionruleproperties.kind-windows.dataflows) | array | The specification of data flows. | -| [`dataSources`](#parameter-datacollectionruleproperties.kind-windows.datasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#parameter-datacollectionruleproperties.kind-windows.destinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#parameter-datacollectionruleproperties.kind-windows.kind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#parameter-datacollectionrulepropertieskind-windowsdataflows) | array | The specification of data flows. | +| [`dataSources`](#parameter-datacollectionrulepropertieskind-windowsdatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#parameter-datacollectionrulepropertieskind-windowsdestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#parameter-datacollectionrulepropertieskind-windowskind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#parameter-datacollectionruleproperties.kind-windows.datacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#parameter-datacollectionruleproperties.kind-windows.description) | string | Description of the data collection rule. | -| [`streamDeclarations`](#parameter-datacollectionruleproperties.kind-windows.streamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#parameter-datacollectionrulepropertieskind-windowsdatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#parameter-datacollectionrulepropertieskind-windowsdescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#parameter-datacollectionrulepropertieskind-windowsstreamdeclarations) | object | Declaration of custom streams used in this rule. | ### Parameter: `dataCollectionRuleProperties.kind-Windows.dataFlows` @@ -2982,18 +2982,18 @@ To use this variant, choose the value `All` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataFlows`](#parameter-datacollectionruleproperties.kind-all.dataflows) | array | The specification of data flows. | -| [`dataSources`](#parameter-datacollectionruleproperties.kind-all.datasources) | object | Specification of data sources that will be collected. | -| [`destinations`](#parameter-datacollectionruleproperties.kind-all.destinations) | object | Specification of destinations that can be used in data flows. | -| [`kind`](#parameter-datacollectionruleproperties.kind-all.kind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`dataFlows`](#parameter-datacollectionrulepropertieskind-alldataflows) | array | The specification of data flows. | +| [`dataSources`](#parameter-datacollectionrulepropertieskind-alldatasources) | object | Specification of data sources that will be collected. | +| [`destinations`](#parameter-datacollectionrulepropertieskind-alldestinations) | object | Specification of destinations that can be used in data flows. | +| [`kind`](#parameter-datacollectionrulepropertieskind-allkind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`dataCollectionEndpointResourceId`](#parameter-datacollectionruleproperties.kind-all.datacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | -| [`description`](#parameter-datacollectionruleproperties.kind-all.description) | string | Description of the data collection rule. | -| [`streamDeclarations`](#parameter-datacollectionruleproperties.kind-all.streamdeclarations) | object | Declaration of custom streams used in this rule. | +| [`dataCollectionEndpointResourceId`](#parameter-datacollectionrulepropertieskind-alldatacollectionendpointresourceid) | string | The resource ID of the data collection endpoint that this rule can be used with. | +| [`description`](#parameter-datacollectionrulepropertieskind-alldescription) | string | Description of the data collection rule. | +| [`streamDeclarations`](#parameter-datacollectionrulepropertieskind-allstreamdeclarations) | object | Declaration of custom streams used in this rule. | ### Parameter: `dataCollectionRuleProperties.kind-All.dataFlows` @@ -3057,14 +3057,14 @@ To use this variant, choose the value `AgentSettings` for the property `kind`. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`agentSettings`](#parameter-datacollectionruleproperties.kind-agentsettings.agentsettings) | object | Agent settings used to modify agent behavior on a given host. | -| [`kind`](#parameter-datacollectionruleproperties.kind-agentsettings.kind) | string | The platform type specifies the type of resources this rule can apply to. | +| [`agentSettings`](#parameter-datacollectionrulepropertieskind-agentsettingsagentsettings) | object | Agent settings used to modify agent behavior on a given host. | +| [`kind`](#parameter-datacollectionrulepropertieskind-agentsettingskind) | string | The platform type specifies the type of resources this rule can apply to. | **Optional parameters** | Parameter | Type | Description | | :-- | :-- | :-- | -| [`description`](#parameter-datacollectionruleproperties.kind-agentsettings.description) | string | Description of the data collection rule. | +| [`description`](#parameter-datacollectionrulepropertieskind-agentsettingsdescription) | string | Description of the data collection rule. | ### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings` @@ -3077,7 +3077,7 @@ Agent settings used to modify agent behavior on a given host. | Parameter | Type | Description | | :-- | :-- | :-- | -| [`logs`](#parameter-datacollectionruleproperties.kind-agentsettings.agentsettingslogs) | array | All the settings that are applicable to the logs agent (AMA). | +| [`logs`](#parameter-datacollectionrulepropertieskind-agentsettingsagentsettingslogs) | array | All the settings that are applicable to the logs agent (AMA). | ### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings.logs` @@ -3090,8 +3090,8 @@ All the settings that are applicable to the logs agent (AMA). | Parameter | Type | Description | | :-- | :-- | :-- | -| [`name`](#parameter-datacollectionruleproperties.kind-agentsettings.agentsettingslogsname) | string | The name of the agent setting. | -| [`value`](#parameter-datacollectionruleproperties.kind-agentsettings.agentsettingslogsvalue) | string | The value of the agent setting. | +| [`name`](#parameter-datacollectionrulepropertieskind-agentsettingsagentsettingslogsname) | string | The name of the agent setting. | +| [`value`](#parameter-datacollectionrulepropertieskind-agentsettingsagentsettingslogsvalue) | string | The value of the agent setting. | ### Parameter: `dataCollectionRuleProperties.kind-AgentSettings.agentSettings.logs.name` diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index a2e308f46c..a5204e97c9 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -195,6 +195,17 @@ function Set-ParametersSection { return $updatedFileContent } +function Get-MarkdownHeaderFormattedString { + + [CmdletBinding()] + param ( + [Parameter()] + [string] $StringToFormat + ) + + return ('#{0}' -f ($StringToFormat -replace '^#+ ', '' -replace '\s', '-' -replace '`|\:|\.', '').ToLower()) +} + <# .SYNOPSIS Update parts of the 'parameters' section of the given readme file, if user defined types are used @@ -313,7 +324,7 @@ function Set-DefinitionSection { $paramIdentifier = (-not [String]::IsNullOrEmpty($ParentName)) ? '{0}.{1}' -f $ParentName, $parameter.name : $parameter.name $paramHeader = '### Parameter: `{0}`' -f $paramIdentifier - $paramIdentifierLink = (-not [String]::IsNullOrEmpty($ParentIdentifierLink)) ? ('{0}{1}' -f $ParentIdentifierLink, $parameter.name).ToLower() : ('#{0}' -f $paramHeader.TrimStart('#').Trim().ToLower()) -replace '[:|`]' -replace ' ', '-' + $paramIdentifierLink = (-not [String]::IsNullOrEmpty($ParentIdentifierLink)) ? ('{0}{1}' -f $ParentIdentifierLink, $parameter.name).ToLower() : (Get-MarkdownHeaderFormattedString $paramHeader) # definition type (if any) if ($parameter.Keys -contains '$ref') { @@ -548,7 +559,7 @@ function Set-DefinitionSection { $variantIdentifier = '{0}.{1}-{2}' -f $paramIdentifier, $definition.discriminator.propertyName, $typeVariantName $variantIdentifierHeader = "### Variant: ``$variantIdentifier``" - $variantIdentifierLink = '#{0}' -f ($variantIdentifierHeader -replace '^#+ ', '' -replace '\s', '-' -replace '`|\:|\.', '').ToLower() + $variantIdentifierLink = Get-MarkdownHeaderFormattedString $variantIdentifierHeader $variantContent += @( $variantIdentifierHeader, From 9fc4f895fa12041b9755cd4d68e5fcb4f7775f40 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 15:33:52 +0100 Subject: [PATCH 06/43] Update to latest --- .../insights/data-collection-rule/README.md | 16 +++++++++--- .../sharedScripts/Set-ModuleReadMe.ps1 | 25 ++++++++++++++++--- 2 files changed, 33 insertions(+), 8 deletions(-) diff --git a/avm/res/insights/data-collection-rule/README.md b/avm/res/insights/data-collection-rule/README.md index e6e1ae4965..0e68ef5f14 100644 --- a/avm/res/insights/data-collection-rule/README.md +++ b/avm/res/insights/data-collection-rule/README.md @@ -2826,7 +2826,9 @@ The kind of data collection rule. | [`AgentSettings`](#variant-datacollectionrulepropertieskind-agentsettings) | | ### Variant: `dataCollectionRuleProperties.kind-Linux` -To use this variant, choose the value `Linux` for the property `kind`. +Type for a Linux DSR collection rule. + +To use this variant, set the property `kind` to `Linux`. **Required parameters** @@ -2901,7 +2903,9 @@ Declaration of custom streams used in this rule. - Type: object ### Variant: `dataCollectionRuleProperties.kind-Windows` -To use this variant, choose the value `Windows` for the property `kind`. + + +To use this variant, set the property `kind` to `Windows`. **Required parameters** @@ -2976,7 +2980,9 @@ Declaration of custom streams used in this rule. - Type: object ### Variant: `dataCollectionRuleProperties.kind-All` -To use this variant, choose the value `All` for the property `kind`. + + +To use this variant, set the property `kind` to `All`. **Required parameters** @@ -3051,7 +3057,9 @@ Declaration of custom streams used in this rule. - Type: object ### Variant: `dataCollectionRuleProperties.kind-AgentSettings` -To use this variant, choose the value `AgentSettings` for the property `kind`. + + +To use this variant, set the property `kind` to `AgentSettings`. **Required parameters** diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index a5204e97c9..ade6978633 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -195,7 +195,22 @@ function Set-ParametersSection { return $updatedFileContent } -function Get-MarkdownHeaderFormattedString { +<# +.SYNOPSIS +Reformat a given string to a markdown-compatible header reference + +.DESCRIPTION +This function removes characters that are not part of a markdown header and adds a header reference to the front + +.PARAMETER StringToFormat +Mandatory. The string to format + +.EXAMPLE +Get-MarkdownHeaderReferenceFormattedString 'Parameter: dataCollectionRuleProperties.kind-AgentSettings.description' + +The given string is reformatted to: '#parameter-datacollectionrulepropertieskind-agentsettingsdescription'. +#> +function Get-MarkdownHeaderReferenceFormattedString { [CmdletBinding()] param ( @@ -324,7 +339,7 @@ function Set-DefinitionSection { $paramIdentifier = (-not [String]::IsNullOrEmpty($ParentName)) ? '{0}.{1}' -f $ParentName, $parameter.name : $parameter.name $paramHeader = '### Parameter: `{0}`' -f $paramIdentifier - $paramIdentifierLink = (-not [String]::IsNullOrEmpty($ParentIdentifierLink)) ? ('{0}{1}' -f $ParentIdentifierLink, $parameter.name).ToLower() : (Get-MarkdownHeaderFormattedString $paramHeader) + $paramIdentifierLink = (-not [String]::IsNullOrEmpty($ParentIdentifierLink)) ? ('{0}{1}' -f $ParentIdentifierLink, $parameter.name).ToLower() : (Get-MarkdownHeaderReferenceFormattedString $paramHeader) # definition type (if any) if ($parameter.Keys -contains '$ref') { @@ -559,11 +574,13 @@ function Set-DefinitionSection { $variantIdentifier = '{0}.{1}-{2}' -f $paramIdentifier, $definition.discriminator.propertyName, $typeVariantName $variantIdentifierHeader = "### Variant: ``$variantIdentifier``" - $variantIdentifierLink = Get-MarkdownHeaderFormattedString $variantIdentifierHeader + $variantIdentifierLink = Get-MarkdownHeaderReferenceFormattedString $variantIdentifierHeader $variantContent += @( $variantIdentifierHeader, - ('To use this variant, choose the value `{0}` for the property `{1}`.' -f $typeVariantName, $definition.discriminator.propertyName), + $variantDescription, + '', + ('To use this variant, set the property `{0}` to `{1}`.' -f $definition.discriminator.propertyName, $typeVariantName), '' ) From 757124123f33bf2bf4f39d9750e9982b709561bc Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 17:42:10 +0100 Subject: [PATCH 07/43] Removed unused parameter --- .../sharedScripts/Set-ModuleReadMe.ps1 | 27 +++++++------------ 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index ade6978633..1a3a95cd95 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -237,9 +237,6 @@ Optional. Hashtable of the user defined properties .PARAMETER ParentName Optional. Name of the parameter, that has the user defined types -.PARAMETER ParentIdentifierLink -Optional. Link of the parameter, that has the user defined types - .PARAMETER ColumnsInOrder Optional. The order of parameter categories to show in the readme parameters section. @@ -249,7 +246,7 @@ Set-DefinitionSection -TemplateFileContent @{ resource = @{}; ... } -ColumnsInOr Top-level invocation. Will start from the TemplateFile's parameters object and recursively crawl through all children. Tables will be ordered by 'Required' first and 'Optional' after. .EXAMPLE -Set-DefinitionSection -TemplateFileContent @{ resource = @{}; ... } -Properties @{ @{ name = @{ type = 'string'; 'allowedValues' = @('A1','A2','A3','A4','A5','A6'); 'nullable' = $true; (...) } -ParentName 'diagnosticSettings' -ParentIdentifierLink '#parameter-diagnosticsettings' +Set-DefinitionSection -TemplateFileContent @{ resource = @{}; ... } -Properties @{ @{ name = @{ type = 'string'; 'allowedValues' = @('A1','A2','A3','A4','A5','A6'); 'nullable' = $true; (...) } -ParentName 'diagnosticSettings' Child-level invocation during recursion. @@ -267,9 +264,6 @@ function Set-DefinitionSection { [Parameter(Mandatory = $false)] [string] $ParentName, - [Parameter(Mandatory = $false)] - [string] $ParentIdentifierLink, - [Parameter(Mandatory = $false)] [string[]] $ColumnsInOrder = @('Required', 'Conditional', 'Optional', 'Generated') ) @@ -339,7 +333,7 @@ function Set-DefinitionSection { $paramIdentifier = (-not [String]::IsNullOrEmpty($ParentName)) ? '{0}.{1}' -f $ParentName, $parameter.name : $parameter.name $paramHeader = '### Parameter: `{0}`' -f $paramIdentifier - $paramIdentifierLink = (-not [String]::IsNullOrEmpty($ParentIdentifierLink)) ? ('{0}{1}' -f $ParentIdentifierLink, $parameter.name).ToLower() : (Get-MarkdownHeaderReferenceFormattedString $paramHeader) + $paramIdentifierLink = Get-MarkdownHeaderReferenceFormattedString $paramHeader # definition type (if any) if ($parameter.Keys -contains '$ref') { @@ -530,25 +524,25 @@ function Set-DefinitionSection { if ($definition.Keys -contains 'items' -and ($definition.items.properties.Keys -or $definition.items.additionalProperties.Keys)) { if ($definition.items.properties.Keys) { $childProperties = $definition.items.properties - $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $childProperties -ParentName $paramIdentifier -ParentIdentifierLink $paramIdentifierLink -ColumnsInOrder $ColumnsInOrder + $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $childProperties -ParentName $paramIdentifier -ColumnsInOrder $ColumnsInOrder $listSectionContent += $sectionContent } if ($definition.items.additionalProperties.Keys) { $childProperties = $definition.items.additionalProperties $formattedProperties = @{ '>Any_other_property<' = $childProperties } - $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $formattedProperties -ParentName $paramIdentifier -ParentIdentifierLink $paramIdentifierLink -ColumnsInOrder $ColumnsInOrder + $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $formattedProperties -ParentName $paramIdentifier -ColumnsInOrder $ColumnsInOrder $listSectionContent += $sectionContent } } elseif ($definition.type -eq 'object' -and ($definition.properties.Keys -or $definition.additionalProperties.Keys)) { if ($definition.properties.Keys) { $childProperties = $definition.properties - $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $childProperties -ParentName $paramIdentifier -ParentIdentifierLink $paramIdentifierLink -ColumnsInOrder $ColumnsInOrder + $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $childProperties -ParentName $paramIdentifier -ColumnsInOrder $ColumnsInOrder $listSectionContent += $sectionContent } if ($definition.additionalProperties.Keys) { $childProperties = $definition.additionalProperties $formattedProperties = @{ '>Any_other_property<' = $childProperties } - $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $formattedProperties -ParentName $paramIdentifier -ParentIdentifierLink $paramIdentifierLink -ColumnsInOrder $ColumnsInOrder + $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $formattedProperties -ParentName $paramIdentifier -ColumnsInOrder $ColumnsInOrder $listSectionContent += $sectionContent } } elseif ($definition.type -eq 'object' -and $definition.keys -contains 'discriminator') { @@ -587,11 +581,10 @@ function Set-DefinitionSection { $variantTableSectionContent += ('| [`{0}`]({1}) | {2} | ' -f $typeVariantName, $variantIdentifierLink, $variantDescription) $definitionSectionInputObject = @{ - TemplateFileContent = $TemplateFileContent - Properties = $resolvedTypeVariant.properties - ParentName = $variantIdentifier - ParentIdentifierLink = $null - ColumnsInOrder = $ColumnsInOrder + TemplateFileContent = $TemplateFileContent + Properties = $resolvedTypeVariant.properties + ParentName = $variantIdentifier + ColumnsInOrder = $ColumnsInOrder } $sectionContent = Set-DefinitionSection @definitionSectionInputObject $variantContent += $sectionContent From c3e5384c11e77358f9012bbf8dc20934cc174bb5 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 18:01:38 +0100 Subject: [PATCH 08/43] Update to latest --- utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 1a3a95cd95..07dd527f5c 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -625,7 +625,7 @@ Optional. The identifier of the 'outputs' section. Defaults to '## Outputs' Set-OutputsSection -TemplateFileContent @{ resource = @{}; ... } -ReadMeFileContent @('# Title', '', '## Section 1', ...) Update the given readme file's 'Outputs' section based on the given template file content - #> +#> function Set-OutputsSection { [CmdletBinding(SupportsShouldProcess)] From 6b72f5f85e17a00ad09aa92b45fade897c8df3cb Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 18:12:20 +0100 Subject: [PATCH 09/43] Regenerated ptn modules --- avm/ptn/ai-platform/baseline/README.md | 243 +++++ .../dev-ops/cicd-agents-and-runners/README.md | 850 ++++++++++++++++++ avm/ptn/lz/sub-vending/README.md | 162 ++++ .../sharedScripts/Set-ModuleReadMe.ps1 | 2 +- 4 files changed, 1256 insertions(+), 1 deletion(-) diff --git a/avm/ptn/ai-platform/baseline/README.md b/avm/ptn/ai-platform/baseline/README.md index 16e7024130..c24ef2a288 100644 --- a/avm/ptn/ai-platform/baseline/README.md +++ b/avm/ptn/ai-platform/baseline/README.md @@ -1608,6 +1608,249 @@ The outbound rule. The name of the rule is the object key. - Required: Yes - Type: object +- Type-deciding property: type + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`FQDN`](#variant-workspaceconfigurationnetworkoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-FQDN` +The type for a FQDN outbound rule. + +To use this variant, set the property `type` to `FQDN`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`destination`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-FQDN.destination` + +Fully Qualified Domain Name to allow for outbound traffic. + +- Required: Yes +- Type: string + +### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-FQDN.type` + +Type of a managed network Outbound Rule of the workspace hub. Only supported when 'isolationMode' is 'AllowOnlyApprovedOutbound'. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'FQDN' + ] + ``` + +### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-FQDN.category` + +Category of a managed network Outbound Rule of the workspace hub. + +- Required: No +- Type: string +- Allowed: + ```Bicep + [ + 'Dependency' + 'Recommended' + 'Required' + 'UserDefined' + ] + ``` + +### Variant: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint` +The type for a private endpoint outbound rule. + +To use this variant, set the property `type` to `PrivateEndpoint`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`destination`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-PrivateEndpoint.destination` + +Service Tag destination for a Service Tag Outbound Rule for the managed network of the workspace hub. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`serviceResourceId`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-PrivateEndpoint.destination.serviceResourceId` + +The resource ID of the target resource for the private endpoint. + +- Required: Yes +- Type: string + +### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint.destination.subresourceTarget` + +The sub resource to connect for the private endpoint. + +- Required: Yes +- Type: string + +### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint.destination.sparkEnabled` + +Whether the private endpoint can be used by jobs running on Spark. + +- Required: No +- Type: bool + +### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint.type` + +Type of a managed network Outbound Rule of the workspace hub. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'PrivateEndpoint' + ] + ``` + +### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint.category` + +Category of a managed network Outbound Rule of the workspace hub. + +- Required: No +- Type: string +- Allowed: + ```Bicep + [ + 'Dependency' + 'Recommended' + 'Required' + 'UserDefined' + ] + ``` + +### Variant: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag` +The type for an service tag outbound rule. + +To use this variant, set the property `type` to `ServiceTag`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`destination`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-ServiceTag.destination` + +Service Tag destination for a Service Tag Outbound Rule for the managed network of the workspace hub. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`portRanges`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-ServiceTag.destination.portRanges` + +The name of the service tag to allow. + +- Required: Yes +- Type: string + +### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag.destination.protocol` + +The protocol to allow. Provide an asterisk(*) to allow any protocol. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + '*' + 'ICMP' + 'TCP' + 'UDP' + ] + ``` + +### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag.destination.serviceTag` + +Which ports will be allow traffic by this rule. Provide an asterisk(*) to allow any port. + +- Required: Yes +- Type: string + +### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag.type` + +Type of a managed network Outbound Rule of the workspace hub. Only supported when 'isolationMode' is 'AllowOnlyApprovedOutbound'. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ServiceTag' + ] + ``` + +### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag.category` + +Category of a managed network Outbound Rule of the workspace hub. + +- Required: No +- Type: string +- Allowed: + ```Bicep + [ + 'Dependency' + 'Recommended' + 'Required' + 'UserDefined' + ] + ``` ### Parameter: `workspaceConfiguration.projectName` diff --git a/avm/ptn/dev-ops/cicd-agents-and-runners/README.md b/avm/ptn/dev-ops/cicd-agents-and-runners/README.md index 1e4be4038e..b304af5240 100644 --- a/avm/ptn/dev-ops/cicd-agents-and-runners/README.md +++ b/avm/ptn/dev-ops/cicd-agents-and-runners/README.md @@ -1328,6 +1328,341 @@ The networking configuration. - Required: Yes - Type: object +- Type-deciding property: networkType + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`createNew`](#variant-networkingconfigurationnetworktype-createnew) | | +| [`useExisting`](#variant-networkingconfigurationnetworktype-useexisting) | | + +### Variant: `networkingConfiguration.networkType-createNew` + + +To use this variant, set the property `networkType` to `createNew`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`addressSpace`](#parameter-networkingconfigurationnetworktype-createnewaddressspace) | string | The address space of the created virtual network. | +| [`networkType`](#parameter-networkingconfigurationnetworktype-createnewnetworktype) | string | The network type. This can be either createNew or useExisting. | +| [`virtualNetworkName`](#parameter-networkingconfigurationnetworktype-createnewvirtualnetworkname) | string | The virtual network name of the created virtual network. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`containerAppDeploymentScriptSubnetName`](#parameter-networkingconfigurationnetworktype-createnewcontainerappdeploymentscriptsubnetname) | string | The subnet name for the container app deployment script. Only required if private networking is used. If not provided, a default name will be used. | +| [`containerAppDeploymentScriptSubnetPrefix`](#parameter-networkingconfigurationnetworktype-createnewcontainerappdeploymentscriptsubnetprefix) | string | The subnet address prefix for the container app deployment script which is used to start the placeholder Azure DevOps agent. Only required if private networking is used. If not provided, a default subnet prefix will be used. | +| [`containerAppSubnetAddressPrefix`](#parameter-networkingconfigurationnetworktype-createnewcontainerappsubnetaddressprefix) | string | The container app subnet CIDR in the created virtual network. If not provided, a default subnet prefix will be used. | +| [`containerAppSubnetName`](#parameter-networkingconfigurationnetworktype-createnewcontainerappsubnetname) | string | The container app subnet name in the created virtual network. If not provided, a default name will be used. | +| [`containerInstanceSubnetAddressPrefix`](#parameter-networkingconfigurationnetworktype-createnewcontainerinstancesubnetaddressprefix) | string | The container instance subnet CIDR in the created virtual network. If not provided, a default subnet prefix will be used. | +| [`containerInstanceSubnetName`](#parameter-networkingconfigurationnetworktype-createnewcontainerinstancesubnetname) | string | The container instance subnet name in the created virtual network. If not provided, a default name will be used. | +| [`containerInstancesubnetPrefix`](#parameter-networkingconfigurationnetworktype-createnewcontainerinstancesubnetprefix) | string | The container instance subnet address prefix in the created virtual network. If not provided, a default subnet prefix will be used. | +| [`containerRegistryPrivateDnsZoneResourceId`](#parameter-networkingconfigurationnetworktype-createnewcontainerregistryprivatednszoneresourceid) | string | The container registry private DNS zone Id. If not provided, a new private DNS zone will be created. | +| [`containerRegistryPrivateEndpointSubnetName`](#parameter-networkingconfigurationnetworktype-createnewcontainerregistryprivateendpointsubnetname) | string | The subnet name for the container registry private endpoint. If not provided, a default name will be used. | +| [`containerRegistrySubnetPrefix`](#parameter-networkingconfigurationnetworktype-createnewcontainerregistrysubnetprefix) | string | The container registry subnet address prefix in the created virtual network. If not provided, a default subnet prefix will be used. | +| [`deploymentScriptPrivateDnsZoneResourceId`](#parameter-networkingconfigurationnetworktype-createnewdeploymentscriptprivatednszoneresourceid) | string | The deployment script private DNS zone Id. If not provided, a new private DNS zone will be created. Only required if private networking is used. | +| [`natGatewayPublicIpAddressResourceId`](#parameter-networkingconfigurationnetworktype-createnewnatgatewaypublicipaddressresourceid) | string | The existing public IP address to assosciate with the NAT gateway. This should be provided if an existing public Ip address is available to be used. If this parameter is not provided, a new Public Ip address will be created. | +| [`natGatewayResourceId`](#parameter-networkingconfigurationnetworktype-createnewnatgatewayresourceid) | string | The existing NAT Gateway resource Id. This should be provided if an existing NAT gateway is available to be used. If this parameter is not provided, a new NAT gateway will be created. | + +### Parameter: `networkingConfiguration.networkType-createNew.addressSpace` + +The address space of the created virtual network. + +- Required: Yes +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.networkType` + +The network type. This can be either createNew or useExisting. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'createNew' + ] + ``` + +### Parameter: `networkingConfiguration.networkType-createNew.virtualNetworkName` + +The virtual network name of the created virtual network. + +- Required: Yes +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.containerAppDeploymentScriptSubnetName` + +The subnet name for the container app deployment script. Only required if private networking is used. If not provided, a default name will be used. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.containerAppDeploymentScriptSubnetPrefix` + +The subnet address prefix for the container app deployment script which is used to start the placeholder Azure DevOps agent. Only required if private networking is used. If not provided, a default subnet prefix will be used. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.containerAppSubnetAddressPrefix` + +The container app subnet CIDR in the created virtual network. If not provided, a default subnet prefix will be used. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.containerAppSubnetName` + +The container app subnet name in the created virtual network. If not provided, a default name will be used. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.containerInstanceSubnetAddressPrefix` + +The container instance subnet CIDR in the created virtual network. If not provided, a default subnet prefix will be used. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.containerInstanceSubnetName` + +The container instance subnet name in the created virtual network. If not provided, a default name will be used. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.containerInstancesubnetPrefix` + +The container instance subnet address prefix in the created virtual network. If not provided, a default subnet prefix will be used. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.containerRegistryPrivateDnsZoneResourceId` + +The container registry private DNS zone Id. If not provided, a new private DNS zone will be created. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.containerRegistryPrivateEndpointSubnetName` + +The subnet name for the container registry private endpoint. If not provided, a default name will be used. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.containerRegistrySubnetPrefix` + +The container registry subnet address prefix in the created virtual network. If not provided, a default subnet prefix will be used. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.deploymentScriptPrivateDnsZoneResourceId` + +The deployment script private DNS zone Id. If not provided, a new private DNS zone will be created. Only required if private networking is used. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.natGatewayPublicIpAddressResourceId` + +The existing public IP address to assosciate with the NAT gateway. This should be provided if an existing public Ip address is available to be used. If this parameter is not provided, a new Public Ip address will be created. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-createNew.natGatewayResourceId` + +The existing NAT Gateway resource Id. This should be provided if an existing NAT gateway is available to be used. If this parameter is not provided, a new NAT gateway will be created. + +- Required: No +- Type: string + +### Variant: `networkingConfiguration.networkType-useExisting` + + +To use this variant, set the property `networkType` to `useExisting`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`computeNetworking`](#parameter-networkingconfigurationnetworktype-useexistingcomputenetworking) | object | The compute type networking type. | +| [`containerRegistryPrivateEndpointSubnetName`](#parameter-networkingconfigurationnetworktype-useexistingcontainerregistryprivateendpointsubnetname) | string | The subnet name for the container registry private endpoint. | +| [`networkType`](#parameter-networkingconfigurationnetworktype-useexistingnetworktype) | string | The network type. This can be either createNew or useExisting. | +| [`virtualNetworkResourceId`](#parameter-networkingconfigurationnetworktype-useexistingvirtualnetworkresourceid) | string | The existing virtual network resource Id. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`containerRegistryPrivateDnsZoneResourceId`](#parameter-networkingconfigurationnetworktype-useexistingcontainerregistryprivatednszoneresourceid) | string | The container registry private DNS zone Id. If not provided, a new private DNS zone will be created. | +| [`natGatewayPublicIpAddressResourceId`](#parameter-networkingconfigurationnetworktype-useexistingnatgatewaypublicipaddressresourceid) | string | The existing public IP address to assosciate with the NAT gateway. This should be provided if an existing public Ip address is available to be used. If this parameter is not provided, a new Public Ip address will be created. | +| [`natGatewayResourceId`](#parameter-networkingconfigurationnetworktype-useexistingnatgatewayresourceid) | string | The existing NAT Gateway resource Id. This should be provided if an existing NAT gateway is available to be used. If this parameter is not provided, a new NAT gateway will be created. | + +### Parameter: `networkingConfiguration.networkType-useExisting.computeNetworking` + +The compute type networking type. + +- Required: Yes +- Type: object +- Type deciding property: computeNetworkType + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`azureContainerApp`](#variant-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerapp) | | +| [`azureContainerInstance`](#variant-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerinstance) | | + +### Variant: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerApp` + + +To use this variant, set the property `computeNetworkType` to `azureContainerApp`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`computeNetworkType`](#parameter-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerappcomputenetworktype) | string | The Azure Container App networking type. | +| [`containerAppDeploymentScriptSubnetName`](#parameter-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerappcontainerappdeploymentscriptsubnetname) | string | The existing subnet name for the container app deployment script. | +| [`containerAppSubnetName`](#parameter-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerappcontainerappsubnetname) | string | The existing network container app subnet name. This is required for Container Apps compute type. This subnet needs to have service delegation for App environments. | +| [`containerInstanceSubnetName`](#parameter-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerappcontainerinstancesubnetname) | string | The container instance subnet name in the created virtual network. If not provided, a default name will be used. This subnet is required for private networking Azure DevOps scenarios to deploy the deployment script which starts the placeholder agent privately. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`deploymentScriptPrivateDnsZoneResourceId`](#parameter-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerappdeploymentscriptprivatednszoneresourceid) | string | The deployment script private DNS zone Id. If not provided, a new private DNS zone will be created. | + +### Parameter: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerApp.computeNetworkType` + +The Azure Container App networking type. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'azureContainerApp' + ] + ``` + +### Parameter: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerApp.containerAppDeploymentScriptSubnetName` + +The existing subnet name for the container app deployment script. + +- Required: Yes +- Type: string + +### Parameter: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerApp.containerAppSubnetName` + +The existing network container app subnet name. This is required for Container Apps compute type. This subnet needs to have service delegation for App environments. + +- Required: Yes +- Type: string + +### Parameter: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerApp.containerInstanceSubnetName` + +The container instance subnet name in the created virtual network. If not provided, a default name will be used. This subnet is required for private networking Azure DevOps scenarios to deploy the deployment script which starts the placeholder agent privately. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerApp.deploymentScriptPrivateDnsZoneResourceId` + +The deployment script private DNS zone Id. If not provided, a new private DNS zone will be created. + +- Required: No +- Type: string + +### Variant: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerInstance` + + +To use this variant, set the property `computeNetworkType` to `azureContainerInstance`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`computeNetworkType`](#parameter-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerinstancecomputenetworktype) | string | The Azure Container Instance network type. | +| [`containerInstanceSubnetName`](#parameter-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerinstancecontainerinstancesubnetname) | string | The container instance subnet name in the created virtual network. If not provided, a default name will be used. | + +### Parameter: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerInstance.computeNetworkType` + +The Azure Container Instance network type. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'azureContainerInstance' + ] + ``` + +### Parameter: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerInstance.containerInstanceSubnetName` + +The container instance subnet name in the created virtual network. If not provided, a default name will be used. + +- Required: Yes +- Type: string + +### Parameter: `networkingConfiguration.networkType-useExisting.containerRegistryPrivateEndpointSubnetName` + +The subnet name for the container registry private endpoint. + +- Required: Yes +- Type: string + +### Parameter: `networkingConfiguration.networkType-useExisting.networkType` + +The network type. This can be either createNew or useExisting. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'useExisting' + ] + ``` + +### Parameter: `networkingConfiguration.networkType-useExisting.virtualNetworkResourceId` + +The existing virtual network resource Id. + +- Required: Yes +- Type: string + +### Parameter: `networkingConfiguration.networkType-useExisting.containerRegistryPrivateDnsZoneResourceId` + +The container registry private DNS zone Id. If not provided, a new private DNS zone will be created. + +- Required: No +- Type: string + +### Parameter: `networkingConfiguration.networkType-useExisting.natGatewayPublicIpAddressResourceId` + +The existing public IP address to assosciate with the NAT gateway. This should be provided if an existing public Ip address is available to be used. If this parameter is not provided, a new Public Ip address will be created. + +- Required: Yes +- Type: string + +### Parameter: `networkingConfiguration.networkType-useExisting.natGatewayResourceId` + +The existing NAT Gateway resource Id. This should be provided if an existing NAT gateway is available to be used. If this parameter is not provided, a new NAT gateway will be created. + +- Required: Yes +- Type: string ### Parameter: `selfHostedConfig` @@ -1335,6 +1670,521 @@ The self-hosted runner configuration. This can be either GitHub or Azure DevOps. - Required: Yes - Type: object +- Type deciding property: selfHostedType + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`createNew`](#variant-networkingconfigurationnetworktype-createnew) | | +| [`useExisting`](#variant-networkingconfigurationnetworktype-useexisting) | | + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`github`](#variant-selfhostedconfigselfhostedtype-github) | | +| [`azuredevops`](#variant-selfhostedconfigselfhostedtype-azuredevops) | | + +### Variant: `selfHostedConfig.selfHostedType-github` + + +To use this variant, set the property `selfHostedType` to `github`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`githubOrganization`](#parameter-selfhostedconfigselfhostedtype-githubgithuborganization) | string | The GitHub organization name. | +| [`githubRepository`](#parameter-selfhostedconfigselfhostedtype-githubgithubrepository) | string | The GitHub repository name. | +| [`personalAccessToken`](#parameter-selfhostedconfigselfhostedtype-githubpersonalaccesstoken) | securestring | The GitHub personal access token with permissions to create and manage self-hosted runners. See https://learn.microsoft.com/azure/container-apps/tutorial-ci-cd-runners-jobs?tabs=bash&pivots=container-apps-jobs-self-hosted-ci-cd-github-actions#get-a-github-personal-access-token for PAT permissions. The permissions will change based on the scope of the runner. | +| [`selfHostedType`](#parameter-selfhostedconfigselfhostedtype-githubselfhostedtype) | string | The self-hosted runner type. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`azureContainerAppTarget`](#parameter-selfhostedconfigselfhostedtype-githubazurecontainerapptarget) | object | The GitHub runner Azure Container app configuration. | +| [`azureContainerInstanceTarget`](#parameter-selfhostedconfigselfhostedtype-githubazurecontainerinstancetarget) | object | The GitHub runner Azure Container instance configuration. | +| [`ephemeral`](#parameter-selfhostedconfigselfhostedtype-githubephemeral) | bool | Deploy ephemeral runners. | +| [`runnerGroup`](#parameter-selfhostedconfigselfhostedtype-githubrunnergroup) | string | The GitHub runner group. | +| [`runnerName`](#parameter-selfhostedconfigselfhostedtype-githubrunnername) | string | The GitHub runner name. | +| [`runnerNamePrefix`](#parameter-selfhostedconfigselfhostedtype-githubrunnernameprefix) | string | The GitHub runner name prefix. | +| [`runnerScope`](#parameter-selfhostedconfigselfhostedtype-githubrunnerscope) | string | The GitHub runner scope. Depending on the scope, you would need to set the right permissions for your Personal Access Token. | +| [`targetWorkflowQueueLength`](#parameter-selfhostedconfigselfhostedtype-githubtargetworkflowqueuelength) | string | The target workflow queue length. | + +### Parameter: `selfHostedConfig.selfHostedType-github.githubOrganization` + +The GitHub organization name. + +- Required: Yes +- Type: string + +### Parameter: `selfHostedConfig.selfHostedType-github.githubRepository` + +The GitHub repository name. + +- Required: No +- Type: string + +### Parameter: `selfHostedConfig.selfHostedType-github.personalAccessToken` + +The GitHub personal access token with permissions to create and manage self-hosted runners. See https://learn.microsoft.com/azure/container-apps/tutorial-ci-cd-runners-jobs?tabs=bash&pivots=container-apps-jobs-self-hosted-ci-cd-github-actions#get-a-github-personal-access-token for PAT permissions. The permissions will change based on the scope of the runner. + +- Required: Yes +- Type: securestring + +### Parameter: `selfHostedConfig.selfHostedType-github.selfHostedType` + +The self-hosted runner type. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'github' + ] + ``` + +### Parameter: `selfHostedConfig.selfHostedType-github.azureContainerAppTarget` + +The GitHub runner Azure Container app configuration. + +- Required: No +- Type: object + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`resources`](#parameter-selfhostedconfigselfhostedtype-githubazurecontainerapptargetresources) | object | The Azure Container App Job CPU and memory resources. | + +### Parameter: `selfHostedConfig.selfHostedType-github.azureContainerAppTarget.resources` + +The Azure Container App Job CPU and memory resources. + +- Required: No +- Type: object +- Allowed: + ```Bicep + [ + { + cpu: '0.25' + memory: '0.5Gi' + } + { + cpu: '0.5' + memory: '1Gi' + } + { + cpu: '0.75' + memory: '1.5Gi' + } + { + cpu: '1' + memory: '2Gi' + } + { + cpu: '1.25' + memory: '2.5Gi' + } + { + cpu: '1.5' + memory: '3Gi' + } + { + cpu: '1.75' + memory: '3.5Gi' + } + { + cpu: '2' + memory: '4Gi' + } + { + cpu: '2.25' + memory: '4.5Gi' + } + { + cpu: '2.5' + memory: '5Gi' + } + { + cpu: '2.75' + memory: '5.5Gi' + } + { + cpu: '3' + memory: '6Gi' + } + { + cpu: '3.25' + memory: '6.5Gi' + } + { + cpu: '3.5' + memory: '7Gi' + } + { + cpu: '3.75' + memory: '7.5Gi' + } + { + cpu: '4' + memory: '8Gi' + } + ] + ``` + +### Parameter: `selfHostedConfig.selfHostedType-github.azureContainerInstanceTarget` + +The GitHub runner Azure Container instance configuration. + +- Required: No +- Type: object + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`cpu`](#parameter-selfhostedconfigselfhostedtype-githubazurecontainerinstancetargetcpu) | int | The Azure Container Instance container cpu. | +| [`memoryInGB`](#parameter-selfhostedconfigselfhostedtype-githubazurecontainerinstancetargetmemoryingb) | int | The Azure Container Instance container memory. | +| [`numberOfInstances`](#parameter-selfhostedconfigselfhostedtype-githubazurecontainerinstancetargetnumberofinstances) | int | The number of the Azure Container Instances to deploy. | +| [`port`](#parameter-selfhostedconfigselfhostedtype-githubazurecontainerinstancetargetport) | int | The Azure Container Instance container port. | +| [`sku`](#parameter-selfhostedconfigselfhostedtype-githubazurecontainerinstancetargetsku) | string | The Azure Container Instance Sku name. | + +### Parameter: `selfHostedConfig.selfHostedType-github.azureContainerInstanceTarget.cpu` + +The Azure Container Instance container cpu. + +- Required: No +- Type: int + +### Parameter: `selfHostedConfig.selfHostedType-github.azureContainerInstanceTarget.memoryInGB` + +The Azure Container Instance container memory. + +- Required: No +- Type: int + +### Parameter: `selfHostedConfig.selfHostedType-github.azureContainerInstanceTarget.numberOfInstances` + +The number of the Azure Container Instances to deploy. + +- Required: No +- Type: int + +### Parameter: `selfHostedConfig.selfHostedType-github.azureContainerInstanceTarget.port` + +The Azure Container Instance container port. + +- Required: No +- Type: int + +### Parameter: `selfHostedConfig.selfHostedType-github.azureContainerInstanceTarget.sku` + +The Azure Container Instance Sku name. + +- Required: No +- Type: string +- Allowed: + ```Bicep + [ + 'Dedicated' + 'Standard' + ] + ``` + +### Parameter: `selfHostedConfig.selfHostedType-github.ephemeral` + +Deploy ephemeral runners. + +- Required: No +- Type: bool +- Allowed: + ```Bicep + [ + true + ] + ``` + +### Parameter: `selfHostedConfig.selfHostedType-github.runnerGroup` + +The GitHub runner group. + +- Required: No +- Type: string + +### Parameter: `selfHostedConfig.selfHostedType-github.runnerName` + +The GitHub runner name. + +- Required: No +- Type: string + +### Parameter: `selfHostedConfig.selfHostedType-github.runnerNamePrefix` + +The GitHub runner name prefix. + +- Required: No +- Type: string + +### Parameter: `selfHostedConfig.selfHostedType-github.runnerScope` + +The GitHub runner scope. Depending on the scope, you would need to set the right permissions for your Personal Access Token. + +- Required: No +- Type: string +- Allowed: + ```Bicep + [ + 'ent' + 'org' + 'repo' + ] + ``` + +### Parameter: `selfHostedConfig.selfHostedType-github.targetWorkflowQueueLength` + +The target workflow queue length. + +- Required: No +- Type: string + +### Variant: `selfHostedConfig.selfHostedType-azuredevops` + + +To use this variant, set the property `selfHostedType` to `azuredevops`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`agentsPoolName`](#parameter-selfhostedconfigselfhostedtype-azuredevopsagentspoolname) | string | The Azure DevOps agents pool name. | +| [`devOpsOrganization`](#parameter-selfhostedconfigselfhostedtype-azuredevopsdevopsorganization) | string | The Azure DevOps organization name. | +| [`personalAccessToken`](#parameter-selfhostedconfigselfhostedtype-azuredevopspersonalaccesstoken) | securestring | The Azure DevOps persoanl access token with permissions to create and manage self-hosted agents. See https://learn.microsoft.com/azure/container-apps/tutorial-ci-cd-runners-jobs?tabs=bash&pivots=container-apps-jobs-self-hosted-ci-cd-azure-pipelines#get-an-azure-devops-personal-access-token for PAT permissions. | +| [`selfHostedType`](#parameter-selfhostedconfigselfhostedtype-azuredevopsselfhostedtype) | string | The self-hosted runner type. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`agentName`](#parameter-selfhostedconfigselfhostedtype-azuredevopsagentname) | string | The Azure DevOps agent name. | +| [`agentNamePrefix`](#parameter-selfhostedconfigselfhostedtype-azuredevopsagentnameprefix) | string | The Azure DevOps agent name prefix. | +| [`azureContainerAppTarget`](#parameter-selfhostedconfigselfhostedtype-azuredevopsazurecontainerapptarget) | object | The AzureDevOps agents Azure Container app configuration. | +| [`azureContainerInstanceTarget`](#parameter-selfhostedconfigselfhostedtype-azuredevopsazurecontainerinstancetarget) | object | The GitHub runner Azure Container instance configuration. | +| [`placeHolderAgentName`](#parameter-selfhostedconfigselfhostedtype-azuredevopsplaceholderagentname) | string | The Azure DevOps placeholder agent name. | +| [`targetPipelinesQueueLength`](#parameter-selfhostedconfigselfhostedtype-azuredevopstargetpipelinesqueuelength) | string | The target pipelines queue length. | + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.agentsPoolName` + +The Azure DevOps agents pool name. + +- Required: Yes +- Type: string + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.devOpsOrganization` + +The Azure DevOps organization name. + +- Required: Yes +- Type: string + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.personalAccessToken` + +The Azure DevOps persoanl access token with permissions to create and manage self-hosted agents. See https://learn.microsoft.com/azure/container-apps/tutorial-ci-cd-runners-jobs?tabs=bash&pivots=container-apps-jobs-self-hosted-ci-cd-azure-pipelines#get-an-azure-devops-personal-access-token for PAT permissions. + +- Required: Yes +- Type: securestring + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.selfHostedType` + +The self-hosted runner type. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'azuredevops' + ] + ``` + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.agentName` + +The Azure DevOps agent name. + +- Required: No +- Type: string + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.agentNamePrefix` + +The Azure DevOps agent name prefix. + +- Required: No +- Type: string + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.azureContainerAppTarget` + +The AzureDevOps agents Azure Container app configuration. + +- Required: No +- Type: object + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`resources`](#parameter-selfhostedconfigselfhostedtype-azuredevopsazurecontainerapptargetresources) | object | The Azure Container App Job CPU and memory resources. | + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.azureContainerAppTarget.resources` + +The Azure Container App Job CPU and memory resources. + +- Required: No +- Type: object +- Allowed: + ```Bicep + [ + { + cpu: '0.25' + memory: '0.5Gi' + } + { + cpu: '0.5' + memory: '1Gi' + } + { + cpu: '0.75' + memory: '1.5Gi' + } + { + cpu: '1' + memory: '2Gi' + } + { + cpu: '1.25' + memory: '2.5Gi' + } + { + cpu: '1.5' + memory: '3Gi' + } + { + cpu: '1.75' + memory: '3.5Gi' + } + { + cpu: '2' + memory: '4Gi' + } + { + cpu: '2.25' + memory: '4.5Gi' + } + { + cpu: '2.5' + memory: '5Gi' + } + { + cpu: '2.75' + memory: '5.5Gi' + } + { + cpu: '3' + memory: '6Gi' + } + { + cpu: '3.25' + memory: '6.5Gi' + } + { + cpu: '3.5' + memory: '7Gi' + } + { + cpu: '3.75' + memory: '7.5Gi' + } + { + cpu: '4' + memory: '8Gi' + } + ] + ``` + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.azureContainerInstanceTarget` + +The GitHub runner Azure Container instance configuration. + +- Required: No +- Type: object + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`cpu`](#parameter-selfhostedconfigselfhostedtype-azuredevopsazurecontainerinstancetargetcpu) | int | The Azure Container Instance container cpu. | +| [`memoryInGB`](#parameter-selfhostedconfigselfhostedtype-azuredevopsazurecontainerinstancetargetmemoryingb) | int | The Azure Container Instance container memory. | +| [`numberOfInstances`](#parameter-selfhostedconfigselfhostedtype-azuredevopsazurecontainerinstancetargetnumberofinstances) | int | The number of the Azure Container Instances to deploy. | +| [`port`](#parameter-selfhostedconfigselfhostedtype-azuredevopsazurecontainerinstancetargetport) | int | The Azure Container Instance container port. | +| [`sku`](#parameter-selfhostedconfigselfhostedtype-azuredevopsazurecontainerinstancetargetsku) | string | The Azure Container Instance Sku name. | + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.azureContainerInstanceTarget.cpu` + +The Azure Container Instance container cpu. + +- Required: No +- Type: int + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.azureContainerInstanceTarget.memoryInGB` + +The Azure Container Instance container memory. + +- Required: No +- Type: int + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.azureContainerInstanceTarget.numberOfInstances` + +The number of the Azure Container Instances to deploy. + +- Required: No +- Type: int + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.azureContainerInstanceTarget.port` + +The Azure Container Instance container port. + +- Required: No +- Type: int + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.azureContainerInstanceTarget.sku` + +The Azure Container Instance Sku name. + +- Required: No +- Type: string +- Allowed: + ```Bicep + [ + 'Dedicated' + 'Standard' + ] + ``` + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.placeHolderAgentName` + +The Azure DevOps placeholder agent name. + +- Required: No +- Type: string + +### Parameter: `selfHostedConfig.selfHostedType-azuredevops.targetPipelinesQueueLength` + +The target pipelines queue length. + +- Required: No +- Type: string ### Parameter: `enableTelemetry` diff --git a/avm/ptn/lz/sub-vending/README.md b/avm/ptn/lz/sub-vending/README.md index b1d81bc858..033ebb399b 100644 --- a/avm/ptn/lz/sub-vending/README.md +++ b/avm/ptn/lz/sub-vending/README.md @@ -1096,6 +1096,168 @@ The type of template for the role assignment condition. - Required: No - Type: object +- Type-deciding property: templateName + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`excludeRoles`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-excluderoles) | | +| [`constrainRoles`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainroles) | | +| [`constrainRolesAndPrincipalTypes`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipaltypes) | | +| [`constrainRolesAndPrincipals`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipals) | | + +### Variant: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-excludeRoles` + + +To use this variant, set the property `templateName` to `excludeRoles`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`ExludededRoles`](#parameter-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-excluderolesexludededroles) | array | The list of roles that are not allowed to be assigned by the delegate. | +| [`templateName`](#parameter-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-excluderolestemplatename) | string | Name of the RBAC condition template. | + +### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-excludeRoles.ExludededRoles` + +The list of roles that are not allowed to be assigned by the delegate. + +- Required: Yes +- Type: array + +### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-excludeRoles.templateName` + +Name of the RBAC condition template. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'excludeRoles' + ] + ``` + +### Variant: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRoles` + + +To use this variant, set the property `templateName` to `constrainRoles`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`rolesToAssign`](#parameter-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesrolestoassign) | array | The list of roles that are allowed to be assigned by the delegate. | +| [`templateName`](#parameter-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolestemplatename) | string | Name of the RBAC condition template. | + +### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRoles.rolesToAssign` + +The list of roles that are allowed to be assigned by the delegate. + +- Required: Yes +- Type: array + +### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRoles.templateName` + +Name of the RBAC condition template. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'constrainRoles' + ] + ``` + +### Variant: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRolesAndPrincipalTypes` + + +To use this variant, set the property `templateName` to `constrainRolesAndPrincipalTypes`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`principleTypesToAssign`](#parameter-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipaltypesprincipletypestoassign) | array | The list of principle types that are allowed to be assigned roles by the delegate. | +| [`rolesToAssign`](#parameter-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipaltypesrolestoassign) | array | The list of roles that are allowed to be assigned by the delegate. | +| [`templateName`](#parameter-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipaltypestemplatename) | string | Name of the RBAC condition template. | + +### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRolesAndPrincipalTypes.principleTypesToAssign` + +The list of principle types that are allowed to be assigned roles by the delegate. + +- Required: Yes +- Type: array +- Allowed: + ```Bicep + [ + 'Group' + 'ServicePrincipal' + 'User' + ] + ``` + +### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRolesAndPrincipalTypes.rolesToAssign` + +The list of roles that are allowed to be assigned by the delegate. + +- Required: Yes +- Type: array + +### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRolesAndPrincipalTypes.templateName` + +Name of the RBAC condition template. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'constrainRolesAndPrincipalTypes' + ] + ``` + +### Variant: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRolesAndPrincipals` + + +To use this variant, set the property `templateName` to `constrainRolesAndPrincipals`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`principalsToAssignTo`](#parameter-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipalsprincipalstoassignto) | array | The list of principals that are allowed to be assigned roles by the delegate. | +| [`rolesToAssign`](#parameter-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipalsrolestoassign) | array | The list of roles that are allowed to be assigned by the delegate. | +| [`templateName`](#parameter-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipalstemplatename) | string | Name of the RBAC condition template. | + +### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRolesAndPrincipals.principalsToAssignTo` + +The list of principals that are allowed to be assigned roles by the delegate. + +- Required: Yes +- Type: array + +### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRolesAndPrincipals.rolesToAssign` + +The list of roles that are allowed to be assigned by the delegate. + +- Required: Yes +- Type: array + +### Parameter: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-constrainRolesAndPrincipals.templateName` + +Name of the RBAC condition template. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'constrainRolesAndPrincipals' + ] + ``` ### Parameter: `subscriptionAliasEnabled` diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 07dd527f5c..b1431e6b62 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -513,7 +513,7 @@ function Set-DefinitionSection { ((-not [String]::IsNullOrEmpty($formattedMaxValue)) ? $formattedMaxValue : $null), ((-not [String]::IsNullOrEmpty($formattedRoleNames)) ? $formattedRoleNames : $null), ((-not [String]::IsNullOrEmpty($formattedExample)) ? $formattedExample : $null), - (($definition.discriminator.propertyName) ? ('- Type deciding property: {0}' -f $definition.discriminator.propertyName) : $null), + (($definition.discriminator.propertyName) ? ('- Type-deciding property: {0}' -f $definition.discriminator.propertyName) : $null), '' ) | Where-Object { $null -ne $_ } From 81c50953d8fba593bd097e785c28b3b168c0b28b Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 20:04:59 +0100 Subject: [PATCH 10/43] Update to latest --- avm/res/dev-ops-infrastructure/pool/README.md | 954 ++++++++++++++++++ .../insights/data-collection-rule/README.md | 11 +- avm/res/insights/metric-alert/README.md | 24 + .../workspace/README.md | 244 +++++ .../workspace/connection/README.md | 1 + .../network/virtual-network-gateway/README.md | 131 +++ .../image-template/README.md | 238 +++++ 7 files changed, 1602 insertions(+), 1 deletion(-) diff --git a/avm/res/dev-ops-infrastructure/pool/README.md b/avm/res/dev-ops-infrastructure/pool/README.md index 88d2d8092f..bbc4af4dad 100644 --- a/avm/res/dev-ops-infrastructure/pool/README.md +++ b/avm/res/dev-ops-infrastructure/pool/README.md @@ -722,6 +722,960 @@ Defines how the machine will be handled once it executed a job. - Required: Yes - Type: object +- Type-deciding property: kind + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`Stateful`](#variant-agentprofilekind-stateful) | | +| [`Stateless`](#variant-agentprofilekind-stateless) | | + +### Variant: `agentProfile.kind-Stateful` + + +To use this variant, set the property `kind` to `Stateful`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`gracePeriodTimeSpan`](#parameter-agentprofilekind-statefulgraceperiodtimespan) | string | How long should the machine be kept around after it ran a workload when there are no stand-by agents. The maximum is one week. | +| [`kind`](#parameter-agentprofilekind-statefulkind) | string | Stateful profile meaning that the machines will be returned to the pool after running a job. | +| [`maxAgentLifetime`](#parameter-agentprofilekind-statefulmaxagentlifetime) | string | How long should stateful machines be kept around. The maximum is one week. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`resourcePredictions`](#parameter-agentprofilekind-statefulresourcepredictions) | object | Defines pool buffer/stand-by agents. | +| [`resourcePredictionsProfile`](#parameter-agentprofilekind-statefulresourcepredictionsprofile) | object | Determines how the stand-by scheme should be provided. | + +### Parameter: `agentProfile.kind-Stateful.gracePeriodTimeSpan` + +How long should the machine be kept around after it ran a workload when there are no stand-by agents. The maximum is one week. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.kind` + +Stateful profile meaning that the machines will be returned to the pool after running a job. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Stateful' + ] + ``` + +### Parameter: `agentProfile.kind-Stateful.maxAgentLifetime` + +How long should stateful machines be kept around. The maximum is one week. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions` + +Defines pool buffer/stand-by agents. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`timeZone`](#parameter-agentprofilekind-statefulresourcepredictionstimezone) | string | The time zone in which the daysData is provided. To see the list of available time zones, see: https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11#time-zones or via PowerShell command `(Get-TimeZone -ListAvailable).StandardName`. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`daysData`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdata) | object | The number of agents needed at a specific time. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.timeZone` + +The time zone in which the daysData is provided. To see the list of available time zones, see: https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11#time-zones or via PowerShell command `(Get-TimeZone -ListAvailable).StandardName`. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData` + +The number of agents needed at a specific time. + +- Required: No +- Type: object + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`friday`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatafriday) | object | The number of agents needed at a specific time for Friday. | +| [`monday`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatamonday) | object | The number of agents needed at a specific time for Monday. | +| [`saturday`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatasaturday) | object | The number of agents needed at a specific time for Saturday. | +| [`sunday`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatasunday) | object | The number of agents needed at a specific time for Sunday. | +| [`thursday`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatathursday) | object | The number of agents needed at a specific time for Thursday. | +| [`tuesday`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatatuesday) | object | The number of agents needed at a specific time for Tuesday. | +| [`wednesday`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatawednesday) | object | The number of agents needed at a specific time for Wednesday. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.friday` + +The number of agents needed at a specific time for Friday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatafridayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatafridayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatafridaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatafridaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.friday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.friday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.friday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.friday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.monday` + +The number of agents needed at a specific time for Monday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatamondayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatamondayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatamondaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatamondaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.monday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.monday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.monday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.monday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.saturday` + +The number of agents needed at a specific time for Saturday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatasaturdayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatasaturdayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatasaturdaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatasaturdaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.saturday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.saturday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.saturday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.saturday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.sunday` + +The number of agents needed at a specific time for Sunday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatasundayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatasundayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatasundaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatasundaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.sunday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.sunday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.sunday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.sunday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.thursday` + +The number of agents needed at a specific time for Thursday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatathursdayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatathursdayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatathursdaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatathursdaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.thursday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.thursday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.thursday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.thursday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.tuesday` + +The number of agents needed at a specific time for Tuesday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatatuesdayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatatuesdayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatatuesdaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatatuesdaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.tuesday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.tuesday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.tuesday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.tuesday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.wednesday` + +The number of agents needed at a specific time for Wednesday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatawednesdayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatawednesdayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatawednesdaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statefulresourcepredictionsdaysdatawednesdaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.wednesday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.wednesday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.wednesday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateful.resourcePredictions.daysData.wednesday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateful.resourcePredictionsProfile` + +Determines how the stand-by scheme should be provided. + +- Required: No +- Type: object +- Type-deciding property: kind + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`Automatic`](#variant-agentprofilekind-statefulresourcepredictionsprofilekind-automatic) | | +| [`Manual`](#variant-agentprofilekind-statefulresourcepredictionsprofilekind-manual) | | + +### Variant: `agentProfile.kind-Stateful.resourcePredictionsProfile.kind-Automatic` + + +To use this variant, set the property `kind` to `Automatic`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`kind`](#parameter-agentprofilekind-statefulresourcepredictionsprofilekind-automatickind) | string | The stand-by agent scheme is determined based on historical demand. | +| [`predictionPreference`](#parameter-agentprofilekind-statefulresourcepredictionsprofilekind-automaticpredictionpreference) | string | Determines the balance between cost and performance. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictionsProfile.kind-Automatic.kind` + +The stand-by agent scheme is determined based on historical demand. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Automatic' + ] + ``` + +### Parameter: `agentProfile.kind-Stateful.resourcePredictionsProfile.kind-Automatic.predictionPreference` + +Determines the balance between cost and performance. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Balanced' + 'BestPerformance' + 'MoreCostEffective' + 'MorePerformance' + 'MostCostEffective' + ] + ``` + +### Variant: `agentProfile.kind-Stateful.resourcePredictionsProfile.kind-Manual` + + +To use this variant, set the property `kind` to `Manual`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`kind`](#parameter-agentprofilekind-statefulresourcepredictionsprofilekind-manualkind) | string | Customer provides the stand-by agent scheme. | + +### Parameter: `agentProfile.kind-Stateful.resourcePredictionsProfile.kind-Manual.kind` + +Customer provides the stand-by agent scheme. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Manual' + ] + ``` + +### Variant: `agentProfile.kind-Stateless` + + +To use this variant, set the property `kind` to `Stateless`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`kind`](#parameter-agentprofilekind-statelesskind) | string | Stateless profile meaning that the machines will be cleaned up after running a job. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`resourcePredictions`](#parameter-agentprofilekind-statelessresourcepredictions) | object | Defines pool buffer/stand-by agents. | +| [`resourcePredictionsProfile`](#parameter-agentprofilekind-statelessresourcepredictionsprofile) | object | Determines how the stand-by scheme should be provided. | + +### Parameter: `agentProfile.kind-Stateless.kind` + +Stateless profile meaning that the machines will be cleaned up after running a job. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Stateless' + ] + ``` + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions` + +Defines pool buffer/stand-by agents. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`timeZone`](#parameter-agentprofilekind-statelessresourcepredictionstimezone) | string | The time zone in which the daysData is provided. To see the list of available time zones, see: https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11#time-zones or via PowerShell command `(Get-TimeZone -ListAvailable).StandardName`. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`daysData`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdata) | object | The number of agents needed at a specific time. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.timeZone` + +The time zone in which the daysData is provided. To see the list of available time zones, see: https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11#time-zones or via PowerShell command `(Get-TimeZone -ListAvailable).StandardName`. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData` + +The number of agents needed at a specific time. + +- Required: No +- Type: object + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`friday`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatafriday) | object | The number of agents needed at a specific time for Friday. | +| [`monday`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatamonday) | object | The number of agents needed at a specific time for Monday. | +| [`saturday`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatasaturday) | object | The number of agents needed at a specific time for Saturday. | +| [`sunday`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatasunday) | object | The number of agents needed at a specific time for Sunday. | +| [`thursday`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatathursday) | object | The number of agents needed at a specific time for Thursday. | +| [`tuesday`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatatuesday) | object | The number of agents needed at a specific time for Tuesday. | +| [`wednesday`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatawednesday) | object | The number of agents needed at a specific time for Wednesday. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.friday` + +The number of agents needed at a specific time for Friday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatafridayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatafridayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatafridaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatafridaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.friday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.friday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.friday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.friday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.monday` + +The number of agents needed at a specific time for Monday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatamondayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatamondayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatamondaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatamondaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.monday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.monday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.monday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.monday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.saturday` + +The number of agents needed at a specific time for Saturday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatasaturdayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatasaturdayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatasaturdaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatasaturdaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.saturday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.saturday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.saturday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.saturday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.sunday` + +The number of agents needed at a specific time for Sunday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatasundayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatasundayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatasundaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatasundaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.sunday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.sunday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.sunday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.sunday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.thursday` + +The number of agents needed at a specific time for Thursday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatathursdayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatathursdayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatathursdaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatathursdaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.thursday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.thursday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.thursday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.thursday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.tuesday` + +The number of agents needed at a specific time for Tuesday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatatuesdayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatatuesdayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatatuesdaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatatuesdaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.tuesday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.tuesday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.tuesday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.tuesday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.wednesday` + +The number of agents needed at a specific time for Wednesday. + +- Required: No +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatawednesdayendagentcount) | int | The number of agents needed at the end time. | +| [`endTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatawednesdayendtime) | string | The time at which the agents are no longer needed. | +| [`startAgentCount`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatawednesdaystartagentcount) | int | The number of agents needed at the start time. | +| [`startTime`](#parameter-agentprofilekind-statelessresourcepredictionsdaysdatawednesdaystarttime) | string | The time at which the agents are needed. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.wednesday.endAgentCount` + +The number of agents needed at the end time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.wednesday.endTime` + +The time at which the agents are no longer needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.wednesday.startAgentCount` + +The number of agents needed at the start time. + +- Required: Yes +- Type: int + +### Parameter: `agentProfile.kind-Stateless.resourcePredictions.daysData.wednesday.startTime` + +The time at which the agents are needed. + +- Required: Yes +- Type: string + +### Parameter: `agentProfile.kind-Stateless.resourcePredictionsProfile` + +Determines how the stand-by scheme should be provided. + +- Required: No +- Type: object +- Type-deciding property: kind + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`Automatic`](#variant-agentprofilekind-statelessresourcepredictionsprofilekind-automatic) | | +| [`Manual`](#variant-agentprofilekind-statelessresourcepredictionsprofilekind-manual) | | + +### Variant: `agentProfile.kind-Stateless.resourcePredictionsProfile.kind-Automatic` + + +To use this variant, set the property `kind` to `Automatic`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`kind`](#parameter-agentprofilekind-statelessresourcepredictionsprofilekind-automatickind) | string | The stand-by agent scheme is determined based on historical demand. | +| [`predictionPreference`](#parameter-agentprofilekind-statelessresourcepredictionsprofilekind-automaticpredictionpreference) | string | Determines the balance between cost and performance. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictionsProfile.kind-Automatic.kind` + +The stand-by agent scheme is determined based on historical demand. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Automatic' + ] + ``` + +### Parameter: `agentProfile.kind-Stateless.resourcePredictionsProfile.kind-Automatic.predictionPreference` + +Determines the balance between cost and performance. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Balanced' + 'BestPerformance' + 'MoreCostEffective' + 'MorePerformance' + 'MostCostEffective' + ] + ``` + +### Variant: `agentProfile.kind-Stateless.resourcePredictionsProfile.kind-Manual` + + +To use this variant, set the property `kind` to `Manual`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`kind`](#parameter-agentprofilekind-statelessresourcepredictionsprofilekind-manualkind) | string | Customer provides the stand-by agent scheme. | + +### Parameter: `agentProfile.kind-Stateless.resourcePredictionsProfile.kind-Manual.kind` + +Customer provides the stand-by agent scheme. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Manual' + ] + ``` ### Parameter: `concurrency` diff --git a/avm/res/insights/data-collection-rule/README.md b/avm/res/insights/data-collection-rule/README.md index 0e68ef5f14..cc5e803d19 100644 --- a/avm/res/insights/data-collection-rule/README.md +++ b/avm/res/insights/data-collection-rule/README.md @@ -8,6 +8,7 @@ This module deploys a Data Collection Rule. - [Usage examples](#Usage-examples) - [Parameters](#Parameters) - [Outputs](#Outputs) +- [Cross-referenced modules](#Cross-referenced-modules) - [Data Collection](#Data-Collection) ## Resource Types @@ -2814,7 +2815,7 @@ The kind of data collection rule. - Required: Yes - Type: object -- Type deciding property: kind +- Type-deciding property: kind

The available variants are:

@@ -3349,6 +3350,14 @@ Resource tags. | `resourceId` | string | The resource ID of the dataCollectionRule. | | `systemAssignedMIPrincipalId` | string | The principal ID of the system assigned identity. | +## Cross-referenced modules + +This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs). + +| Reference | Type | +| :-- | :-- | +| `br/public:avm/utl/types/avm-common-types:0.3.0` | Remote reference | + ## Data Collection The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the [repository](https://aka.ms/avm/telemetry). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at . You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. diff --git a/avm/res/insights/metric-alert/README.md b/avm/res/insights/metric-alert/README.md index 6f390fc6c6..a8d571b3eb 100644 --- a/avm/res/insights/metric-alert/README.md +++ b/avm/res/insights/metric-alert/README.md @@ -533,6 +533,30 @@ Maps to the 'odata.type' field. Specifies the type of the alert criteria. - Required: Yes - Type: object +- Type-deciding property: odata.type + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria`](#variant-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteria) | | +| [`Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria`](#variant-criteriaodatatype-microsoftazuremonitorsingleresourcemultiplemetriccriteria) | | +| [`Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria`](#variant-criteriaodatatype-microsoftazuremonitormultipleresourcemultiplemetriccriteria) | | + +### Variant: `criteria.odata.type-Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria` + + +To use this variant, set the property `odata.type` to `Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria`. + +### Variant: `criteria.odata.type-Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria` + + +To use this variant, set the property `odata.type` to `Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria`. + +### Variant: `criteria.odata.type-Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria` + + +To use this variant, set the property `odata.type` to `Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria`. ### Parameter: `name` diff --git a/avm/res/machine-learning-services/workspace/README.md b/avm/res/machine-learning-services/workspace/README.md index 1a0acebd4e..109f45e010 100644 --- a/avm/res/machine-learning-services/workspace/README.md +++ b/avm/res/machine-learning-services/workspace/README.md @@ -1671,6 +1671,7 @@ The properties of the connection, specific to the auth type. - Required: Yes - Type: secureObject +- Type-deciding property: authType ### Parameter: `connections.name` @@ -2114,6 +2115,249 @@ The outbound rule. The name of the rule is the object key. - Required: Yes - Type: object +- Type-deciding property: type + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`FQDN`](#variant-managednetworksettingsoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-FQDN` + + +To use this variant, set the property `type` to `FQDN`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`destination`](#parameter-managednetworksettingsoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-FQDN.destination` + +Fully Qualified Domain Name to allow for outbound traffic. + +- Required: Yes +- Type: string + +### Parameter: `managedNetworkSettings.outboundRules.>Any_other_property<.type-FQDN.type` + +Type of a managed network Outbound Rule of a machine learning workspace. Only supported when 'isolationMode' is 'AllowOnlyApprovedOutbound'. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'FQDN' + ] + ``` + +### Parameter: `managedNetworkSettings.outboundRules.>Any_other_property<.type-FQDN.category` + +Category of a managed network Outbound Rule of a machine learning workspace. + +- Required: No +- Type: string +- Allowed: + ```Bicep + [ + 'Dependency' + 'Recommended' + 'Required' + 'UserDefined' + ] + ``` + +### Variant: `managedNetworkSettings.outboundRules.>Any_other_property<.type-PrivateEndpoint` + + +To use this variant, set the property `type` to `PrivateEndpoint`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`destination`](#parameter-managednetworksettingsoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-PrivateEndpoint.destination` + +Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`serviceResourceId`](#parameter-managednetworksettingsoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-PrivateEndpoint.destination.serviceResourceId` + +The resource ID of the target resource for the private endpoint. + +- Required: Yes +- Type: string + +### Parameter: `managedNetworkSettings.outboundRules.>Any_other_property<.type-PrivateEndpoint.destination.subresourceTarget` + +The sub resource to connect for the private endpoint. + +- Required: Yes +- Type: string + +### Parameter: `managedNetworkSettings.outboundRules.>Any_other_property<.type-PrivateEndpoint.destination.sparkEnabled` + +Whether the private endpoint can be used by jobs running on Spark. + +- Required: No +- Type: bool + +### Parameter: `managedNetworkSettings.outboundRules.>Any_other_property<.type-PrivateEndpoint.type` + +Type of a managed network Outbound Rule of a machine learning workspace. Only supported when 'isolationMode' is 'AllowOnlyApprovedOutbound' or 'AllowInternetOutbound'. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'PrivateEndpoint' + ] + ``` + +### Parameter: `managedNetworkSettings.outboundRules.>Any_other_property<.type-PrivateEndpoint.category` + +Category of a managed network Outbound Rule of a machine learning workspace. + +- Required: No +- Type: string +- Allowed: + ```Bicep + [ + 'Dependency' + 'Recommended' + 'Required' + 'UserDefined' + ] + ``` + +### Variant: `managedNetworkSettings.outboundRules.>Any_other_property<.type-ServiceTag` + + +To use this variant, set the property `type` to `ServiceTag`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`destination`](#parameter-managednetworksettingsoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-ServiceTag.destination` + +Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`portRanges`](#parameter-managednetworksettingsoutboundrules>any_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-ServiceTag.destination.portRanges` + +The name of the service tag to allow. + +- Required: Yes +- Type: string + +### Parameter: `managedNetworkSettings.outboundRules.>Any_other_property<.type-ServiceTag.destination.protocol` + +The protocol to allow. Provide an asterisk(*) to allow any protocol. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + '*' + 'ICMP' + 'TCP' + 'UDP' + ] + ``` + +### Parameter: `managedNetworkSettings.outboundRules.>Any_other_property<.type-ServiceTag.destination.serviceTag` + +Which ports will be allow traffic by this rule. Provide an asterisk(*) to allow any port. + +- Required: Yes +- Type: string + +### Parameter: `managedNetworkSettings.outboundRules.>Any_other_property<.type-ServiceTag.type` + +Type of a managed network Outbound Rule of a machine learning workspace. Only supported when 'isolationMode' is 'AllowOnlyApprovedOutbound'. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ServiceTag' + ] + ``` + +### Parameter: `managedNetworkSettings.outboundRules.>Any_other_property<.type-ServiceTag.category` + +Category of a managed network Outbound Rule of a machine learning workspace. + +- Required: No +- Type: string +- Allowed: + ```Bicep + [ + 'Dependency' + 'Recommended' + 'Required' + 'UserDefined' + ] + ``` ### Parameter: `privateEndpoints` diff --git a/avm/res/machine-learning-services/workspace/connection/README.md b/avm/res/machine-learning-services/workspace/connection/README.md index c059ca8189..9413c475bf 100644 --- a/avm/res/machine-learning-services/workspace/connection/README.md +++ b/avm/res/machine-learning-services/workspace/connection/README.md @@ -156,6 +156,7 @@ The properties of the connection, specific to the auth type. - Required: Yes - Type: secureObject +- Type-deciding property: authType ### Parameter: `machineLearningWorkspaceName` diff --git a/avm/res/network/virtual-network-gateway/README.md b/avm/res/network/virtual-network-gateway/README.md index 4d876db399..1a418bb3ff 100644 --- a/avm/res/network/virtual-network-gateway/README.md +++ b/avm/res/network/virtual-network-gateway/README.md @@ -2486,6 +2486,137 @@ Specifies one of the following four configurations: Active-Active with (clusterM - Required: Yes - Type: object +- Type-deciding property: clusterMode + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`activeActiveNoBgp`](#variant-clustersettingsclustermode-activeactivenobgp) | | +| [`activeActiveBgp`](#variant-clustersettingsclustermode-activeactivebgp) | | +| [`activePassiveBgp`](#variant-clustersettingsclustermode-activepassivebgp) | | +| [`activePassiveNoBgp`](#variant-clustersettingsclustermode-activepassivenobgp) | | + +### Variant: `clusterSettings.clusterMode-activeActiveNoBgp` + + +To use this variant, set the property `clusterMode` to `activeActiveNoBgp`. + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`existingSecondPipResourceId`](#parameter-clustersettingsclustermode-activeactivenobgpexistingsecondpipresourceid) | string | The secondary Public IP resource ID to associate to the Virtual Network Gateway in the Active-Active mode. If empty, then a new secondary Public IP will be created as part of this module and applied to the Virtual Network Gateway. | +| [`secondPipName`](#parameter-clustersettingsclustermode-activeactivenobgpsecondpipname) | string | Specifies the name of the secondary Public IP to be created for the Virtual Network Gateway in the Active-Active mode. This will only take effect if no existing secondary Public IP is provided. If neither an existing secondary Public IP nor this parameter is specified, a new secondary Public IP will be created with a default name, using the gateway's name with the '-pip2' suffix. | + +### Parameter: `clusterSettings.clusterMode-activeActiveNoBgp.existingSecondPipResourceId` + +The secondary Public IP resource ID to associate to the Virtual Network Gateway in the Active-Active mode. If empty, then a new secondary Public IP will be created as part of this module and applied to the Virtual Network Gateway. + +- Required: No +- Type: string + +### Parameter: `clusterSettings.clusterMode-activeActiveNoBgp.secondPipName` + +Specifies the name of the secondary Public IP to be created for the Virtual Network Gateway in the Active-Active mode. This will only take effect if no existing secondary Public IP is provided. If neither an existing secondary Public IP nor this parameter is specified, a new secondary Public IP will be created with a default name, using the gateway's name with the '-pip2' suffix. + +- Required: No +- Type: string + +### Variant: `clusterSettings.clusterMode-activeActiveBgp` + + +To use this variant, set the property `clusterMode` to `activeActiveBgp`. + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`asn`](#parameter-clustersettingsclustermode-activeactivebgpasn) | int | The Autonomous System Number value. If it's not provided, a default '65515' value will be assigned to the ASN. | +| [`customBgpIpAddresses`](#parameter-clustersettingsclustermode-activeactivebgpcustombgpipaddresses) | array | The list of custom BGP IP Address (APIPA) peering addresses which belong to IP configuration. | +| [`existingSecondPipResourceId`](#parameter-clustersettingsclustermode-activeactivebgpexistingsecondpipresourceid) | string | The secondary Public IP resource ID to associate to the Virtual Network Gateway in the Active-Active mode. If empty, then a new secondary Public IP will be created as part of this module and applied to the Virtual Network Gateway. | +| [`secondCustomBgpIpAddresses`](#parameter-clustersettingsclustermode-activeactivebgpsecondcustombgpipaddresses) | array | The list of the second custom BGP IP Address (APIPA) peering addresses which belong to IP configuration. | +| [`secondPipName`](#parameter-clustersettingsclustermode-activeactivebgpsecondpipname) | string | Specifies the name of the secondary Public IP to be created for the Virtual Network Gateway in the Active-Active mode. This will only take effect if no existing secondary Public IP is provided. If neither an existing secondary Public IP nor this parameter is specified, a new secondary Public IP will be created with a default name, using the gateway's name with the '-pip2' suffix. | + +### Parameter: `clusterSettings.clusterMode-activeActiveBgp.asn` + +The Autonomous System Number value. If it's not provided, a default '65515' value will be assigned to the ASN. + +- Required: No +- Type: int +- MinValue: 0 +- MaxValue: 4294967295 + +### Parameter: `clusterSettings.clusterMode-activeActiveBgp.customBgpIpAddresses` + +The list of custom BGP IP Address (APIPA) peering addresses which belong to IP configuration. + +- Required: No +- Type: array +- MinValue: 0 +- MaxValue: 4294967295 + +### Parameter: `clusterSettings.clusterMode-activeActiveBgp.existingSecondPipResourceId` + +The secondary Public IP resource ID to associate to the Virtual Network Gateway in the Active-Active mode. If empty, then a new secondary Public IP will be created as part of this module and applied to the Virtual Network Gateway. + +- Required: No +- Type: string +- MinValue: 0 +- MaxValue: 4294967295 + +### Parameter: `clusterSettings.clusterMode-activeActiveBgp.secondCustomBgpIpAddresses` + +The list of the second custom BGP IP Address (APIPA) peering addresses which belong to IP configuration. + +- Required: No +- Type: array +- MinValue: 0 +- MaxValue: 4294967295 + +### Parameter: `clusterSettings.clusterMode-activeActiveBgp.secondPipName` + +Specifies the name of the secondary Public IP to be created for the Virtual Network Gateway in the Active-Active mode. This will only take effect if no existing secondary Public IP is provided. If neither an existing secondary Public IP nor this parameter is specified, a new secondary Public IP will be created with a default name, using the gateway's name with the '-pip2' suffix. + +- Required: No +- Type: string +- MinValue: 0 +- MaxValue: 4294967295 + +### Variant: `clusterSettings.clusterMode-activePassiveBgp` + + +To use this variant, set the property `clusterMode` to `activePassiveBgp`. + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`asn`](#parameter-clustersettingsclustermode-activepassivebgpasn) | int | The Autonomous System Number value. If it's not provided, a default '65515' value will be assigned to the ASN. | +| [`customBgpIpAddresses`](#parameter-clustersettingsclustermode-activepassivebgpcustombgpipaddresses) | array | The list of custom BGP IP Address (APIPA) peering addresses which belong to IP configuration. | + +### Parameter: `clusterSettings.clusterMode-activePassiveBgp.asn` + +The Autonomous System Number value. If it's not provided, a default '65515' value will be assigned to the ASN. + +- Required: No +- Type: int +- MinValue: 0 +- MaxValue: 4294967295 + +### Parameter: `clusterSettings.clusterMode-activePassiveBgp.customBgpIpAddresses` + +The list of custom BGP IP Address (APIPA) peering addresses which belong to IP configuration. + +- Required: No +- Type: array +- MinValue: 0 +- MaxValue: 4294967295 + +### Variant: `clusterSettings.clusterMode-activePassiveNoBgp` + + +To use this variant, set the property `clusterMode` to `activePassiveNoBgp`. ### Parameter: `gatewayType` diff --git a/avm/res/virtual-machine-images/image-template/README.md b/avm/res/virtual-machine-images/image-template/README.md index 9ad8c63aa0..85b70ff913 100644 --- a/avm/res/virtual-machine-images/image-template/README.md +++ b/avm/res/virtual-machine-images/image-template/README.md @@ -758,6 +758,244 @@ The distribution targets where the image output needs to go to. - Required: Yes - Type: array +- Type-deciding property: type + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`SharedImage`](#variant-distributionstype-sharedimage) | | +| [`ManagedImage`](#variant-distributionstype-managedimage) | | +| [`VHD`](#variant-distributionstype-vhd) | | + +### Variant: `distributions.type-SharedImage` + + +To use this variant, set the property `type` to `SharedImage`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`type`](#parameter-distributionstype-sharedimagetype) | string | The type of distribution. | + +**Conditional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`sharedImageGalleryImageDefinitionResourceId`](#parameter-distributionstype-sharedimagesharedimagegalleryimagedefinitionresourceid) | string | Resource ID of Compute Gallery Image Definition to distribute image to, e.g.: /subscriptions//resourceGroups//providers/Microsoft.Compute/galleries//images/. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`artifactTags`](#parameter-distributionstype-sharedimageartifacttags) | object | Tags that will be applied to the artifact once it has been created/updated by the distributor. If not provided will set tags based on the provided image source. | +| [`excludeFromLatest`](#parameter-distributionstype-sharedimageexcludefromlatest) | bool | The exclude from latest flag of the image. Defaults to [false]. | +| [`replicationRegions`](#parameter-distributionstype-sharedimagereplicationregions) | array | The replication regions of the image. Defaults to the value of the 'location' parameter. | +| [`runOutputName`](#parameter-distributionstype-sharedimagerunoutputname) | string | The name to be used for the associated RunOutput. If not provided, a name will be calculated. | +| [`sharedImageGalleryImageDefinitionTargetVersion`](#parameter-distributionstype-sharedimagesharedimagegalleryimagedefinitiontargetversion) | string | Version of the Compute Gallery Image. Supports the following Version Syntax: Major.Minor.Build (i.e., '1.1.1' or '10.1.2'). If not provided, a version will be calculated. | +| [`storageAccountType`](#parameter-distributionstype-sharedimagestorageaccounttype) | string | The storage account type of the image. Defaults to [Standard_LRS]. | + +### Parameter: `distributions.type-SharedImage.type` + +The type of distribution. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'SharedImage' + ] + ``` + +### Parameter: `distributions.type-SharedImage.sharedImageGalleryImageDefinitionResourceId` + +Resource ID of Compute Gallery Image Definition to distribute image to, e.g.: /subscriptions//resourceGroups//providers/Microsoft.Compute/galleries//images/. + +- Required: Yes +- Type: string + +### Parameter: `distributions.type-SharedImage.artifactTags` + +Tags that will be applied to the artifact once it has been created/updated by the distributor. If not provided will set tags based on the provided image source. + +- Required: No +- Type: object + +### Parameter: `distributions.type-SharedImage.excludeFromLatest` + +The exclude from latest flag of the image. Defaults to [false]. + +- Required: No +- Type: bool + +### Parameter: `distributions.type-SharedImage.replicationRegions` + +The replication regions of the image. Defaults to the value of the 'location' parameter. + +- Required: No +- Type: array + +### Parameter: `distributions.type-SharedImage.runOutputName` + +The name to be used for the associated RunOutput. If not provided, a name will be calculated. + +- Required: No +- Type: string + +### Parameter: `distributions.type-SharedImage.sharedImageGalleryImageDefinitionTargetVersion` + +Version of the Compute Gallery Image. Supports the following Version Syntax: Major.Minor.Build (i.e., '1.1.1' or '10.1.2'). If not provided, a version will be calculated. + +- Required: No +- Type: string + +### Parameter: `distributions.type-SharedImage.storageAccountType` + +The storage account type of the image. Defaults to [Standard_LRS]. + +- Required: No +- Type: string +- Allowed: + ```Bicep + [ + 'Standard_LRS' + 'Standard_ZRS' + ] + ``` + +### Variant: `distributions.type-ManagedImage` + + +To use this variant, set the property `type` to `ManagedImage`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`imageResourceId`](#parameter-distributionstype-managedimageimageresourceid) | string | The resource ID of the managed image. Defaults to a compute image with name 'imageName-baseTime' in the current resource group. | +| [`type`](#parameter-distributionstype-managedimagetype) | string | The type of distribution. | + +**Conditional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`imageName`](#parameter-distributionstype-managedimageimagename) | string | Name of the managed or unmanaged image that will be created. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`artifactTags`](#parameter-distributionstype-managedimageartifacttags) | object | Tags that will be applied to the artifact once it has been created/updated by the distributor. If not provided will set tags based on the provided image source. | +| [`location`](#parameter-distributionstype-managedimagelocation) | string | Azure location for the image, should match if image already exists. Defaults to the value of the 'location' parameter. | +| [`runOutputName`](#parameter-distributionstype-managedimagerunoutputname) | string | The name to be used for the associated RunOutput. If not provided, a name will be calculated. | + +### Parameter: `distributions.type-ManagedImage.imageResourceId` + +The resource ID of the managed image. Defaults to a compute image with name 'imageName-baseTime' in the current resource group. + +- Required: No +- Type: string + +### Parameter: `distributions.type-ManagedImage.type` + +The type of distribution. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ManagedImage' + ] + ``` + +### Parameter: `distributions.type-ManagedImage.imageName` + +Name of the managed or unmanaged image that will be created. + +- Required: Yes +- Type: string + +### Parameter: `distributions.type-ManagedImage.artifactTags` + +Tags that will be applied to the artifact once it has been created/updated by the distributor. If not provided will set tags based on the provided image source. + +- Required: No +- Type: object + +### Parameter: `distributions.type-ManagedImage.location` + +Azure location for the image, should match if image already exists. Defaults to the value of the 'location' parameter. + +- Required: No +- Type: string + +### Parameter: `distributions.type-ManagedImage.runOutputName` + +The name to be used for the associated RunOutput. If not provided, a name will be calculated. + +- Required: No +- Type: string + +### Variant: `distributions.type-VHD` + + +To use this variant, set the property `type` to `VHD`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`type`](#parameter-distributionstype-vhdtype) | string | The type of distribution. | + +**Conditional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`imageName`](#parameter-distributionstype-vhdimagename) | string | Name of the managed or unmanaged image that will be created. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`artifactTags`](#parameter-distributionstype-vhdartifacttags) | object | Tags that will be applied to the artifact once it has been created/updated by the distributor. If not provided will set tags based on the provided image source. | +| [`runOutputName`](#parameter-distributionstype-vhdrunoutputname) | string | The name to be used for the associated RunOutput. If not provided, a name will be calculated. | + +### Parameter: `distributions.type-VHD.type` + +The type of distribution. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'VHD' + ] + ``` + +### Parameter: `distributions.type-VHD.imageName` + +Name of the managed or unmanaged image that will be created. + +- Required: Yes +- Type: string + +### Parameter: `distributions.type-VHD.artifactTags` + +Tags that will be applied to the artifact once it has been created/updated by the distributor. If not provided will set tags based on the provided image source. + +- Required: No +- Type: object + +### Parameter: `distributions.type-VHD.runOutputName` + +The name to be used for the associated RunOutput. If not provided, a name will be calculated. + +- Required: No +- Type: string ### Parameter: `imageSource` From 18a55275c95dfba7d0f1451d38a5fef09790eb3b Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 20:28:21 +0100 Subject: [PATCH 11/43] Update to latest --- avm/res/insights/data-collection-rule/README.md | 4 ++-- avm/res/insights/data-collection-rule/main.bicep | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/avm/res/insights/data-collection-rule/README.md b/avm/res/insights/data-collection-rule/README.md index cc5e803d19..d2b2d8247d 100644 --- a/avm/res/insights/data-collection-rule/README.md +++ b/avm/res/insights/data-collection-rule/README.md @@ -2821,13 +2821,13 @@ The kind of data collection rule. | Variant | Description | | :-- | :-- | -| [`Linux`](#variant-datacollectionrulepropertieskind-linux) | Type for a Linux DSR collection rule. | +| [`Linux`](#variant-datacollectionrulepropertieskind-linux) | | | [`Windows`](#variant-datacollectionrulepropertieskind-windows) | | | [`All`](#variant-datacollectionrulepropertieskind-all) | | | [`AgentSettings`](#variant-datacollectionrulepropertieskind-agentsettings) | | ### Variant: `dataCollectionRuleProperties.kind-Linux` -Type for a Linux DSR collection rule. + To use this variant, set the property `kind` to `Linux`. diff --git a/avm/res/insights/data-collection-rule/main.bicep b/avm/res/insights/data-collection-rule/main.bicep index 58acc0f631..55797d4a15 100644 --- a/avm/res/insights/data-collection-rule/main.bicep +++ b/avm/res/insights/data-collection-rule/main.bicep @@ -170,7 +170,6 @@ type dataCollectionRulePropertiesType = | allPlatformsDcrPropertiesType | agentSettingsDcrPropertiesType -@description('Type for a Linux DSR collection rule.') type linuxDcrPropertiesType = { @description('Required. The platform type specifies the type of resources this rule can apply to.') kind: 'Linux' From b0afd1743850c9ac14ed23f5f7fafa3dc6138dc2 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 20:40:35 +0100 Subject: [PATCH 12/43] Added support for secureObject --- .../workspace/connection/README.md | 596 ++++++++++++++++++ .../sharedScripts/Set-ModuleReadMe.ps1 | 4 +- 2 files changed, 598 insertions(+), 2 deletions(-) diff --git a/avm/res/machine-learning-services/workspace/connection/README.md b/avm/res/machine-learning-services/workspace/connection/README.md index 9413c475bf..575fc3a61a 100644 --- a/avm/res/machine-learning-services/workspace/connection/README.md +++ b/avm/res/machine-learning-services/workspace/connection/README.md @@ -158,6 +158,602 @@ The properties of the connection, specific to the auth type. - Type: secureObject - Type-deciding property: authType +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`AAD`](#variant-connectionpropertiesauthtype-aad) | | +| [`AccessKey`](#variant-connectionpropertiesauthtype-accesskey) | | +| [`ApiKey`](#variant-connectionpropertiesauthtype-apikey) | | +| [`CustomKeys`](#variant-connectionpropertiesauthtype-customkeys) | | +| [`ManagedIdentity`](#variant-connectionpropertiesauthtype-managedidentity) | | +| [`None`](#variant-connectionpropertiesauthtype-none) | | +| [`OAuth2`](#variant-connectionpropertiesauthtype-oauth2) | | +| [`PAT`](#variant-connectionpropertiesauthtype-pat) | | +| [`SAS`](#variant-connectionpropertiesauthtype-sas) | | +| [`ServicePrincipal`](#variant-connectionpropertiesauthtype-serviceprincipal) | | +| [`UsernamePassword`](#variant-connectionpropertiesauthtype-usernamepassword) | | + +### Variant: `connectionProperties.authType-AAD` + + +To use this variant, set the property `authType` to `AAD`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-aadauthtype) | string | The authentication type of the connection target. | + +### Parameter: `connectionProperties.authType-AAD.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AAD' + ] + ``` + +### Variant: `connectionProperties.authType-AccessKey` + + +To use this variant, set the property `authType` to `AccessKey`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-accesskeyauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionpropertiesauthtype-accesskeycredentials) | object | The credentials for the connection. | + +### Parameter: `connectionProperties.authType-AccessKey.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AccessKey' + ] + ``` + +### Parameter: `connectionProperties.authType-AccessKey.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`accessKeyId`](#parameter-connectionpropertiesauthtype-accesskeycredentialsaccesskeyid) | string | The connection access key ID. | +| [`secretAccessKey`](#parameter-connectionpropertiesauthtype-accesskeycredentialssecretaccesskey) | string | The connection secret access key. | + +### Parameter: `connectionProperties.authType-AccessKey.credentials.accessKeyId` + +The connection access key ID. + +- Required: Yes +- Type: string + +### Parameter: `connectionProperties.authType-AccessKey.credentials.secretAccessKey` + +The connection secret access key. + +- Required: Yes +- Type: string + +### Variant: `connectionProperties.authType-ApiKey` + + +To use this variant, set the property `authType` to `ApiKey`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-apikeyauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionpropertiesauthtype-apikeycredentials) | object | The credentials for the connection. | + +### Parameter: `connectionProperties.authType-ApiKey.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ApiKey' + ] + ``` + +### Parameter: `connectionProperties.authType-ApiKey.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`key`](#parameter-connectionpropertiesauthtype-apikeycredentialskey) | string | The connection API key. | + +### Parameter: `connectionProperties.authType-ApiKey.credentials.key` + +The connection API key. + +- Required: Yes +- Type: string + +### Variant: `connectionProperties.authType-CustomKeys` + + +To use this variant, set the property `authType` to `CustomKeys`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-customkeysauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionpropertiesauthtype-customkeyscredentials) | object | The credentials for the connection. | + +### Parameter: `connectionProperties.authType-CustomKeys.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'CustomKeys' + ] + ``` + +### Parameter: `connectionProperties.authType-CustomKeys.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`keys`](#parameter-connectionpropertiesauthtype-customkeyscredentialskeys) | object | The custom keys for the connection. | + +### Parameter: `connectionProperties.authType-CustomKeys.credentials.keys` + +The custom keys for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`>Any_other_property<`](#parameter-connectionpropertiesauthtype-customkeyscredentialskeys>any_other_property<) | string | Key-value pairs for the custom keys. | + +### Parameter: `connectionProperties.authType-CustomKeys.credentials.keys.>Any_other_property<` + +Key-value pairs for the custom keys. + +- Required: Yes +- Type: string + +### Variant: `connectionProperties.authType-ManagedIdentity` + + +To use this variant, set the property `authType` to `ManagedIdentity`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-managedidentityauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionpropertiesauthtype-managedidentitycredentials) | object | The credentials for the connection. | + +### Parameter: `connectionProperties.authType-ManagedIdentity.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ManagedIdentity' + ] + ``` + +### Parameter: `connectionProperties.authType-ManagedIdentity.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`clientId`](#parameter-connectionpropertiesauthtype-managedidentitycredentialsclientid) | string | The connection managed identity ID. | +| [`resourceId`](#parameter-connectionpropertiesauthtype-managedidentitycredentialsresourceid) | string | The connection managed identity resource ID. | + +### Parameter: `connectionProperties.authType-ManagedIdentity.credentials.clientId` + +The connection managed identity ID. + +- Required: Yes +- Type: string + +### Parameter: `connectionProperties.authType-ManagedIdentity.credentials.resourceId` + +The connection managed identity resource ID. + +- Required: Yes +- Type: string + +### Variant: `connectionProperties.authType-None` + + +To use this variant, set the property `authType` to `None`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-noneauthtype) | string | The authentication type of the connection target. | + +### Parameter: `connectionProperties.authType-None.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'None' + ] + ``` + +### Variant: `connectionProperties.authType-OAuth2` + + +To use this variant, set the property `authType` to `OAuth2`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-oauth2authtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionpropertiesauthtype-oauth2credentials) | object | The credentials for the connection. | + +### Parameter: `connectionProperties.authType-OAuth2.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'OAuth2' + ] + ``` + +### Parameter: `connectionProperties.authType-OAuth2.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`clientId`](#parameter-connectionpropertiesauthtype-oauth2credentialsclientid) | string | The connection client ID in the format of UUID. | +| [`clientSecret`](#parameter-connectionpropertiesauthtype-oauth2credentialsclientsecret) | string | The connection client secret. | +| [`tenantId`](#parameter-connectionpropertiesauthtype-oauth2credentialstenantid) | string | The connection tenant ID. Required by QuickBooks and Xero connection categories. | + +**Conditional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authUrl`](#parameter-connectionpropertiesauthtype-oauth2credentialsauthurl) | string | The connection auth URL. Required by Concur connection category. | +| [`developerToken`](#parameter-connectionpropertiesauthtype-oauth2credentialsdevelopertoken) | string | The connection developer token. Required by GoogleAdWords connection category. | +| [`password`](#parameter-connectionpropertiesauthtype-oauth2credentialspassword) | string | The connection password. Required by Concur and ServiceNow connection categories where AccessToken grant type is 'Password'. | +| [`refreshToken`](#parameter-connectionpropertiesauthtype-oauth2credentialsrefreshtoken) | string | The connection refresh token. Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero and Zoho connection categories. | +| [`username`](#parameter-connectionpropertiesauthtype-oauth2credentialsusername) | string | The connection username. Required by Concur and ServiceNow connection categories where AccessToken grant type is 'Password'. | + +### Parameter: `connectionProperties.authType-OAuth2.credentials.clientId` + +The connection client ID in the format of UUID. + +- Required: Yes +- Type: string + +### Parameter: `connectionProperties.authType-OAuth2.credentials.clientSecret` + +The connection client secret. + +- Required: Yes +- Type: string + +### Parameter: `connectionProperties.authType-OAuth2.credentials.tenantId` + +The connection tenant ID. Required by QuickBooks and Xero connection categories. + +- Required: No +- Type: string + +### Parameter: `connectionProperties.authType-OAuth2.credentials.authUrl` + +The connection auth URL. Required by Concur connection category. + +- Required: No +- Type: string + +### Parameter: `connectionProperties.authType-OAuth2.credentials.developerToken` + +The connection developer token. Required by GoogleAdWords connection category. + +- Required: No +- Type: string + +### Parameter: `connectionProperties.authType-OAuth2.credentials.password` + +The connection password. Required by Concur and ServiceNow connection categories where AccessToken grant type is 'Password'. + +- Required: No +- Type: string + +### Parameter: `connectionProperties.authType-OAuth2.credentials.refreshToken` + +The connection refresh token. Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero and Zoho connection categories. + +- Required: No +- Type: string + +### Parameter: `connectionProperties.authType-OAuth2.credentials.username` + +The connection username. Required by Concur and ServiceNow connection categories where AccessToken grant type is 'Password'. + +- Required: No +- Type: string + +### Variant: `connectionProperties.authType-PAT` + + +To use this variant, set the property `authType` to `PAT`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-patauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionpropertiesauthtype-patcredentials) | object | The credentials for the connection. | + +### Parameter: `connectionProperties.authType-PAT.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'PAT' + ] + ``` + +### Parameter: `connectionProperties.authType-PAT.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`pat`](#parameter-connectionpropertiesauthtype-patcredentialspat) | string | The connection personal access token. | + +### Parameter: `connectionProperties.authType-PAT.credentials.pat` + +The connection personal access token. + +- Required: Yes +- Type: string + +### Variant: `connectionProperties.authType-SAS` + + +To use this variant, set the property `authType` to `SAS`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-sasauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionpropertiesauthtype-sascredentials) | object | The credentials for the connection. | + +### Parameter: `connectionProperties.authType-SAS.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'SAS' + ] + ``` + +### Parameter: `connectionProperties.authType-SAS.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`sas`](#parameter-connectionpropertiesauthtype-sascredentialssas) | string | The connection SAS token. | + +### Parameter: `connectionProperties.authType-SAS.credentials.sas` + +The connection SAS token. + +- Required: Yes +- Type: string + +### Variant: `connectionProperties.authType-ServicePrincipal` + + +To use this variant, set the property `authType` to `ServicePrincipal`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-serviceprincipalauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionpropertiesauthtype-serviceprincipalcredentials) | object | The credentials for the connection. | + +### Parameter: `connectionProperties.authType-ServicePrincipal.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ServicePrincipal' + ] + ``` + +### Parameter: `connectionProperties.authType-ServicePrincipal.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`clientId`](#parameter-connectionpropertiesauthtype-serviceprincipalcredentialsclientid) | string | The connection client ID. | +| [`clientSecret`](#parameter-connectionpropertiesauthtype-serviceprincipalcredentialsclientsecret) | string | The connection client secret. | +| [`tenantId`](#parameter-connectionpropertiesauthtype-serviceprincipalcredentialstenantid) | string | The connection tenant ID. | + +### Parameter: `connectionProperties.authType-ServicePrincipal.credentials.clientId` + +The connection client ID. + +- Required: Yes +- Type: string + +### Parameter: `connectionProperties.authType-ServicePrincipal.credentials.clientSecret` + +The connection client secret. + +- Required: Yes +- Type: string + +### Parameter: `connectionProperties.authType-ServicePrincipal.credentials.tenantId` + +The connection tenant ID. + +- Required: Yes +- Type: string + +### Variant: `connectionProperties.authType-UsernamePassword` + + +To use this variant, set the property `authType` to `UsernamePassword`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-usernamepasswordauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionpropertiesauthtype-usernamepasswordcredentials) | object | The credentials for the connection. | + +### Parameter: `connectionProperties.authType-UsernamePassword.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'UsernamePassword' + ] + ``` + +### Parameter: `connectionProperties.authType-UsernamePassword.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`password`](#parameter-connectionpropertiesauthtype-usernamepasswordcredentialspassword) | string | The connection password. | +| [`username`](#parameter-connectionpropertiesauthtype-usernamepasswordcredentialsusername) | string | The connection username. | + +**Conditional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`securityToken`](#parameter-connectionpropertiesauthtype-usernamepasswordcredentialssecuritytoken) | string | The connection security token. Required by connections like SalesForce for extra security in addition to 'UsernamePassword'. | + +### Parameter: `connectionProperties.authType-UsernamePassword.credentials.password` + +The connection password. + +- Required: Yes +- Type: string + +### Parameter: `connectionProperties.authType-UsernamePassword.credentials.username` + +The connection username. + +- Required: Yes +- Type: string + +### Parameter: `connectionProperties.authType-UsernamePassword.credentials.securityToken` + +The connection security token. Required by connections like SalesForce for extra security in addition to 'UsernamePassword'. + +- Required: No +- Type: string + ### Parameter: `machineLearningWorkspaceName` The name of the parent Machine Learning Workspace. Required if the template is used in a standalone deployment. diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index b1431e6b62..f95b2d2c93 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -533,7 +533,7 @@ function Set-DefinitionSection { $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $formattedProperties -ParentName $paramIdentifier -ColumnsInOrder $ColumnsInOrder $listSectionContent += $sectionContent } - } elseif ($definition.type -eq 'object' -and ($definition.properties.Keys -or $definition.additionalProperties.Keys)) { + } elseif ($definition.type -in @('object', 'secureObject') -and ($definition.properties.Keys -or $definition.additionalProperties.Keys)) { if ($definition.properties.Keys) { $childProperties = $definition.properties $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $childProperties -ParentName $paramIdentifier -ColumnsInOrder $ColumnsInOrder @@ -545,7 +545,7 @@ function Set-DefinitionSection { $sectionContent = Set-DefinitionSection -TemplateFileContent $TemplateFileContent -Properties $formattedProperties -ParentName $paramIdentifier -ColumnsInOrder $ColumnsInOrder $listSectionContent += $sectionContent } - } elseif ($definition.type -eq 'object' -and $definition.keys -contains 'discriminator') { + } elseif ($definition.type -in @('object', 'secureObject') -and $definition.keys -contains 'discriminator') { <# Discriminator type. E.g., From a0029a88da52f6913ae3e99e125eb498645de57a Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 20:45:40 +0100 Subject: [PATCH 13/43] Update to latest --- .../workspace/README.md | 596 ++++++++++++++++++ 1 file changed, 596 insertions(+) diff --git a/avm/res/machine-learning-services/workspace/README.md b/avm/res/machine-learning-services/workspace/README.md index 109f45e010..9d8350017e 100644 --- a/avm/res/machine-learning-services/workspace/README.md +++ b/avm/res/machine-learning-services/workspace/README.md @@ -1673,6 +1673,602 @@ The properties of the connection, specific to the auth type. - Type: secureObject - Type-deciding property: authType +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`AAD`](#variant-connectionsconnectionpropertiesauthtype-aad) | | +| [`AccessKey`](#variant-connectionsconnectionpropertiesauthtype-accesskey) | | +| [`ApiKey`](#variant-connectionsconnectionpropertiesauthtype-apikey) | | +| [`CustomKeys`](#variant-connectionsconnectionpropertiesauthtype-customkeys) | | +| [`ManagedIdentity`](#variant-connectionsconnectionpropertiesauthtype-managedidentity) | | +| [`None`](#variant-connectionsconnectionpropertiesauthtype-none) | | +| [`OAuth2`](#variant-connectionsconnectionpropertiesauthtype-oauth2) | | +| [`PAT`](#variant-connectionsconnectionpropertiesauthtype-pat) | | +| [`SAS`](#variant-connectionsconnectionpropertiesauthtype-sas) | | +| [`ServicePrincipal`](#variant-connectionsconnectionpropertiesauthtype-serviceprincipal) | | +| [`UsernamePassword`](#variant-connectionsconnectionpropertiesauthtype-usernamepassword) | | + +### Variant: `connections.connectionProperties.authType-AAD` + + +To use this variant, set the property `authType` to `AAD`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-aadauthtype) | string | The authentication type of the connection target. | + +### Parameter: `connections.connectionProperties.authType-AAD.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AAD' + ] + ``` + +### Variant: `connections.connectionProperties.authType-AccessKey` + + +To use this variant, set the property `authType` to `AccessKey`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-accesskeyauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionsconnectionpropertiesauthtype-accesskeycredentials) | object | The credentials for the connection. | + +### Parameter: `connections.connectionProperties.authType-AccessKey.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AccessKey' + ] + ``` + +### Parameter: `connections.connectionProperties.authType-AccessKey.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`accessKeyId`](#parameter-connectionsconnectionpropertiesauthtype-accesskeycredentialsaccesskeyid) | string | The connection access key ID. | +| [`secretAccessKey`](#parameter-connectionsconnectionpropertiesauthtype-accesskeycredentialssecretaccesskey) | string | The connection secret access key. | + +### Parameter: `connections.connectionProperties.authType-AccessKey.credentials.accessKeyId` + +The connection access key ID. + +- Required: Yes +- Type: string + +### Parameter: `connections.connectionProperties.authType-AccessKey.credentials.secretAccessKey` + +The connection secret access key. + +- Required: Yes +- Type: string + +### Variant: `connections.connectionProperties.authType-ApiKey` + + +To use this variant, set the property `authType` to `ApiKey`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-apikeyauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionsconnectionpropertiesauthtype-apikeycredentials) | object | The credentials for the connection. | + +### Parameter: `connections.connectionProperties.authType-ApiKey.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ApiKey' + ] + ``` + +### Parameter: `connections.connectionProperties.authType-ApiKey.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`key`](#parameter-connectionsconnectionpropertiesauthtype-apikeycredentialskey) | string | The connection API key. | + +### Parameter: `connections.connectionProperties.authType-ApiKey.credentials.key` + +The connection API key. + +- Required: Yes +- Type: string + +### Variant: `connections.connectionProperties.authType-CustomKeys` + + +To use this variant, set the property `authType` to `CustomKeys`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-customkeysauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionsconnectionpropertiesauthtype-customkeyscredentials) | object | The credentials for the connection. | + +### Parameter: `connections.connectionProperties.authType-CustomKeys.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'CustomKeys' + ] + ``` + +### Parameter: `connections.connectionProperties.authType-CustomKeys.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`keys`](#parameter-connectionsconnectionpropertiesauthtype-customkeyscredentialskeys) | object | The custom keys for the connection. | + +### Parameter: `connections.connectionProperties.authType-CustomKeys.credentials.keys` + +The custom keys for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`>Any_other_property<`](#parameter-connectionsconnectionpropertiesauthtype-customkeyscredentialskeys>any_other_property<) | string | Key-value pairs for the custom keys. | + +### Parameter: `connections.connectionProperties.authType-CustomKeys.credentials.keys.>Any_other_property<` + +Key-value pairs for the custom keys. + +- Required: Yes +- Type: string + +### Variant: `connections.connectionProperties.authType-ManagedIdentity` + + +To use this variant, set the property `authType` to `ManagedIdentity`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-managedidentityauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionsconnectionpropertiesauthtype-managedidentitycredentials) | object | The credentials for the connection. | + +### Parameter: `connections.connectionProperties.authType-ManagedIdentity.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ManagedIdentity' + ] + ``` + +### Parameter: `connections.connectionProperties.authType-ManagedIdentity.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`clientId`](#parameter-connectionsconnectionpropertiesauthtype-managedidentitycredentialsclientid) | string | The connection managed identity ID. | +| [`resourceId`](#parameter-connectionsconnectionpropertiesauthtype-managedidentitycredentialsresourceid) | string | The connection managed identity resource ID. | + +### Parameter: `connections.connectionProperties.authType-ManagedIdentity.credentials.clientId` + +The connection managed identity ID. + +- Required: Yes +- Type: string + +### Parameter: `connections.connectionProperties.authType-ManagedIdentity.credentials.resourceId` + +The connection managed identity resource ID. + +- Required: Yes +- Type: string + +### Variant: `connections.connectionProperties.authType-None` + + +To use this variant, set the property `authType` to `None`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-noneauthtype) | string | The authentication type of the connection target. | + +### Parameter: `connections.connectionProperties.authType-None.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'None' + ] + ``` + +### Variant: `connections.connectionProperties.authType-OAuth2` + + +To use this variant, set the property `authType` to `OAuth2`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-oauth2authtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionsconnectionpropertiesauthtype-oauth2credentials) | object | The credentials for the connection. | + +### Parameter: `connections.connectionProperties.authType-OAuth2.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'OAuth2' + ] + ``` + +### Parameter: `connections.connectionProperties.authType-OAuth2.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`clientId`](#parameter-connectionsconnectionpropertiesauthtype-oauth2credentialsclientid) | string | The connection client ID in the format of UUID. | +| [`clientSecret`](#parameter-connectionsconnectionpropertiesauthtype-oauth2credentialsclientsecret) | string | The connection client secret. | +| [`tenantId`](#parameter-connectionsconnectionpropertiesauthtype-oauth2credentialstenantid) | string | The connection tenant ID. Required by QuickBooks and Xero connection categories. | + +**Conditional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authUrl`](#parameter-connectionsconnectionpropertiesauthtype-oauth2credentialsauthurl) | string | The connection auth URL. Required by Concur connection category. | +| [`developerToken`](#parameter-connectionsconnectionpropertiesauthtype-oauth2credentialsdevelopertoken) | string | The connection developer token. Required by GoogleAdWords connection category. | +| [`password`](#parameter-connectionsconnectionpropertiesauthtype-oauth2credentialspassword) | string | The connection password. Required by Concur and ServiceNow connection categories where AccessToken grant type is 'Password'. | +| [`refreshToken`](#parameter-connectionsconnectionpropertiesauthtype-oauth2credentialsrefreshtoken) | string | The connection refresh token. Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero and Zoho connection categories. | +| [`username`](#parameter-connectionsconnectionpropertiesauthtype-oauth2credentialsusername) | string | The connection username. Required by Concur and ServiceNow connection categories where AccessToken grant type is 'Password'. | + +### Parameter: `connections.connectionProperties.authType-OAuth2.credentials.clientId` + +The connection client ID in the format of UUID. + +- Required: Yes +- Type: string + +### Parameter: `connections.connectionProperties.authType-OAuth2.credentials.clientSecret` + +The connection client secret. + +- Required: Yes +- Type: string + +### Parameter: `connections.connectionProperties.authType-OAuth2.credentials.tenantId` + +The connection tenant ID. Required by QuickBooks and Xero connection categories. + +- Required: No +- Type: string + +### Parameter: `connections.connectionProperties.authType-OAuth2.credentials.authUrl` + +The connection auth URL. Required by Concur connection category. + +- Required: No +- Type: string + +### Parameter: `connections.connectionProperties.authType-OAuth2.credentials.developerToken` + +The connection developer token. Required by GoogleAdWords connection category. + +- Required: No +- Type: string + +### Parameter: `connections.connectionProperties.authType-OAuth2.credentials.password` + +The connection password. Required by Concur and ServiceNow connection categories where AccessToken grant type is 'Password'. + +- Required: No +- Type: string + +### Parameter: `connections.connectionProperties.authType-OAuth2.credentials.refreshToken` + +The connection refresh token. Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero and Zoho connection categories. + +- Required: No +- Type: string + +### Parameter: `connections.connectionProperties.authType-OAuth2.credentials.username` + +The connection username. Required by Concur and ServiceNow connection categories where AccessToken grant type is 'Password'. + +- Required: No +- Type: string + +### Variant: `connections.connectionProperties.authType-PAT` + + +To use this variant, set the property `authType` to `PAT`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-patauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionsconnectionpropertiesauthtype-patcredentials) | object | The credentials for the connection. | + +### Parameter: `connections.connectionProperties.authType-PAT.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'PAT' + ] + ``` + +### Parameter: `connections.connectionProperties.authType-PAT.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`pat`](#parameter-connectionsconnectionpropertiesauthtype-patcredentialspat) | string | The connection personal access token. | + +### Parameter: `connections.connectionProperties.authType-PAT.credentials.pat` + +The connection personal access token. + +- Required: Yes +- Type: string + +### Variant: `connections.connectionProperties.authType-SAS` + + +To use this variant, set the property `authType` to `SAS`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-sasauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionsconnectionpropertiesauthtype-sascredentials) | object | The credentials for the connection. | + +### Parameter: `connections.connectionProperties.authType-SAS.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'SAS' + ] + ``` + +### Parameter: `connections.connectionProperties.authType-SAS.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`sas`](#parameter-connectionsconnectionpropertiesauthtype-sascredentialssas) | string | The connection SAS token. | + +### Parameter: `connections.connectionProperties.authType-SAS.credentials.sas` + +The connection SAS token. + +- Required: Yes +- Type: string + +### Variant: `connections.connectionProperties.authType-ServicePrincipal` + + +To use this variant, set the property `authType` to `ServicePrincipal`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-serviceprincipalauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionsconnectionpropertiesauthtype-serviceprincipalcredentials) | object | The credentials for the connection. | + +### Parameter: `connections.connectionProperties.authType-ServicePrincipal.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ServicePrincipal' + ] + ``` + +### Parameter: `connections.connectionProperties.authType-ServicePrincipal.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`clientId`](#parameter-connectionsconnectionpropertiesauthtype-serviceprincipalcredentialsclientid) | string | The connection client ID. | +| [`clientSecret`](#parameter-connectionsconnectionpropertiesauthtype-serviceprincipalcredentialsclientsecret) | string | The connection client secret. | +| [`tenantId`](#parameter-connectionsconnectionpropertiesauthtype-serviceprincipalcredentialstenantid) | string | The connection tenant ID. | + +### Parameter: `connections.connectionProperties.authType-ServicePrincipal.credentials.clientId` + +The connection client ID. + +- Required: Yes +- Type: string + +### Parameter: `connections.connectionProperties.authType-ServicePrincipal.credentials.clientSecret` + +The connection client secret. + +- Required: Yes +- Type: string + +### Parameter: `connections.connectionProperties.authType-ServicePrincipal.credentials.tenantId` + +The connection tenant ID. + +- Required: Yes +- Type: string + +### Variant: `connections.connectionProperties.authType-UsernamePassword` + + +To use this variant, set the property `authType` to `UsernamePassword`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-usernamepasswordauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionsconnectionpropertiesauthtype-usernamepasswordcredentials) | object | The credentials for the connection. | + +### Parameter: `connections.connectionProperties.authType-UsernamePassword.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'UsernamePassword' + ] + ``` + +### Parameter: `connections.connectionProperties.authType-UsernamePassword.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`password`](#parameter-connectionsconnectionpropertiesauthtype-usernamepasswordcredentialspassword) | string | The connection password. | +| [`username`](#parameter-connectionsconnectionpropertiesauthtype-usernamepasswordcredentialsusername) | string | The connection username. | + +**Conditional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`securityToken`](#parameter-connectionsconnectionpropertiesauthtype-usernamepasswordcredentialssecuritytoken) | string | The connection security token. Required by connections like SalesForce for extra security in addition to 'UsernamePassword'. | + +### Parameter: `connections.connectionProperties.authType-UsernamePassword.credentials.password` + +The connection password. + +- Required: Yes +- Type: string + +### Parameter: `connections.connectionProperties.authType-UsernamePassword.credentials.username` + +The connection username. + +- Required: Yes +- Type: string + +### Parameter: `connections.connectionProperties.authType-UsernamePassword.credentials.securityToken` + +The connection security token. Required by connections like SalesForce for extra security in addition to 'UsernamePassword'. + +- Required: No +- Type: string + ### Parameter: `connections.name` Name of the connection to create. From 2bca0f437a8d67aff2edd04090e8cc59255fa42e Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 20:53:53 +0100 Subject: [PATCH 14/43] Update to latest --- avm/ptn/ai-platform/baseline/README.md | 6 +++--- .../dev-ops/cicd-agents-and-runners/README.md | 20 +++++++++---------- avm/ptn/lz/sub-vending/README.md | 8 ++++---- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/avm/ptn/ai-platform/baseline/README.md b/avm/ptn/ai-platform/baseline/README.md index c24ef2a288..f6685d2db2 100644 --- a/avm/ptn/ai-platform/baseline/README.md +++ b/avm/ptn/ai-platform/baseline/README.md @@ -1614,9 +1614,9 @@ The outbound rule. The name of the rule is the object key. | Variant | Description | | :-- | :-- | -| [`FQDN`](#variant-workspaceconfigurationnetworkoutboundrules>any_other_propertyany_other_propertyany_other_propertyany_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-FQDN` The type for a FQDN outbound rule. diff --git a/avm/ptn/dev-ops/cicd-agents-and-runners/README.md b/avm/ptn/dev-ops/cicd-agents-and-runners/README.md index b304af5240..2e50d71f3a 100644 --- a/avm/ptn/dev-ops/cicd-agents-and-runners/README.md +++ b/avm/ptn/dev-ops/cicd-agents-and-runners/README.md @@ -1334,8 +1334,8 @@ The networking configuration. | Variant | Description | | :-- | :-- | -| [`createNew`](#variant-networkingconfigurationnetworktype-createnew) | | -| [`useExisting`](#variant-networkingconfigurationnetworktype-useexisting) | | +| [`createNew`](#variant-networkingconfigurationnetworktype-createnew) | | +| [`useExisting`](#variant-networkingconfigurationnetworktype-useexisting) | | ### Variant: `networkingConfiguration.networkType-createNew` @@ -1514,14 +1514,14 @@ The compute type networking type. - Required: Yes - Type: object -- Type deciding property: computeNetworkType +- Type-deciding property: computeNetworkType

The available variants are:

| Variant | Description | | :-- | :-- | -| [`azureContainerApp`](#variant-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerapp) | | -| [`azureContainerInstance`](#variant-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerinstance) | | +| [`azureContainerApp`](#variant-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerapp) | | +| [`azureContainerInstance`](#variant-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerinstance) | | ### Variant: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerApp` @@ -1670,21 +1670,21 @@ The self-hosted runner configuration. This can be either GitHub or Azure DevOps. - Required: Yes - Type: object -- Type deciding property: selfHostedType +- Type-deciding property: selfHostedType

The available variants are:

| Variant | Description | | :-- | :-- | -| [`createNew`](#variant-networkingconfigurationnetworktype-createnew) | | -| [`useExisting`](#variant-networkingconfigurationnetworktype-useexisting) | | +| [`createNew`](#variant-networkingconfigurationnetworktype-createnew) | | +| [`useExisting`](#variant-networkingconfigurationnetworktype-useexisting) | |

The available variants are:

| Variant | Description | | :-- | :-- | -| [`github`](#variant-selfhostedconfigselfhostedtype-github) | | -| [`azuredevops`](#variant-selfhostedconfigselfhostedtype-azuredevops) | | +| [`github`](#variant-selfhostedconfigselfhostedtype-github) | | +| [`azuredevops`](#variant-selfhostedconfigselfhostedtype-azuredevops) | | ### Variant: `selfHostedConfig.selfHostedType-github` diff --git a/avm/ptn/lz/sub-vending/README.md b/avm/ptn/lz/sub-vending/README.md index 033ebb399b..9393125da9 100644 --- a/avm/ptn/lz/sub-vending/README.md +++ b/avm/ptn/lz/sub-vending/README.md @@ -1102,10 +1102,10 @@ The type of template for the role assignment condition. | Variant | Description | | :-- | :-- | -| [`excludeRoles`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-excluderoles) | | -| [`constrainRoles`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainroles) | | -| [`constrainRolesAndPrincipalTypes`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipaltypes) | | -| [`constrainRolesAndPrincipals`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipals) | | +| [`excludeRoles`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-excluderoles) | | +| [`constrainRoles`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainroles) | | +| [`constrainRolesAndPrincipalTypes`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipaltypes) | | +| [`constrainRolesAndPrincipals`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipals) | | ### Variant: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-excludeRoles` From 7258adb836e4b1dd77ad6887f40aacf57b2f8847 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 20:54:12 +0100 Subject: [PATCH 15/43] Update to latest --- utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index f95b2d2c93..212883b889 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -578,7 +578,7 @@ function Set-DefinitionSection { '' ) - $variantTableSectionContent += ('| [`{0}`]({1}) | {2} | ' -f $typeVariantName, $variantIdentifierLink, $variantDescription) + $variantTableSectionContent += ('| [`{0}`]({1}) | {2} |' -f $typeVariantName, $variantIdentifierLink, $variantDescription) $definitionSectionInputObject = @{ TemplateFileContent = $TemplateFileContent From 4be63d2ba1504d4184da8f69f8df12a366a54517 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 20:58:14 +0100 Subject: [PATCH 16/43] Update to latest --- avm/ptn/ai-platform/baseline/README.md | 6 ++-- .../dev-ops/cicd-agents-and-runners/README.md | 16 +++++------ avm/ptn/lz/sub-vending/README.md | 8 +++--- .../workspace/README.md | 28 +++++++++---------- .../workspace/connection/README.md | 22 +++++++-------- 5 files changed, 40 insertions(+), 40 deletions(-) diff --git a/avm/ptn/ai-platform/baseline/README.md b/avm/ptn/ai-platform/baseline/README.md index f6685d2db2..c24ef2a288 100644 --- a/avm/ptn/ai-platform/baseline/README.md +++ b/avm/ptn/ai-platform/baseline/README.md @@ -1614,9 +1614,9 @@ The outbound rule. The name of the rule is the object key. | Variant | Description | | :-- | :-- | -| [`FQDN`](#variant-workspaceconfigurationnetworkoutboundrules>any_other_propertyany_other_propertyany_other_propertyany_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-FQDN` The type for a FQDN outbound rule. diff --git a/avm/ptn/dev-ops/cicd-agents-and-runners/README.md b/avm/ptn/dev-ops/cicd-agents-and-runners/README.md index 2e50d71f3a..e471c4b36e 100644 --- a/avm/ptn/dev-ops/cicd-agents-and-runners/README.md +++ b/avm/ptn/dev-ops/cicd-agents-and-runners/README.md @@ -1334,8 +1334,8 @@ The networking configuration. | Variant | Description | | :-- | :-- | -| [`createNew`](#variant-networkingconfigurationnetworktype-createnew) | | -| [`useExisting`](#variant-networkingconfigurationnetworktype-useexisting) | | +| [`createNew`](#variant-networkingconfigurationnetworktype-createnew) | | +| [`useExisting`](#variant-networkingconfigurationnetworktype-useexisting) | | ### Variant: `networkingConfiguration.networkType-createNew` @@ -1520,8 +1520,8 @@ The compute type networking type. | Variant | Description | | :-- | :-- | -| [`azureContainerApp`](#variant-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerapp) | | -| [`azureContainerInstance`](#variant-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerinstance) | | +| [`azureContainerApp`](#variant-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerapp) | | +| [`azureContainerInstance`](#variant-networkingconfigurationnetworktype-useexistingcomputenetworkingcomputenetworktype-azurecontainerinstance) | | ### Variant: `networkingConfiguration.networkType-useExisting.computeNetworking.computeNetworkType-azureContainerApp` @@ -1676,15 +1676,15 @@ The self-hosted runner configuration. This can be either GitHub or Azure DevOps. | Variant | Description | | :-- | :-- | -| [`createNew`](#variant-networkingconfigurationnetworktype-createnew) | | -| [`useExisting`](#variant-networkingconfigurationnetworktype-useexisting) | | +| [`createNew`](#variant-networkingconfigurationnetworktype-createnew) | | +| [`useExisting`](#variant-networkingconfigurationnetworktype-useexisting) | |

The available variants are:

| Variant | Description | | :-- | :-- | -| [`github`](#variant-selfhostedconfigselfhostedtype-github) | | -| [`azuredevops`](#variant-selfhostedconfigselfhostedtype-azuredevops) | | +| [`github`](#variant-selfhostedconfigselfhostedtype-github) | | +| [`azuredevops`](#variant-selfhostedconfigselfhostedtype-azuredevops) | | ### Variant: `selfHostedConfig.selfHostedType-github` diff --git a/avm/ptn/lz/sub-vending/README.md b/avm/ptn/lz/sub-vending/README.md index 9393125da9..033ebb399b 100644 --- a/avm/ptn/lz/sub-vending/README.md +++ b/avm/ptn/lz/sub-vending/README.md @@ -1102,10 +1102,10 @@ The type of template for the role assignment condition. | Variant | Description | | :-- | :-- | -| [`excludeRoles`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-excluderoles) | | -| [`constrainRoles`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainroles) | | -| [`constrainRolesAndPrincipalTypes`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipaltypes) | | -| [`constrainRolesAndPrincipals`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipals) | | +| [`excludeRoles`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-excluderoles) | | +| [`constrainRoles`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainroles) | | +| [`constrainRolesAndPrincipalTypes`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipaltypes) | | +| [`constrainRolesAndPrincipals`](#variant-roleassignmentsroleassignmentconditionroleconditiontypetemplatename-constrainrolesandprincipals) | | ### Variant: `roleAssignments.roleAssignmentCondition.roleConditionType.templateName-excludeRoles` diff --git a/avm/res/machine-learning-services/workspace/README.md b/avm/res/machine-learning-services/workspace/README.md index 9d8350017e..acd66bc7ff 100644 --- a/avm/res/machine-learning-services/workspace/README.md +++ b/avm/res/machine-learning-services/workspace/README.md @@ -1677,17 +1677,17 @@ The properties of the connection, specific to the auth type. | Variant | Description | | :-- | :-- | -| [`AAD`](#variant-connectionsconnectionpropertiesauthtype-aad) | | -| [`AccessKey`](#variant-connectionsconnectionpropertiesauthtype-accesskey) | | -| [`ApiKey`](#variant-connectionsconnectionpropertiesauthtype-apikey) | | -| [`CustomKeys`](#variant-connectionsconnectionpropertiesauthtype-customkeys) | | -| [`ManagedIdentity`](#variant-connectionsconnectionpropertiesauthtype-managedidentity) | | -| [`None`](#variant-connectionsconnectionpropertiesauthtype-none) | | -| [`OAuth2`](#variant-connectionsconnectionpropertiesauthtype-oauth2) | | -| [`PAT`](#variant-connectionsconnectionpropertiesauthtype-pat) | | -| [`SAS`](#variant-connectionsconnectionpropertiesauthtype-sas) | | -| [`ServicePrincipal`](#variant-connectionsconnectionpropertiesauthtype-serviceprincipal) | | -| [`UsernamePassword`](#variant-connectionsconnectionpropertiesauthtype-usernamepassword) | | +| [`AAD`](#variant-connectionsconnectionpropertiesauthtype-aad) | | +| [`AccessKey`](#variant-connectionsconnectionpropertiesauthtype-accesskey) | | +| [`ApiKey`](#variant-connectionsconnectionpropertiesauthtype-apikey) | | +| [`CustomKeys`](#variant-connectionsconnectionpropertiesauthtype-customkeys) | | +| [`ManagedIdentity`](#variant-connectionsconnectionpropertiesauthtype-managedidentity) | | +| [`None`](#variant-connectionsconnectionpropertiesauthtype-none) | | +| [`OAuth2`](#variant-connectionsconnectionpropertiesauthtype-oauth2) | | +| [`PAT`](#variant-connectionsconnectionpropertiesauthtype-pat) | | +| [`SAS`](#variant-connectionsconnectionpropertiesauthtype-sas) | | +| [`ServicePrincipal`](#variant-connectionsconnectionpropertiesauthtype-serviceprincipal) | | +| [`UsernamePassword`](#variant-connectionsconnectionpropertiesauthtype-usernamepassword) | | ### Variant: `connections.connectionProperties.authType-AAD` @@ -2717,9 +2717,9 @@ The outbound rule. The name of the rule is the object key. | Variant | Description | | :-- | :-- | -| [`FQDN`](#variant-managednetworksettingsoutboundrules>any_other_propertyany_other_propertyany_other_propertyany_other_propertyany_other_propertyany_other_propertyAny_other_property<.type-FQDN` diff --git a/avm/res/machine-learning-services/workspace/connection/README.md b/avm/res/machine-learning-services/workspace/connection/README.md index 575fc3a61a..909751589c 100644 --- a/avm/res/machine-learning-services/workspace/connection/README.md +++ b/avm/res/machine-learning-services/workspace/connection/README.md @@ -162,17 +162,17 @@ The properties of the connection, specific to the auth type. | Variant | Description | | :-- | :-- | -| [`AAD`](#variant-connectionpropertiesauthtype-aad) | | -| [`AccessKey`](#variant-connectionpropertiesauthtype-accesskey) | | -| [`ApiKey`](#variant-connectionpropertiesauthtype-apikey) | | -| [`CustomKeys`](#variant-connectionpropertiesauthtype-customkeys) | | -| [`ManagedIdentity`](#variant-connectionpropertiesauthtype-managedidentity) | | -| [`None`](#variant-connectionpropertiesauthtype-none) | | -| [`OAuth2`](#variant-connectionpropertiesauthtype-oauth2) | | -| [`PAT`](#variant-connectionpropertiesauthtype-pat) | | -| [`SAS`](#variant-connectionpropertiesauthtype-sas) | | -| [`ServicePrincipal`](#variant-connectionpropertiesauthtype-serviceprincipal) | | -| [`UsernamePassword`](#variant-connectionpropertiesauthtype-usernamepassword) | | +| [`AAD`](#variant-connectionpropertiesauthtype-aad) | | +| [`AccessKey`](#variant-connectionpropertiesauthtype-accesskey) | | +| [`ApiKey`](#variant-connectionpropertiesauthtype-apikey) | | +| [`CustomKeys`](#variant-connectionpropertiesauthtype-customkeys) | | +| [`ManagedIdentity`](#variant-connectionpropertiesauthtype-managedidentity) | | +| [`None`](#variant-connectionpropertiesauthtype-none) | | +| [`OAuth2`](#variant-connectionpropertiesauthtype-oauth2) | | +| [`PAT`](#variant-connectionpropertiesauthtype-pat) | | +| [`SAS`](#variant-connectionpropertiesauthtype-sas) | | +| [`ServicePrincipal`](#variant-connectionpropertiesauthtype-serviceprincipal) | | +| [`UsernamePassword`](#variant-connectionpropertiesauthtype-usernamepassword) | | ### Variant: `connectionProperties.authType-AAD` From d0c43540efae938a0f2f5c18cc566c806ec6a391 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Sun, 12 Jan 2025 21:11:05 +0100 Subject: [PATCH 17/43] Update to latest --- avm/res/dev-ops-infrastructure/pool/README.md | 12 ++++++------ avm/res/insights/data-collection-rule/README.md | 8 ++++---- avm/res/insights/metric-alert/README.md | 6 +++--- avm/res/network/virtual-network-gateway/README.md | 8 ++++---- .../virtual-machine-images/image-template/README.md | 6 +++--- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/avm/res/dev-ops-infrastructure/pool/README.md b/avm/res/dev-ops-infrastructure/pool/README.md index bbc4af4dad..d9810aebf5 100644 --- a/avm/res/dev-ops-infrastructure/pool/README.md +++ b/avm/res/dev-ops-infrastructure/pool/README.md @@ -728,8 +728,8 @@ Defines how the machine will be handled once it executed a job. | Variant | Description | | :-- | :-- | -| [`Stateful`](#variant-agentprofilekind-stateful) | | -| [`Stateless`](#variant-agentprofilekind-stateless) | | +| [`Stateful`](#variant-agentprofilekind-stateful) | | +| [`Stateless`](#variant-agentprofilekind-stateless) | | ### Variant: `agentProfile.kind-Stateful` @@ -1143,8 +1143,8 @@ Determines how the stand-by scheme should be provided. | Variant | Description | | :-- | :-- | -| [`Automatic`](#variant-agentprofilekind-statefulresourcepredictionsprofilekind-automatic) | | -| [`Manual`](#variant-agentprofilekind-statefulresourcepredictionsprofilekind-manual) | | +| [`Automatic`](#variant-agentprofilekind-statefulresourcepredictionsprofilekind-automatic) | | +| [`Manual`](#variant-agentprofilekind-statefulresourcepredictionsprofilekind-manual) | | ### Variant: `agentProfile.kind-Stateful.resourcePredictionsProfile.kind-Automatic` @@ -1608,8 +1608,8 @@ Determines how the stand-by scheme should be provided. | Variant | Description | | :-- | :-- | -| [`Automatic`](#variant-agentprofilekind-statelessresourcepredictionsprofilekind-automatic) | | -| [`Manual`](#variant-agentprofilekind-statelessresourcepredictionsprofilekind-manual) | | +| [`Automatic`](#variant-agentprofilekind-statelessresourcepredictionsprofilekind-automatic) | | +| [`Manual`](#variant-agentprofilekind-statelessresourcepredictionsprofilekind-manual) | | ### Variant: `agentProfile.kind-Stateless.resourcePredictionsProfile.kind-Automatic` diff --git a/avm/res/insights/data-collection-rule/README.md b/avm/res/insights/data-collection-rule/README.md index d2b2d8247d..63f0fb0e74 100644 --- a/avm/res/insights/data-collection-rule/README.md +++ b/avm/res/insights/data-collection-rule/README.md @@ -2821,10 +2821,10 @@ The kind of data collection rule. | Variant | Description | | :-- | :-- | -| [`Linux`](#variant-datacollectionrulepropertieskind-linux) | | -| [`Windows`](#variant-datacollectionrulepropertieskind-windows) | | -| [`All`](#variant-datacollectionrulepropertieskind-all) | | -| [`AgentSettings`](#variant-datacollectionrulepropertieskind-agentsettings) | | +| [`Linux`](#variant-datacollectionrulepropertieskind-linux) | | +| [`Windows`](#variant-datacollectionrulepropertieskind-windows) | | +| [`All`](#variant-datacollectionrulepropertieskind-all) | | +| [`AgentSettings`](#variant-datacollectionrulepropertieskind-agentsettings) | | ### Variant: `dataCollectionRuleProperties.kind-Linux` diff --git a/avm/res/insights/metric-alert/README.md b/avm/res/insights/metric-alert/README.md index a8d571b3eb..329901dcb7 100644 --- a/avm/res/insights/metric-alert/README.md +++ b/avm/res/insights/metric-alert/README.md @@ -539,9 +539,9 @@ Maps to the 'odata.type' field. Specifies the type of the alert criteria. | Variant | Description | | :-- | :-- | -| [`Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria`](#variant-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteria) | | -| [`Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria`](#variant-criteriaodatatype-microsoftazuremonitorsingleresourcemultiplemetriccriteria) | | -| [`Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria`](#variant-criteriaodatatype-microsoftazuremonitormultipleresourcemultiplemetriccriteria) | | +| [`Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria`](#variant-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteria) | | +| [`Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria`](#variant-criteriaodatatype-microsoftazuremonitorsingleresourcemultiplemetriccriteria) | | +| [`Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria`](#variant-criteriaodatatype-microsoftazuremonitormultipleresourcemultiplemetriccriteria) | | ### Variant: `criteria.odata.type-Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria` diff --git a/avm/res/network/virtual-network-gateway/README.md b/avm/res/network/virtual-network-gateway/README.md index 1a418bb3ff..31840c9807 100644 --- a/avm/res/network/virtual-network-gateway/README.md +++ b/avm/res/network/virtual-network-gateway/README.md @@ -2492,10 +2492,10 @@ Specifies one of the following four configurations: Active-Active with (clusterM | Variant | Description | | :-- | :-- | -| [`activeActiveNoBgp`](#variant-clustersettingsclustermode-activeactivenobgp) | | -| [`activeActiveBgp`](#variant-clustersettingsclustermode-activeactivebgp) | | -| [`activePassiveBgp`](#variant-clustersettingsclustermode-activepassivebgp) | | -| [`activePassiveNoBgp`](#variant-clustersettingsclustermode-activepassivenobgp) | | +| [`activeActiveNoBgp`](#variant-clustersettingsclustermode-activeactivenobgp) | | +| [`activeActiveBgp`](#variant-clustersettingsclustermode-activeactivebgp) | | +| [`activePassiveBgp`](#variant-clustersettingsclustermode-activepassivebgp) | | +| [`activePassiveNoBgp`](#variant-clustersettingsclustermode-activepassivenobgp) | | ### Variant: `clusterSettings.clusterMode-activeActiveNoBgp` diff --git a/avm/res/virtual-machine-images/image-template/README.md b/avm/res/virtual-machine-images/image-template/README.md index 85b70ff913..bd70658eba 100644 --- a/avm/res/virtual-machine-images/image-template/README.md +++ b/avm/res/virtual-machine-images/image-template/README.md @@ -764,9 +764,9 @@ The distribution targets where the image output needs to go to. | Variant | Description | | :-- | :-- | -| [`SharedImage`](#variant-distributionstype-sharedimage) | | -| [`ManagedImage`](#variant-distributionstype-managedimage) | | -| [`VHD`](#variant-distributionstype-vhd) | | +| [`SharedImage`](#variant-distributionstype-sharedimage) | | +| [`ManagedImage`](#variant-distributionstype-managedimage) | | +| [`VHD`](#variant-distributionstype-vhd) | | ### Variant: `distributions.type-SharedImage` From 6613708ef6608b4541dd850e0cbec691d4f4e6e5 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 09:24:42 +0100 Subject: [PATCH 18/43] Small update to readme functino --- ...ain.bicep-20250113-091614-TestResults.json | 458 ++++++++++++++++++ ...main.bicep-20250113-091939-TestResults.xml | 458 ++++++++++++++++++ output.md | 178 +++++++ .../sharedScripts/Set-ModuleReadMe.ps1 | 2 + 4 files changed, 1096 insertions(+) create mode 100644 avm-res-network-virtual-network-gateway-main.bicep-20250113-091614-TestResults.json create mode 100644 avm-res-network-virtual-network-gateway-main.bicep-20250113-091939-TestResults.xml create mode 100644 output.md diff --git a/avm-res-network-virtual-network-gateway-main.bicep-20250113-091614-TestResults.json b/avm-res-network-virtual-network-gateway-main.bicep-20250113-091614-TestResults.json new file mode 100644 index 0000000000..62012eabe4 --- /dev/null +++ b/avm-res-network-virtual-network-gateway-main.bicep-20250113-091614-TestResults.json @@ -0,0 +1,458 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + RuntimeException: You cannot call a method on a null-valued expression. + at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:300 +at Set-DefinitionSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:300 +at Set-DefinitionSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:589 +at Set-ParametersSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:188 +at Set-ModuleReadMe, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:2177 +at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:387 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Expected $null or empty, because only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [skuName]., but got 'skuName'. + at $incorrectParameters | Should -BeNullOrEmpty -Because ('only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [{0}].' -f ($incorrectParameters -join ', ')), C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:705 +at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:705 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/avm-res-network-virtual-network-gateway-main.bicep-20250113-091939-TestResults.xml b/avm-res-network-virtual-network-gateway-main.bicep-20250113-091939-TestResults.xml new file mode 100644 index 0000000000..dabc66c098 --- /dev/null +++ b/avm-res-network-virtual-network-gateway-main.bicep-20250113-091939-TestResults.xml @@ -0,0 +1,458 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + RuntimeException: You cannot call a method on a null-valued expression. + at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:300 +at Set-DefinitionSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:300 +at Set-DefinitionSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:589 +at Set-ParametersSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:188 +at Set-ModuleReadMe, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:2177 +at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:387 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Expected $null or empty, because only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [skuName]., but got 'skuName'. + at $incorrectParameters | Should -BeNullOrEmpty -Because ('only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [{0}].' -f ($incorrectParameters -join ', ')), C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:705 +at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:705 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/output.md b/output.md new file mode 100644 index 0000000000..e3a2829818 --- /dev/null +++ b/output.md @@ -0,0 +1,178 @@ +# Pester validation summary + +| Total No. of Processed Tests| Passed Tests :white_check_mark: | Failed Tests :x: | Skipped Tests :paperclip: | Tests with warnings :warning: | +| :-- | :-- | :-- | :-- | :-- | +| 137 | 129 | 2 | 6 | 0 | + + +
+List of failed Tests + +| Name | Error | Source | +| :-- | :-- | :-- | +| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] All non-required parameters & UDTs in template file should not have description that start with "Required.".** | Expected $null or empty, because only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [skuName]., but got 'skuName'. | [module.tests.ps1:705](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L705) | +| Module tests / Readme content tests / **[network/virtual-network-gateway] Set-ModuleReadMe script should not apply any updates.** | Expected $null or empty, because only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [skuName]., but got 'skuName'. | [module.tests.ps1:](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L) | + +
+ + +
+List of passed Tests + +| Name | Source | +| :-- | :-- | +| Test file tests / General test file / **[network/virtual-network-gateway] [defaults] Bicep test deployment files in a [defaults] folder should have a parameter [serviceShort] with a value ending with [min]** | [module.tests.ps1:1312](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1312) | +| Test file tests / General test file / **[network/virtual-network-gateway] [max] Bicep test deployment files in a [max] folder should have a [serviceShort] parameter with a value ending with [max]** | [module.tests.ps1:1325](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1325) | +| Test file tests / General test file / **[network/virtual-network-gateway] [waf-aligned] Bicep test deployment files in a [waf-aligned] folder should have a [serviceShort] parameter with a value ending with [waf]** | [module.tests.ps1:1338](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1338) | +| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] All required parameters & UDTs in template file should have description that start with "(Required\|Conditional).".** | [module.tests.ps1:708](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L708) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activeActiveBGP]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activeActiveExistingPip]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activeActiveNoBGP]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activePassiveBGP]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activePassiveExistingPip]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activePassiveNoBGP]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [defaults]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [expressRoute]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [max]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [vpn-no-az]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [vpn]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [waf-aligned]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activeActiveBGP]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activeActiveExistingPip]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activeActiveNoBGP]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activePassiveBGP]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activePassiveExistingPip]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activePassiveNoBGP]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [defaults]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [expressRoute]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [max]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [vpn-no-az]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [vpn]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [waf-aligned]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activeActiveBGP]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activeActiveExistingPip]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activeActiveNoBGP]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activePassiveBGP]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activePassiveExistingPip]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activePassiveNoBGP]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [defaults]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [expressRoute]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [max]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [vpn-no-az]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [vpn]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [waf-aligned]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activeActiveBGP]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activeActiveExistingPip]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activeActiveNoBGP]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activePassiveBGP]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activePassiveExistingPip]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activePassiveNoBGP]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [defaults]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [expressRoute]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [max]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [vpn-no-az]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [vpn]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [waf-aligned]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activeActiveBGP]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activeActiveExistingPip]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activeActiveNoBGP]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activePassiveBGP]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activePassiveExistingPip]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activePassiveNoBGP]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [defaults]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [expressRoute]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [max]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [vpn-no-az]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [vpn]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [waf-aligned]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activeActiveBGP]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activeActiveExistingPip]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activeActiveNoBGP]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activePassiveBGP]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activePassiveExistingPip]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activePassiveNoBGP]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [defaults]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [expressRoute]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [max]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [vpn-no-az]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [vpn]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [waf-aligned]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | +| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] Conditional parameters' & UDT's description should contain 'Required if' followed by the condition making the parameter required.** | [module.tests.ps1:659](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L659) | +| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] Each parameters' & UDT's 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.** | [module.tests.ps1:635](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L635) | +| Pipeline tests / **[network/virtual-network-gateway] GitHub workflow [avm.res.network.virtual-network-gateway.yml] should have [workflowPath] environment variable with value [.github/workflows/avm.res.network.virtual-network-gateway.yml].** | [module.tests.ps1:311](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L311) | +| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If a parameter [tags] exists it should be nullable.** | [module.tests.ps1:832](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L832) | +| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [diagnosticSettings], it should implement AVM's corresponding user-defined type.** | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | +| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [lock], it should implement AVM's corresponding user-defined type.** | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | +| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [roleAssignments], it should implement AVM's corresponding user-defined type.** | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | +| Module tests / Template tests / Output / **[network/virtual-network-gateway] Location output should be returned for resources that use it.** | [module.tests.ps1:1045](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1045) | +| Governance tests / **[network/virtual-network-gateway] Module identifier should be listed in issue template in the correct alphabetical position.** | [module.tests.ps1:1225](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1225) | +| File/folder tests / General module folder tests / **[network/virtual-network-gateway] Module should contain a [ main.bicep ] file.** | [module.tests.ps1:77](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L77) | +| File/folder tests / General module folder tests / **[network/virtual-network-gateway] Module should contain a [ main.json ] file.** | [module.tests.ps1:85](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L85) | +| File/folder tests / General module folder tests / **[network/virtual-network-gateway] Module should contain a [ ORPHANED.md ] file only if orphaned.** | [module.tests.ps1:135](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L135) | +| File/folder tests / General module folder tests / **[network/virtual-network-gateway] Module should contain a [ README.md ] file.** | [module.tests.ps1:93](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L93) | +| Pipeline tests / **[network/virtual-network-gateway] Module should have a GitHub workflow in path [.github/workflows/avm.res.network.virtual-network-gateway.yml].** | [module.tests.ps1:302](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L302) | +| Module tests / Template tests / Output / **[network/virtual-network-gateway] Output names description should start with a capital letter and contain text ending with a dot.** | [module.tests.ps1:1022](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1022) | +| Module tests / Template tests / Output / **[network/virtual-network-gateway] Output names should be camel-cased (no dashes or underscores and must start with lower-case letter).** | [module.tests.ps1:1004](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1004) | +| Governance tests / **[network/virtual-network-gateway] Owning team should be specified correctly in CODEWONERS file.** | [module.tests.ps1:1203](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1203) | +| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] Parameter & UDT names should be camel-cased (no dashes or underscores and must start with lower-case letter).** | [module.tests.ps1:603](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L603) | +| Module tests / Template tests / Output / **[network/virtual-network-gateway] Resource Group output should exist for resources that are deployed into a resource group scope.** | [module.tests.ps1:1067](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1067) | +| Module tests / Template tests / Output / **[network/virtual-network-gateway] Resource modules should have a name output.** | [module.tests.ps1:1087](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1087) | +| Module tests / Template tests / Output / **[network/virtual-network-gateway] Resource modules should have a Resource ID output.** | [module.tests.ps1:1120](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1120) | +| Module tests / Template tests / Resources / **[network/virtual-network-gateway] Telemetry deployment should be present in the template.** | [module.tests.ps1:875](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L875) | +| Module tests / Template tests / Resources / **[network/virtual-network-gateway] Telemetry deployment should have correct condition in the template.** | [module.tests.ps1:892](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L892) | +| Module tests / Template tests / Resources / **[network/virtual-network-gateway] Telemetry deployment should have expected inner output for verbosity.** | [module.tests.ps1:915](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L915) | +| Module tests / Template tests / Resources / **[network/virtual-network-gateway] Telemetry deployment should have expected telemetry identifier.** | [module.tests.ps1:939](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L939) | +| Module tests / Template tests / General / **[network/virtual-network-gateway] template file should have a module description specified.** | [module.tests.ps1:556](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L556) | +| Module tests / Template tests / General / **[network/virtual-network-gateway] template file should have a module name specified.** | [module.tests.ps1:547](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L547) | +| Module tests / Template tests / General / **[network/virtual-network-gateway] template file should have a module owner specified.** | [module.tests.ps1:565](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L565) | +| Module tests / Template tests / General / **[network/virtual-network-gateway] Template schema should use HTTPS reference.** | [module.tests.ps1:528](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L528) | +| Module tests / Template tests / General / **[network/virtual-network-gateway] Template schema version should be the latest.** | [module.tests.ps1:504](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L504) | +| Module tests / Compiled ARM template tests / **[network/virtual-network-gateway] The [main.json] ARM template should be based on the current [main.bicep] Bicep template.** | [module.tests.ps1:434](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L434) | +| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] The Location should be defined as a parameter, with the default value of "[resourceGroup().Location]" or "global" for ResourceGroup deployment scope.** | [module.tests.ps1:577](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L577) | +| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] The telemetry parameter should be present & have the expected type, default value & metadata description.** | [module.tests.ps1:591](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L591) | +| Module tests / Template tests / General / **[network/virtual-network-gateway] The template file should contain required elements [schema], [contentVersion], [resources].** | [module.tests.ps1:537](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L537) | +| Module tests / Template tests / General / **[network/virtual-network-gateway] The template file should not be empty.** | [module.tests.ps1:496](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L496) | +| Module tests / Template tests / Variables / **[network/virtual-network-gateway] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter).** | [module.tests.ps1:848](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L848) | +| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain a [ tests ] folder.** | [module.tests.ps1:213](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L213) | +| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain a [ tests/e2e ] folder.** | [module.tests.ps1:223](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L223) | +| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain a [ tests/e2e/*defaults ] folder.** | [module.tests.ps1:243](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L243) | +| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain a [ tests/e2e/*waf-aligned ] folder.** | [module.tests.ps1:233](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L233) | +| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain a [ version.json ] file.** | [module.tests.ps1:203](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L203) | +| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain one [ main.test.bicep ] file in each e2e test folder.** | [module.tests.ps1:259](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L259) | +| API version tests / **In [res/network/virtual-network-gateway] used resource type [locks] should use one of the recent API version(s). Currently using [2020-05-01].** | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | +| API version tests / **In [res/network/virtual-network-gateway] used resource type [publicIPAddresses] should use one of the recent API version(s). Currently using [2023-09-01].** | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | +| API version tests / **In [res/network/virtual-network-gateway] used resource type [roleAssignments] should use one of the recent API version(s). Currently using [2022-04-01].** | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | +| API version tests / **In [res/network/virtual-network-gateway] used resource type [virtualNetworkGateways] should use one of the recent API version(s). Currently using [2023-04-01].** | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | +| API version tests / **In [res/network/virtual-network-gateway] used resource type [virtualNetworkGateways/natRules] should use one of the recent API version(s). Currently using [2023-04-01].** | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | + +
+ + +
+List of skipped Tests + +| Name | Reason | Source | +| :-- | :-- | :-- | +| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If a UDT definition [managedIdentitiesType] exists and supports system-assigned-identities, the template should have an output for its principal ID.** | Test is skipped, because the module template has no [managedIdentitiesType] UDT definition or does not support system-assigned-identities. | [module.tests.ps1:819](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L819) | +| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [customerManagedKey], it should implement AVM's corresponding user-defined type.** | Test is skipped, because the module template has no [customerManagedKey] parameter. | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | +| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [managedIdentities], it should implement AVM's corresponding user-defined type.** | Test is skipped, because the module template has no [managedIdentities] parameter. | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | +| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [privateEndpoints], it should implement AVM's corresponding user-defined type.** | Test is skipped, because the module template has no [privateEndpoints] parameter. | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | +| Module tests / Template tests / Output / **[network/virtual-network-gateway] Resource modules Principal ID output should exist, if supported.** | Test is skipped, because the module template seems not to support an identity object. | [module.tests.ps1:1154](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1154) | +| API version tests / **In [res/network/virtual-network-gateway] used resource type [diagnosticSettings] should use one of the recent API version(s). Currently using [2021-05-01-preview].** | Test is skipped, because The Azure API version file is missing the Resource Type [diagnosticSettings] for Provider Namespace [Microsoft.Insights]. | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | + +
+ + +
+List of explicit warnings + +No tests with warnings. + +
+ diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 212883b889..3dfd4913a8 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -283,6 +283,7 @@ function Set-DefinitionSection { if ($paramsWithoutCategory = $TemplateFileContent.parameters.Values | Where-Object { $_.metadata.description -notmatch '^\w+?\.' }) { $formattedParam = $paramsWithoutCategory | ForEach-Object { [PSCustomObject]@{ name = $_.name; description = $_.metadata.description } } | ConvertTo-Json -Compress Write-Error ("Each parameter description should start with a category like [Required. / Optional. / Conditional. ]. The following parameters are missing such a category: `n$formattedParam`n") + return } } else { $descriptions = $Properties.Values.metadata.description @@ -293,6 +294,7 @@ function Set-DefinitionSection { if ($paramsWithoutCategory = $Properties.Values | Where-Object { $_.metadata.description -notmatch '^\w+?\.' }) { $formattedParam = $paramsWithoutCategory | ForEach-Object { [PSCustomObject]@{ name = $_.name; description = $_.metadata.description } } | ConvertTo-Json -Compress Write-Error ("Each parameter description should start with a category like [Required. / Optional. / Conditional. ]. The following parameters are missing such a category: `n$formattedParam`n") + return } } From 79a94b1d9dde38912f3ebf2e5ae7a64d0d02d338 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 09:44:27 +0100 Subject: [PATCH 19/43] Update to latest --- ...ain.bicep-20250113-091614-TestResults.json | 458 ------------------ ...main.bicep-20250113-091939-TestResults.xml | 458 ------------------ 2 files changed, 916 deletions(-) delete mode 100644 avm-res-network-virtual-network-gateway-main.bicep-20250113-091614-TestResults.json delete mode 100644 avm-res-network-virtual-network-gateway-main.bicep-20250113-091939-TestResults.xml diff --git a/avm-res-network-virtual-network-gateway-main.bicep-20250113-091614-TestResults.json b/avm-res-network-virtual-network-gateway-main.bicep-20250113-091614-TestResults.json deleted file mode 100644 index 62012eabe4..0000000000 --- a/avm-res-network-virtual-network-gateway-main.bicep-20250113-091614-TestResults.json +++ /dev/null @@ -1,458 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - RuntimeException: You cannot call a method on a null-valued expression. - at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:300 -at Set-DefinitionSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:300 -at Set-DefinitionSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:589 -at Set-ParametersSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:188 -at Set-ModuleReadMe, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:2177 -at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:387 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Expected $null or empty, because only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [skuName]., but got 'skuName'. - at $incorrectParameters | Should -BeNullOrEmpty -Because ('only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [{0}].' -f ($incorrectParameters -join ', ')), C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:705 -at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:705 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/avm-res-network-virtual-network-gateway-main.bicep-20250113-091939-TestResults.xml b/avm-res-network-virtual-network-gateway-main.bicep-20250113-091939-TestResults.xml deleted file mode 100644 index dabc66c098..0000000000 --- a/avm-res-network-virtual-network-gateway-main.bicep-20250113-091939-TestResults.xml +++ /dev/null @@ -1,458 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - RuntimeException: You cannot call a method on a null-valued expression. - at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:300 -at Set-DefinitionSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:300 -at Set-DefinitionSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:589 -at Set-ParametersSection, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:188 -at Set-ModuleReadMe, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\sharedScripts\Set-ModuleReadMe.ps1:2177 -at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:387 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Expected $null or empty, because only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [skuName]., but got 'skuName'. - at $incorrectParameters | Should -BeNullOrEmpty -Because ('only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [{0}].' -f ($incorrectParameters -join ', ')), C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:705 -at <ScriptBlock>, C:\dev\ip\bicep-registry-modules\Upstream-Azure\utilities\pipelines\staticValidation\compliance\module.tests.ps1:705 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file From cdbcdc0d12ee5e59f515a237d1a31dc81c97b26e Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 09:45:01 +0100 Subject: [PATCH 20/43] Update to latest --- output.md | 178 ------------------------------------------------------ 1 file changed, 178 deletions(-) delete mode 100644 output.md diff --git a/output.md b/output.md deleted file mode 100644 index e3a2829818..0000000000 --- a/output.md +++ /dev/null @@ -1,178 +0,0 @@ -# Pester validation summary - -| Total No. of Processed Tests| Passed Tests :white_check_mark: | Failed Tests :x: | Skipped Tests :paperclip: | Tests with warnings :warning: | -| :-- | :-- | :-- | :-- | :-- | -| 137 | 129 | 2 | 6 | 0 | - - -
-List of failed Tests - -| Name | Error | Source | -| :-- | :-- | :-- | -| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] All non-required parameters & UDTs in template file should not have description that start with "Required.".** | Expected $null or empty, because only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [skuName]., but got 'skuName'. | [module.tests.ps1:705](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L705) | -| Module tests / Readme content tests / **[network/virtual-network-gateway] Set-ModuleReadMe script should not apply any updates.** | Expected $null or empty, because only required parameters in the template file should have a description that starts with "Required.". Found incorrect items: [skuName]., but got 'skuName'. | [module.tests.ps1:](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L) | - -
- - -
-List of passed Tests - -| Name | Source | -| :-- | :-- | -| Test file tests / General test file / **[network/virtual-network-gateway] [defaults] Bicep test deployment files in a [defaults] folder should have a parameter [serviceShort] with a value ending with [min]** | [module.tests.ps1:1312](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1312) | -| Test file tests / General test file / **[network/virtual-network-gateway] [max] Bicep test deployment files in a [max] folder should have a [serviceShort] parameter with a value ending with [max]** | [module.tests.ps1:1325](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1325) | -| Test file tests / General test file / **[network/virtual-network-gateway] [waf-aligned] Bicep test deployment files in a [waf-aligned] folder should have a [serviceShort] parameter with a value ending with [waf]** | [module.tests.ps1:1338](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1338) | -| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] All required parameters & UDTs in template file should have description that start with "(Required\|Conditional).".** | [module.tests.ps1:708](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L708) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activeActiveBGP]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activeActiveExistingPip]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activeActiveNoBGP]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activePassiveBGP]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activePassiveExistingPip]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [activePassiveNoBGP]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [defaults]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [expressRoute]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [max]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [vpn-no-az]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [vpn]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [description] for test case [waf-aligned]** | [module.tests.ps1:1359](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1359) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activeActiveBGP]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activeActiveExistingPip]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activeActiveNoBGP]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activePassiveBGP]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activePassiveExistingPip]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [activePassiveNoBGP]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [defaults]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [expressRoute]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [max]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [vpn-no-az]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [vpn]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a metadata string [name] for test case [waf-aligned]** | [module.tests.ps1:1351](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1351) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activeActiveBGP]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activeActiveExistingPip]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activeActiveNoBGP]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activePassiveBGP]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activePassiveExistingPip]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [activePassiveNoBGP]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [defaults]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [expressRoute]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [max]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [vpn-no-az]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [vpn]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [namePrefix] with value ['#\_namePrefix\_#'] for test case [waf-aligned]** | [module.tests.ps1:1367](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1367) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activeActiveBGP]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activeActiveExistingPip]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activeActiveNoBGP]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activePassiveBGP]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activePassiveExistingPip]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [activePassiveNoBGP]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [defaults]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [expressRoute]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [max]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [vpn-no-az]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [vpn]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should contain a parameter [serviceShort] for test case [waf-aligned]** | [module.tests.ps1:1297](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1297) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activeActiveBGP]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activeActiveExistingPip]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activeActiveNoBGP]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activePassiveBGP]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activePassiveExistingPip]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [activePassiveNoBGP]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [defaults]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [expressRoute]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [max]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [vpn-no-az]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [vpn]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment files should invoke test like [module testDeployment '../.*main.bicep' = [ or {] for test case [waf-aligned]** | [module.tests.ps1:1382](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1382) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activeActiveBGP]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activeActiveBgpAPIPA]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activeActiveExistingPip]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activeActiveNoBGP]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activePassiveBGP]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activePassiveExistingPip]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [activePassiveNoBGP]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [defaults]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [expressRoute]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [max]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [vpn-no-az]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [vpn]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Test file tests / General test file / **[network/virtual-network-gateway] Bicep test deployment name should contain [-test-] for test case [waf-aligned]** | [module.tests.ps1:1399](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1399) | -| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] Conditional parameters' & UDT's description should contain 'Required if' followed by the condition making the parameter required.** | [module.tests.ps1:659](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L659) | -| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] Each parameters' & UDT's 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.** | [module.tests.ps1:635](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L635) | -| Pipeline tests / **[network/virtual-network-gateway] GitHub workflow [avm.res.network.virtual-network-gateway.yml] should have [workflowPath] environment variable with value [.github/workflows/avm.res.network.virtual-network-gateway.yml].** | [module.tests.ps1:311](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L311) | -| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If a parameter [tags] exists it should be nullable.** | [module.tests.ps1:832](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L832) | -| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [diagnosticSettings], it should implement AVM's corresponding user-defined type.** | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | -| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [lock], it should implement AVM's corresponding user-defined type.** | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | -| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [roleAssignments], it should implement AVM's corresponding user-defined type.** | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | -| Module tests / Template tests / Output / **[network/virtual-network-gateway] Location output should be returned for resources that use it.** | [module.tests.ps1:1045](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1045) | -| Governance tests / **[network/virtual-network-gateway] Module identifier should be listed in issue template in the correct alphabetical position.** | [module.tests.ps1:1225](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1225) | -| File/folder tests / General module folder tests / **[network/virtual-network-gateway] Module should contain a [ main.bicep ] file.** | [module.tests.ps1:77](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L77) | -| File/folder tests / General module folder tests / **[network/virtual-network-gateway] Module should contain a [ main.json ] file.** | [module.tests.ps1:85](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L85) | -| File/folder tests / General module folder tests / **[network/virtual-network-gateway] Module should contain a [ ORPHANED.md ] file only if orphaned.** | [module.tests.ps1:135](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L135) | -| File/folder tests / General module folder tests / **[network/virtual-network-gateway] Module should contain a [ README.md ] file.** | [module.tests.ps1:93](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L93) | -| Pipeline tests / **[network/virtual-network-gateway] Module should have a GitHub workflow in path [.github/workflows/avm.res.network.virtual-network-gateway.yml].** | [module.tests.ps1:302](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L302) | -| Module tests / Template tests / Output / **[network/virtual-network-gateway] Output names description should start with a capital letter and contain text ending with a dot.** | [module.tests.ps1:1022](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1022) | -| Module tests / Template tests / Output / **[network/virtual-network-gateway] Output names should be camel-cased (no dashes or underscores and must start with lower-case letter).** | [module.tests.ps1:1004](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1004) | -| Governance tests / **[network/virtual-network-gateway] Owning team should be specified correctly in CODEWONERS file.** | [module.tests.ps1:1203](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1203) | -| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] Parameter & UDT names should be camel-cased (no dashes or underscores and must start with lower-case letter).** | [module.tests.ps1:603](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L603) | -| Module tests / Template tests / Output / **[network/virtual-network-gateway] Resource Group output should exist for resources that are deployed into a resource group scope.** | [module.tests.ps1:1067](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1067) | -| Module tests / Template tests / Output / **[network/virtual-network-gateway] Resource modules should have a name output.** | [module.tests.ps1:1087](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1087) | -| Module tests / Template tests / Output / **[network/virtual-network-gateway] Resource modules should have a Resource ID output.** | [module.tests.ps1:1120](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1120) | -| Module tests / Template tests / Resources / **[network/virtual-network-gateway] Telemetry deployment should be present in the template.** | [module.tests.ps1:875](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L875) | -| Module tests / Template tests / Resources / **[network/virtual-network-gateway] Telemetry deployment should have correct condition in the template.** | [module.tests.ps1:892](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L892) | -| Module tests / Template tests / Resources / **[network/virtual-network-gateway] Telemetry deployment should have expected inner output for verbosity.** | [module.tests.ps1:915](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L915) | -| Module tests / Template tests / Resources / **[network/virtual-network-gateway] Telemetry deployment should have expected telemetry identifier.** | [module.tests.ps1:939](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L939) | -| Module tests / Template tests / General / **[network/virtual-network-gateway] template file should have a module description specified.** | [module.tests.ps1:556](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L556) | -| Module tests / Template tests / General / **[network/virtual-network-gateway] template file should have a module name specified.** | [module.tests.ps1:547](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L547) | -| Module tests / Template tests / General / **[network/virtual-network-gateway] template file should have a module owner specified.** | [module.tests.ps1:565](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L565) | -| Module tests / Template tests / General / **[network/virtual-network-gateway] Template schema should use HTTPS reference.** | [module.tests.ps1:528](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L528) | -| Module tests / Template tests / General / **[network/virtual-network-gateway] Template schema version should be the latest.** | [module.tests.ps1:504](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L504) | -| Module tests / Compiled ARM template tests / **[network/virtual-network-gateway] The [main.json] ARM template should be based on the current [main.bicep] Bicep template.** | [module.tests.ps1:434](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L434) | -| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] The Location should be defined as a parameter, with the default value of "[resourceGroup().Location]" or "global" for ResourceGroup deployment scope.** | [module.tests.ps1:577](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L577) | -| Module tests / Template tests / Parameters / **[network/virtual-network-gateway] The telemetry parameter should be present & have the expected type, default value & metadata description.** | [module.tests.ps1:591](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L591) | -| Module tests / Template tests / General / **[network/virtual-network-gateway] The template file should contain required elements [schema], [contentVersion], [resources].** | [module.tests.ps1:537](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L537) | -| Module tests / Template tests / General / **[network/virtual-network-gateway] The template file should not be empty.** | [module.tests.ps1:496](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L496) | -| Module tests / Template tests / Variables / **[network/virtual-network-gateway] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter).** | [module.tests.ps1:848](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L848) | -| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain a [ tests ] folder.** | [module.tests.ps1:213](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L213) | -| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain a [ tests/e2e ] folder.** | [module.tests.ps1:223](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L223) | -| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain a [ tests/e2e/*defaults ] folder.** | [module.tests.ps1:243](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L243) | -| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain a [ tests/e2e/*waf-aligned ] folder.** | [module.tests.ps1:233](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L233) | -| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain a [ version.json ] file.** | [module.tests.ps1:203](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L203) | -| File/folder tests / Top level module folder tests / **[res/network/virtual-network-gateway] Module should contain one [ main.test.bicep ] file in each e2e test folder.** | [module.tests.ps1:259](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L259) | -| API version tests / **In [res/network/virtual-network-gateway] used resource type [locks] should use one of the recent API version(s). Currently using [2020-05-01].** | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | -| API version tests / **In [res/network/virtual-network-gateway] used resource type [publicIPAddresses] should use one of the recent API version(s). Currently using [2023-09-01].** | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | -| API version tests / **In [res/network/virtual-network-gateway] used resource type [roleAssignments] should use one of the recent API version(s). Currently using [2022-04-01].** | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | -| API version tests / **In [res/network/virtual-network-gateway] used resource type [virtualNetworkGateways] should use one of the recent API version(s). Currently using [2023-04-01].** | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | -| API version tests / **In [res/network/virtual-network-gateway] used resource type [virtualNetworkGateways/natRules] should use one of the recent API version(s). Currently using [2023-04-01].** | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | - -
- - -
-List of skipped Tests - -| Name | Reason | Source | -| :-- | :-- | :-- | -| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If a UDT definition [managedIdentitiesType] exists and supports system-assigned-identities, the template should have an output for its principal ID.** | Test is skipped, because the module template has no [managedIdentitiesType] UDT definition or does not support system-assigned-identities. | [module.tests.ps1:819](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L819) | -| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [customerManagedKey], it should implement AVM's corresponding user-defined type.** | Test is skipped, because the module template has no [customerManagedKey] parameter. | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | -| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [managedIdentities], it should implement AVM's corresponding user-defined type.** | Test is skipped, because the module template has no [managedIdentities] parameter. | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | -| Module tests / Template tests / Parameters / Schema-based User-defined-types tests / **[network/virtual-network-gateway] If template has a parameter [privateEndpoints], it should implement AVM's corresponding user-defined type.** | Test is skipped, because the module template has no [privateEndpoints] parameter. | [module.tests.ps1:796](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L796) | -| Module tests / Template tests / Output / **[network/virtual-network-gateway] Resource modules Principal ID output should exist, if supported.** | Test is skipped, because the module template seems not to support an identity object. | [module.tests.ps1:1154](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1154) | -| API version tests / **In [res/network/virtual-network-gateway] used resource type [diagnosticSettings] should use one of the recent API version(s). Currently using [2021-05-01-preview].** | Test is skipped, because The Azure API version file is missing the Resource Type [diagnosticSettings] for Provider Namespace [Microsoft.Insights]. | [module.tests.ps1:1507](https://github.com/Azure/bicep-registry-modules/blob/users/alsehr/4128_discriminator/utilities\pipelines\staticValidation\compliance\module.tests.ps1#L1507) | - -
- - -
-List of explicit warnings - -No tests with warnings. - -
- From 0c9cc1c79ebfb3887212d9d99cc3cd17ce3c4cb3 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 11:21:19 +0100 Subject: [PATCH 21/43] Update to latest --- .../staticValidation/compliance/Set-PesterGitHubOutput.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 b/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 index dafe535aa4..1c1b2070a9 100644 --- a/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 +++ b/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 @@ -152,7 +152,7 @@ function Set-PesterGitHubOutput { } $testLine = $failedTest.ErrorRecord.TargetObject.Line - $errorMessage = ($failedTest.ErrorRecord.TargetObject.Message.Trim() -replace '_', '\_') -replace '\n', '
' # Replace new lines with
to enable line breaks in markdown + $errorMessage = (($failedTest.ErrorRecord.TargetObject.Message ?? '').Trim() -replace '_', '\_') -replace '\n', '
' # Replace new lines with
to enable line breaks in markdown $testReference = '{0}:{1}' -f (Split-Path $testFile -Leaf), $testLine From 612ed21da0620c8d47ca2e1288385585fa4f10ba Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 11:43:30 +0100 Subject: [PATCH 22/43] Update to latest --- utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 | 2 -- .../staticValidation/compliance/Set-PesterGitHubOutput.ps1 | 2 +- .../pipelines/staticValidation/compliance/module.tests.ps1 | 2 +- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 3dfd4913a8..212883b889 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -283,7 +283,6 @@ function Set-DefinitionSection { if ($paramsWithoutCategory = $TemplateFileContent.parameters.Values | Where-Object { $_.metadata.description -notmatch '^\w+?\.' }) { $formattedParam = $paramsWithoutCategory | ForEach-Object { [PSCustomObject]@{ name = $_.name; description = $_.metadata.description } } | ConvertTo-Json -Compress Write-Error ("Each parameter description should start with a category like [Required. / Optional. / Conditional. ]. The following parameters are missing such a category: `n$formattedParam`n") - return } } else { $descriptions = $Properties.Values.metadata.description @@ -294,7 +293,6 @@ function Set-DefinitionSection { if ($paramsWithoutCategory = $Properties.Values | Where-Object { $_.metadata.description -notmatch '^\w+?\.' }) { $formattedParam = $paramsWithoutCategory | ForEach-Object { [PSCustomObject]@{ name = $_.name; description = $_.metadata.description } } | ConvertTo-Json -Compress Write-Error ("Each parameter description should start with a category like [Required. / Optional. / Conditional. ]. The following parameters are missing such a category: `n$formattedParam`n") - return } } diff --git a/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 b/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 index 1c1b2070a9..dba7a5511e 100644 --- a/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 +++ b/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 @@ -152,7 +152,7 @@ function Set-PesterGitHubOutput { } $testLine = $failedTest.ErrorRecord.TargetObject.Line - $errorMessage = (($failedTest.ErrorRecord.TargetObject.Message ?? '').Trim() -replace '_', '\_') -replace '\n', '
' # Replace new lines with
to enable line breaks in markdown + $errorMessage = (($failedTest.ErrorRecord.TargetObject.Message).Trim() -replace '_', '\_') -replace '\n', '
' # Replace new lines with
to enable line breaks in markdown $testReference = '{0}:{1}' -f (Split-Path $testFile -Leaf), $testLine diff --git a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 index d6a0882b72..1e5dbdebe3 100644 --- a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 +++ b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 @@ -388,7 +388,7 @@ Describe 'Module tests' -Tag 'Module' { TemplateFileContent = $templateFileContent CrossReferencedModuleList = $crossReferencedModuleList TelemetryFileContent = $telemetryFileContent - } + } -ErrorAction 'SilentlyContinue' # Get hash after 'update' $fileHashAfter = (Get-FileHash $readMeFilePath).Hash From b23dcfdb637bfecd99b7d5216553f4e6cea336af Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 11:47:45 +0100 Subject: [PATCH 23/43] Update to latest --- utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 | 2 ++ 1 file changed, 2 insertions(+) diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 212883b889..3dfd4913a8 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -283,6 +283,7 @@ function Set-DefinitionSection { if ($paramsWithoutCategory = $TemplateFileContent.parameters.Values | Where-Object { $_.metadata.description -notmatch '^\w+?\.' }) { $formattedParam = $paramsWithoutCategory | ForEach-Object { [PSCustomObject]@{ name = $_.name; description = $_.metadata.description } } | ConvertTo-Json -Compress Write-Error ("Each parameter description should start with a category like [Required. / Optional. / Conditional. ]. The following parameters are missing such a category: `n$formattedParam`n") + return } } else { $descriptions = $Properties.Values.metadata.description @@ -293,6 +294,7 @@ function Set-DefinitionSection { if ($paramsWithoutCategory = $Properties.Values | Where-Object { $_.metadata.description -notmatch '^\w+?\.' }) { $formattedParam = $paramsWithoutCategory | ForEach-Object { [PSCustomObject]@{ name = $_.name; description = $_.metadata.description } } | ConvertTo-Json -Compress Write-Error ("Each parameter description should start with a category like [Required. / Optional. / Conditional. ]. The following parameters are missing such a category: `n$formattedParam`n") + return } } From 417fef6e98c84cb5282b1a0dadeee0312a54607e Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 14:32:25 +0100 Subject: [PATCH 24/43] Update to latest --- .../pipelines/staticValidation/compliance/module.tests.ps1 | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 index 1e5dbdebe3..3648861334 100644 --- a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 +++ b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 @@ -388,7 +388,12 @@ Describe 'Module tests' -Tag 'Module' { TemplateFileContent = $templateFileContent CrossReferencedModuleList = $crossReferencedModuleList TelemetryFileContent = $telemetryFileContent - } -ErrorAction 'SilentlyContinue' + } -ErrorVariable $err + + if ($err) { + Set-ItResult -Skipped -Because "Failed to apply the `Set-ModuleReadMe` function due to [$err]." + return + } # Get hash after 'update' $fileHashAfter = (Get-FileHash $readMeFilePath).Hash From 0edc3056f48d50d68b4d76b82fd2c3f1da77cb28 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 15:04:22 +0100 Subject: [PATCH 25/43] Update to latest --- .../pipelines/staticValidation/compliance/module.tests.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 index 3648861334..265d156c2f 100644 --- a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 +++ b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 @@ -388,7 +388,7 @@ Describe 'Module tests' -Tag 'Module' { TemplateFileContent = $templateFileContent CrossReferencedModuleList = $crossReferencedModuleList TelemetryFileContent = $telemetryFileContent - } -ErrorVariable $err + } -ErrorVariable $err -ErrorAction 'SilentlyContinue' if ($err) { Set-ItResult -Skipped -Because "Failed to apply the `Set-ModuleReadMe` function due to [$err]." From 1b5a6ea4ef1616e8d9cc1bfd2a699602598d11d1 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 15:14:50 +0100 Subject: [PATCH 26/43] Update to latest --- .../compliance/module.tests.ps1 | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 index 265d156c2f..01b329fbcc 100644 --- a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 +++ b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 @@ -384,15 +384,17 @@ Describe 'Module tests' -Tag 'Module' { . (Join-Path $repoRootPath 'utilities' 'pipelines' 'sharedScripts' 'Set-ModuleReadMe.ps1') # Apply update with already compiled template content - Set-ModuleReadMe -TemplateFilePath $templateFilePath -PreLoadedContent @{ - TemplateFileContent = $templateFileContent - CrossReferencedModuleList = $crossReferencedModuleList - TelemetryFileContent = $telemetryFileContent - } -ErrorVariable $err -ErrorAction 'SilentlyContinue' - - if ($err) { - Set-ItResult -Skipped -Because "Failed to apply the `Set-ModuleReadMe` function due to [$err]." - return + try { + Set-ModuleReadMe -TemplateFilePath $templateFilePath -PreLoadedContent @{ + TemplateFileContent = $templateFileContent + CrossReferencedModuleList = $crossReferencedModuleList + TelemetryFileContent = $telemetryFileContent + } -ErrorVariable $err -ErrorAction 'Stop' + } catch { + if ($err) { + Set-ItResult -Skipped -Because "Failed to apply the `Set-ModuleReadMe` function due to [$err]." + return + } } # Get hash after 'update' From a08850c9b9003cb7fe8d4ed7e8b2025f9451e2d2 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 15:24:36 +0100 Subject: [PATCH 27/43] Update to latest --- .../staticValidation/compliance/module.tests.ps1 | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 index 01b329fbcc..3730c08047 100644 --- a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 +++ b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 @@ -389,12 +389,10 @@ Describe 'Module tests' -Tag 'Module' { TemplateFileContent = $templateFileContent CrossReferencedModuleList = $crossReferencedModuleList TelemetryFileContent = $telemetryFileContent - } -ErrorVariable $err -ErrorAction 'Stop' + } -ErrorAction 'Stop' } catch { - if ($err) { - Set-ItResult -Skipped -Because "Failed to apply the `Set-ModuleReadMe` function due to [$err]." - return - } + Set-ItResult -Skipped -Because "Failed to apply the `Set-ModuleReadMe` function due to an error during the function's execution." + return } # Get hash after 'update' From 63682995496953b3d78a263ea6f6656fb9342242 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 15:53:56 +0100 Subject: [PATCH 28/43] Update to latest --- .../pipelines/staticValidation/compliance/module.tests.ps1 | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 index 3730c08047..cc4aecc73c 100644 --- a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 +++ b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 @@ -389,10 +389,9 @@ Describe 'Module tests' -Tag 'Module' { TemplateFileContent = $templateFileContent CrossReferencedModuleList = $crossReferencedModuleList TelemetryFileContent = $telemetryFileContent - } -ErrorAction 'Stop' + } -ErrorAction 'Stop' -ErrorVariable 'InvocationError' } catch { - Set-ItResult -Skipped -Because "Failed to apply the `Set-ModuleReadMe` function due to an error during the function's execution." - return + $InvocationError[-1] | Should -BeNullOrEmpty -Because "Failed to apply the `Set-ModuleReadMe` function due to an error during the function's execution." } # Get hash after 'update' From 4889247e5634a727dd219a50b75236a16b2517fb Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 15:54:44 +0100 Subject: [PATCH 29/43] Update to latest --- .../pipelines/staticValidation/compliance/module.tests.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 index cc4aecc73c..f6e296c4d4 100644 --- a/utilities/pipelines/staticValidation/compliance/module.tests.ps1 +++ b/utilities/pipelines/staticValidation/compliance/module.tests.ps1 @@ -391,7 +391,7 @@ Describe 'Module tests' -Tag 'Module' { TelemetryFileContent = $telemetryFileContent } -ErrorAction 'Stop' -ErrorVariable 'InvocationError' } catch { - $InvocationError[-1] | Should -BeNullOrEmpty -Because "Failed to apply the `Set-ModuleReadMe` function due to an error during the function's execution." + $InvocationError[-1] | Should -BeNullOrEmpty -Because "Failed to apply the `Set-ModuleReadMe` function due to an error during the function's execution. Please review the inner error(s)." } # Get hash after 'update' From 5a3c1efbb1b2dc7d6c372feda627ef824bc06cf1 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 21:03:06 +0100 Subject: [PATCH 30/43] Update to latest --- .../staticValidation/compliance/Set-PesterGitHubOutput.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 b/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 index dba7a5511e..dafe535aa4 100644 --- a/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 +++ b/utilities/pipelines/staticValidation/compliance/Set-PesterGitHubOutput.ps1 @@ -152,7 +152,7 @@ function Set-PesterGitHubOutput { } $testLine = $failedTest.ErrorRecord.TargetObject.Line - $errorMessage = (($failedTest.ErrorRecord.TargetObject.Message).Trim() -replace '_', '\_') -replace '\n', '
' # Replace new lines with
to enable line breaks in markdown + $errorMessage = ($failedTest.ErrorRecord.TargetObject.Message.Trim() -replace '_', '\_') -replace '\n', '
' # Replace new lines with
to enable line breaks in markdown $testReference = '{0}:{1}' -f (Split-Path $testFile -Leaf), $testLine From 42fc0001513310bf590dbf3b3f36fd83e4cdf21e Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Mon, 13 Jan 2025 21:45:59 +0100 Subject: [PATCH 31/43] Enabled parameter-resolving function to work with user-defined types --- .../compliance/helper/helper.psm1 | 324 +++++++++--------- 1 file changed, 169 insertions(+), 155 deletions(-) diff --git a/utilities/pipelines/staticValidation/compliance/helper/helper.psm1 b/utilities/pipelines/staticValidation/compliance/helper/helper.psm1 index a59a90968a..b19604d111 100644 --- a/utilities/pipelines/staticValidation/compliance/helper/helper.psm1 +++ b/utilities/pipelines/staticValidation/compliance/helper/helper.psm1 @@ -36,21 +36,21 @@ Get the index of the '# Parameters' header in the given markdown array @('# Para #> function Get-MarkdownSectionStartIndex { - [CmdletBinding()] - param ( - [Parameter(Mandatory = $true)] - [array] $ReadMeContent, - - [Parameter(Mandatory = $true)] - [string] $MarkdownSectionIdentifier - ) - - $sectionStartIndex = 0 - while ($ReadMeContent[$sectionStartIndex] -notlike $MarkdownSectionIdentifier -and -not ($sectionStartIndex -ge $ReadMeContent.count)) { - $sectionStartIndex++ - } + [CmdletBinding()] + param ( + [Parameter(Mandatory = $true)] + [array] $ReadMeContent, + + [Parameter(Mandatory = $true)] + [string] $MarkdownSectionIdentifier + ) + + $sectionStartIndex = 0 + while ($ReadMeContent[$sectionStartIndex] -notlike $MarkdownSectionIdentifier -and -not ($sectionStartIndex -ge $ReadMeContent.count)) { + $sectionStartIndex++ + } - return $sectionStartIndex + return $sectionStartIndex } <# @@ -73,21 +73,21 @@ Search for the end index of the section starting in index 2 in array @('somrthin #> function Get-MarkdownSectionEndIndex { - [CmdletBinding()] - param ( - [Parameter(Mandatory = $true)] - [array] $ReadMeContent, + [CmdletBinding()] + param ( + [Parameter(Mandatory = $true)] + [array] $ReadMeContent, - [Parameter(Mandatory = $true)] - [int] $SectionStartIndex - ) + [Parameter(Mandatory = $true)] + [int] $SectionStartIndex + ) - $sectionEndIndex = $sectionStartIndex + 1 - while ($readMeContent[$sectionEndIndex] -notlike '*# *' -and -not ($sectionEndIndex -ge $ReadMeContent.count)) { - $sectionEndIndex++ - } + $sectionEndIndex = $sectionStartIndex + 1 + while ($readMeContent[$sectionEndIndex] -notlike '*# *' -and -not ($sectionEndIndex -ge $ReadMeContent.count)) { + $sectionEndIndex++ + } - return $sectionEndIndex + return $sectionEndIndex } <# @@ -110,28 +110,28 @@ Get the start & end index of the table in section '# Parameters' in the given Re #> function Get-TableStartAndEndIndex { - [CmdletBinding()] - param ( - [Parameter(Mandatory = $true)] - [array] $ReadMeContent, + [CmdletBinding()] + param ( + [Parameter(Mandatory = $true)] + [array] $ReadMeContent, - [Parameter(Mandatory = $true)] - [string] $MarkdownSectionIdentifier - ) + [Parameter(Mandatory = $true)] + [string] $MarkdownSectionIdentifier + ) - $sectionStartIndex = Get-MarkdownSectionStartIndex -ReadMeContent $ReadMeContent -MarkdownSectionIdentifier $MarkdownSectionIdentifier + $sectionStartIndex = Get-MarkdownSectionStartIndex -ReadMeContent $ReadMeContent -MarkdownSectionIdentifier $MarkdownSectionIdentifier - $tableStartIndex = $sectionStartIndex + 1 - while ($readMeContent[$tableStartIndex] -notlike '*|*' -and -not ($tableStartIndex -ge $readMeContent.count)) { - $tableStartIndex++ - } + $tableStartIndex = $sectionStartIndex + 1 + while ($readMeContent[$tableStartIndex] -notlike '*|*' -and -not ($tableStartIndex -ge $readMeContent.count)) { + $tableStartIndex++ + } - $tableEndIndex = $tableStartIndex + 2 - while ($readMeContent[$tableEndIndex] -like '|*' -and -not ($tableEndIndex -ge $readMeContent.count)) { - $tableEndIndex++ - } + $tableEndIndex = $tableStartIndex + 2 + while ($readMeContent[$tableEndIndex] -like '|*' -and -not ($tableEndIndex -ge $readMeContent.count)) { + $tableEndIndex++ + } - return $tableStartIndex, $tableEndIndex + return $tableStartIndex, $tableEndIndex } <# @@ -151,32 +151,32 @@ Returns @{ b = 'b' } #> function Remove-JSONMetadata { - [CmdletBinding()] - param ( - [Parameter(Mandatory = $true)] - [hashtable] $TemplateObject - ) - $TemplateObject.Remove('metadata') - - # Differantiate case: With user defined types (resources property is hashtable) vs without user defined types (resources property is array) - if ($TemplateObject.resources.GetType().BaseType.Name -eq 'Hashtable') { - # Case: Hashtable - $resourceIdentifiers = $TemplateObject.resources.Keys - for ($index = 0; $index -lt $resourceIdentifiers.Count; $index++) { - if ($TemplateObject.resources[$resourceIdentifiers[$index]].type -eq 'Microsoft.Resources/deployments' -and $TemplateObject.resources[$resourceIdentifiers[$index]].properties.template.GetType().BaseType.Name -eq 'Hashtable') { - $TemplateObject.resources[$resourceIdentifiers[$index]] = Remove-JSONMetadata -TemplateObject $TemplateObject.resources[$resourceIdentifiers[$index]].properties.template - } - } - } else { - # Case: Array - for ($index = 0; $index -lt $TemplateObject.resources.Count; $index++) { - if ($TemplateObject.resources[$index].type -eq 'Microsoft.Resources/deployments' -and $TemplateObject.resources[$index].properties.template.GetType().BaseType.Name -eq 'Hashtable') { - $TemplateObject.resources[$index] = Remove-JSONMetadata -TemplateObject $TemplateObject.resources[$index].properties.template - } + [CmdletBinding()] + param ( + [Parameter(Mandatory = $true)] + [hashtable] $TemplateObject + ) + $TemplateObject.Remove('metadata') + + # Differantiate case: With user defined types (resources property is hashtable) vs without user defined types (resources property is array) + if ($TemplateObject.resources.GetType().BaseType.Name -eq 'Hashtable') { + # Case: Hashtable + $resourceIdentifiers = $TemplateObject.resources.Keys + for ($index = 0; $index -lt $resourceIdentifiers.Count; $index++) { + if ($TemplateObject.resources[$resourceIdentifiers[$index]].type -eq 'Microsoft.Resources/deployments' -and $TemplateObject.resources[$resourceIdentifiers[$index]].properties.template.GetType().BaseType.Name -eq 'Hashtable') { + $TemplateObject.resources[$resourceIdentifiers[$index]] = Remove-JSONMetadata -TemplateObject $TemplateObject.resources[$resourceIdentifiers[$index]].properties.template + } + } + } else { + # Case: Array + for ($index = 0; $index -lt $TemplateObject.resources.Count; $index++) { + if ($TemplateObject.resources[$index].type -eq 'Microsoft.Resources/deployments' -and $TemplateObject.resources[$index].properties.template.GetType().BaseType.Name -eq 'Hashtable') { + $TemplateObject.resources[$index] = Remove-JSONMetadata -TemplateObject $TemplateObject.resources[$index].properties.template + } + } } - } - return $TemplateObject + return $TemplateObject } <# @@ -209,76 +209,90 @@ Child-level invocation during recursion. The function is recursive and will also output grand, great grand children, ... . #> function Resolve-ReadMeParameterList { - param ( - [Parameter(Mandatory = $true)] - [hashtable] $TemplateFileContent, - - [Parameter(Mandatory = $false)] - [hashtable] $Properties, - - [Parameter(Mandatory = $false)] - [string] $ParentName - ) - - $parameterSet = @{} - - if (-not $Properties -and -not $TemplateFileContent.parameters) { - # no Parameters / properties on this level or in the template - return $parameterSet - } elseif (-not $Properties) { - # Top-level invocation - # Add name as property for later reference - $TemplateFileContent.parameters.Keys | ForEach-Object { $TemplateFileContent.parameters[$_]['name'] = $_ } - [array] $parameters = $TemplateFileContent.parameters.Values | Sort-Object -Property 'Name' -Culture 'en-US' - } else { - # Add name as property for later reference - $Properties.Keys | ForEach-Object { $Properties[$_]['name'] = $_ } - $parameters = $Properties.Values | Sort-Object -Property 'Name' -Culture 'en-US' - } - - foreach ($parameter in $parameters) { - - ###################### - # Gather details # - ###################### - - $paramIdentifier = (-not [String]::IsNullOrEmpty($ParentName)) ? '{0}.{1}' -f $ParentName, $parameter.name : $parameter.name - - # definition type (if any) - if ($parameter.Keys -contains '$ref') { - $identifier = Split-Path $parameter.'$ref' -Leaf - $definition = $TemplateFileContent.definitions[$identifier] - # $type = $definition['type'] - } elseif ($parameter.Keys -contains 'items' -and $parameter.items.type -in @('object', 'array') -or $parameter.type -eq 'object') { - # Array has nested non-primitive type (array/object) - and if array, the the UDT itself is declared as the array - $definition = $parameter - } elseif ($parameter.Keys -contains 'items' -and $parameter.items.keys -contains '$ref') { - # Array has nested non-primitive type (array) - and the parameter is defined as an array of the UDT - $identifier = Split-Path $parameter.items.'$ref' -Leaf - $definition = $TemplateFileContent.definitions[$identifier] + param ( + [Parameter(Mandatory = $true)] + [hashtable] $TemplateFileContent, + + [Parameter(Mandatory = $false)] + [hashtable] $Properties, + + [Parameter(Mandatory = $false)] + [string] $ParentName + ) + + $parameterSet = @{} + + if (-not $Properties -and -not $TemplateFileContent.parameters) { + # no Parameters / properties on this level or in the template + return $parameterSet + } elseif (-not $Properties) { + # Top-level invocation + # Add name as property for later reference + $TemplateFileContent.parameters.Keys | ForEach-Object { $TemplateFileContent.parameters[$_]['name'] = $_ } + [array] $parameters = $TemplateFileContent.parameters.Values | Sort-Object -Property 'Name' -Culture 'en-US' } else { - $definition = $null + # Add name as property for later reference + $Properties.Keys | ForEach-Object { $Properties[$_]['name'] = $_ } + $parameters = $Properties.Values | Sort-Object -Property 'Name' -Culture 'en-US' } - $parameterSet[$paramIdentifier] = $parameter - - #recursive call for children - if ($definition) { - if ($definition.ContainsKey('items') -and $definition['items'].ContainsKey('properties')) { - $childProperties = $definition['items']['properties'] - } elseif ($definition.type -eq 'object' -and $definition['properties']) { - $childProperties = $definition['properties'] - } else { - $childProperties = $null - } - - if ($childProperties) { - $parameterSet += Resolve-ReadMeParameterList -TemplateFileContent $TemplateFileContent -Properties $childProperties -ParentName $paramIdentifier - } + foreach ($parameter in $parameters) { + + ###################### + # Gather details # + ###################### + + $paramIdentifier = (-not [String]::IsNullOrEmpty($ParentName)) ? '{0}.{1}' -f $ParentName, $parameter.name : $parameter.name + + # definition type (if any) + if ($parameter.Keys -contains '$ref') { + $identifier = Split-Path $parameter.'$ref' -Leaf + $definition = $TemplateFileContent.definitions[$identifier] + # $type = $definition['type'] + } elseif ($parameter.Keys -contains 'items' -and $parameter.items.type -in @('object', 'array') -or $parameter.type -eq 'object') { + # Array has nested non-primitive type (array/object) - and if array, the the UDT itself is declared as the array + $definition = $parameter + } elseif ($parameter.Keys -contains 'items' -and $parameter.items.keys -contains '$ref') { + # Array has nested non-primitive type (array) - and the parameter is defined as an array of the UDT + $identifier = Split-Path $parameter.items.'$ref' -Leaf + $definition = $TemplateFileContent.definitions[$identifier] + } else { + $definition = $null + } + + $parameterSet[$paramIdentifier] = $parameter + + #recursive call for children + if ($definition -and $definition.keys -notcontains 'discriminator') { + if ($definition.ContainsKey('items') -and $definition['items'].ContainsKey('properties')) { + $childProperties = $definition['items']['properties'] + } elseif ($definition.type -in @('object', 'secureObject') -and $definition['properties']) { + $childProperties = $definition['properties'] + } else { + $childProperties = $null + } + + if ($childProperties) { + $parameterSet += Resolve-ReadMeParameterList -TemplateFileContent $TemplateFileContent -Properties $childProperties -ParentName $paramIdentifier + } + } elseif ($definition -and $definition.keys -contains 'discriminator') { + + $variants = $definition.discriminator.mapping.values.'$ref' | ForEach-Object { + $variantName = Split-Path $_ -Leaf + @{ + name = $variantName + properties = $TemplateFileContent.definitions[$variantName].properties + } + } + + foreach ($variant in $variants) { + $paramIdentifier = (-not [String]::IsNullOrEmpty($ParentName)) ? '{0}.{1}.{2}' -f $ParentName, $parameter.name, $variant.name : '{0}.{1}' -f $parameter.name, $variant.name + $parameterSet += Resolve-ReadMeParameterList -TemplateFileContent $TemplateFileContent -Properties $variant.properties -ParentName $paramIdentifier + } + } } - } - return $parameterSet + return $parameterSet } <# @@ -297,33 +311,33 @@ Get the environment variables from the given workflow #> function Get-WorkflowEnvVariablesAsObject { - [CmdletBinding()] - param ( - [Parameter(Mandatory)] - [string] $WorkflowPath - ) - - $contentFileContent = Get-Content -Path $workflowPath + [CmdletBinding()] + param ( + [Parameter(Mandatory)] + [string] $WorkflowPath + ) - $envStartIndex = $contentFileContent.IndexOf('env:') + $contentFileContent = Get-Content -Path $workflowPath - if (-not $envStartIndex) { - # No env variables defined in the given workflow - return @{} - } + $envStartIndex = $contentFileContent.IndexOf('env:') - $searchIndex = $envStartIndex + 1 - $envVars = @{} + if (-not $envStartIndex) { + # No env variables defined in the given workflow + return @{} + } - while ($searchIndex -lt $contentFileContent.Count) { - $line = $contentFileContent[$searchIndex] - if ($line -match "^\s+(\w+): (?:`"|')*([^`"'\s]+)(?:`"|')*$") { - $envVars[($Matches[1])] = $Matches[2] - } else { - break + $searchIndex = $envStartIndex + 1 + $envVars = @{} + + while ($searchIndex -lt $contentFileContent.Count) { + $line = $contentFileContent[$searchIndex] + if ($line -match "^\s+(\w+): (?:`"|')*([^`"'\s]+)(?:`"|')*$") { + $envVars[($Matches[1])] = $Matches[2] + } else { + break + } + $searchIndex++ } - $searchIndex++ - } - return $envVars + return $envVars } From a7d99e498a9a365fd6fa3e8ef341aa81e836fe31 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Tue, 14 Jan 2025 21:27:17 +0100 Subject: [PATCH 32/43] Added missing description, fixed another, added UDT, updated tests --- .../network/virtual-network-gateway/README.md | 262 ++++---- .../virtual-network-gateway/main.bicep | 160 ++--- .../network/virtual-network-gateway/main.json | 632 +++++++++++------- .../nat-rule/README.md | 63 +- .../nat-rule/main.bicep | 32 +- .../nat-rule/main.json | 65 +- .../tests/e2e/activeActiveBGP/main.test.bicep | 4 - .../e2e/activeActiveBgpAPIPA/main.test.bicep | 8 +- .../activeActiveExistingPip/main.test.bicep | 6 +- .../e2e/activeActiveNoBGP/main.test.bicep | 4 - .../e2e/activePassiveBGP/main.test.bicep | 10 +- .../activePassiveExistingPip/main.test.bicep | 10 +- .../e2e/activePassiveNoBGP/main.test.bicep | 8 +- .../tests/e2e/defaults/main.test.bicep | 12 +- .../tests/e2e/expressRoute/main.test.bicep | 6 +- .../tests/e2e/max/main.test.bicep | 4 - .../tests/e2e/vpn-no-az/main.test.bicep | 4 - .../tests/e2e/vpn/main.test.bicep | 6 +- .../tests/e2e/waf-aligned/main.test.bicep | 9 - 19 files changed, 714 insertions(+), 591 deletions(-) diff --git a/avm/res/network/virtual-network-gateway/README.md b/avm/res/network/virtual-network-gateway/README.md index 31840c9807..12792e023c 100644 --- a/avm/res/network/virtual-network-gateway/README.md +++ b/avm/res/network/virtual-network-gateway/README.md @@ -73,7 +73,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: enableBgpRouteTranslationForNat: true enablePrivateIpAddress: true gatewayDefaultSiteLocalNetworkGatewayId: '' - location: '' publicIpZones: [ 1 2 @@ -134,9 +133,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "gatewayDefaultSiteLocalNetworkGatewayId": { "value": "" }, - "location": { - "value": "" - }, "publicIpZones": { "value": [ 1, @@ -183,7 +179,6 @@ param domainNameLabel = [ param enableBgpRouteTranslationForNat = true param enablePrivateIpAddress = true param gatewayDefaultSiteLocalNetworkGatewayId = '' -param location = '' param publicIpZones = [ 1 2 @@ -234,7 +229,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: enableBgpRouteTranslationForNat: true enablePrivateIpAddress: true gatewayDefaultSiteLocalNetworkGatewayId: '' - location: '' publicIpZones: [ 1 2 @@ -303,9 +297,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "gatewayDefaultSiteLocalNetworkGatewayId": { "value": "" }, - "location": { - "value": "" - }, "publicIpZones": { "value": [ 1, @@ -360,7 +351,6 @@ param domainNameLabel = [ param enableBgpRouteTranslationForNat = true param enablePrivateIpAddress = true param gatewayDefaultSiteLocalNetworkGatewayId = '' -param location = '' param publicIpZones = [ 1 2 @@ -405,7 +395,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: enablePrivateIpAddress: true existingFirstPipResourceId: '' gatewayDefaultSiteLocalNetworkGatewayId: '' - location: '' publicIpZones: [ 1 2 @@ -470,9 +459,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "gatewayDefaultSiteLocalNetworkGatewayId": { "value": "" }, - "location": { - "value": "" - }, "publicIpZones": { "value": [ 1, @@ -521,7 +507,6 @@ param enableBgpRouteTranslationForNat = true param enablePrivateIpAddress = true param existingFirstPipResourceId = '' param gatewayDefaultSiteLocalNetworkGatewayId = '' -param location = '' param publicIpZones = [ 1 2 @@ -564,7 +549,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: enableBgpRouteTranslationForNat: true enablePrivateIpAddress: true gatewayDefaultSiteLocalNetworkGatewayId: '' - location: '' publicIpZones: [ 1 2 @@ -625,9 +609,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "gatewayDefaultSiteLocalNetworkGatewayId": { "value": "" }, - "location": { - "value": "" - }, "publicIpZones": { "value": [ 1, @@ -674,7 +655,6 @@ param domainNameLabel = [ param enableBgpRouteTranslationForNat = true param enablePrivateIpAddress = true param gatewayDefaultSiteLocalNetworkGatewayId = '' -param location = '' param publicIpZones = [ 1 2 @@ -722,7 +702,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: enableBgpRouteTranslationForNat: true enablePrivateIpAddress: true gatewayDefaultSiteLocalNetworkGatewayId: '' - location: '' publicIpZones: [ 1 2 @@ -788,9 +767,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "gatewayDefaultSiteLocalNetworkGatewayId": { "value": "" }, - "location": { - "value": "" - }, "publicIpZones": { "value": [ 1, @@ -842,7 +818,6 @@ param domainNameLabel = [ param enableBgpRouteTranslationForNat = true param enablePrivateIpAddress = true param gatewayDefaultSiteLocalNetworkGatewayId = '' -param location = '' param publicIpZones = [ 1 2 @@ -891,7 +866,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: enablePrivateIpAddress: true existingFirstPipResourceId: '' gatewayDefaultSiteLocalNetworkGatewayId: '' - location: '' publicIpZones: [ 1 2 @@ -960,9 +934,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "gatewayDefaultSiteLocalNetworkGatewayId": { "value": "" }, - "location": { - "value": "" - }, "publicIpZones": { "value": [ 1, @@ -1015,7 +986,6 @@ param enableBgpRouteTranslationForNat = true param enablePrivateIpAddress = true param existingFirstPipResourceId = '' param gatewayDefaultSiteLocalNetworkGatewayId = '' -param location = '' param publicIpZones = [ 1 2 @@ -1058,7 +1028,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: enableBgpRouteTranslationForNat: true enablePrivateIpAddress: true gatewayDefaultSiteLocalNetworkGatewayId: '' - location: '' publicIpZones: [ 1 2 @@ -1119,9 +1088,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "gatewayDefaultSiteLocalNetworkGatewayId": { "value": "" }, - "location": { - "value": "" - }, "publicIpZones": { "value": [ 1, @@ -1168,7 +1134,6 @@ param domainNameLabel = [ param enableBgpRouteTranslationForNat = true param enablePrivateIpAddress = true param gatewayDefaultSiteLocalNetworkGatewayId = '' -param location = '' param publicIpZones = [ 1 2 @@ -1202,14 +1167,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: gatewayType: 'Vpn' name: 'nvgmin001' vNetResourceId: '' - // Non-required parameters - location: '' - publicIpZones: [ - 1 - 2 - 3 - ] - skuName: 'VpnGw2AZ' } } ``` @@ -1240,20 +1197,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: }, "vNetResourceId": { "value": "" - }, - // Non-required parameters - "location": { - "value": "" - }, - "publicIpZones": { - "value": [ - 1, - 2, - 3 - ] - }, - "skuName": { - "value": "VpnGw2AZ" } } } @@ -1276,14 +1219,6 @@ param clusterSettings = { param gatewayType = 'Vpn' param name = 'nvgmin001' param vNetResourceId = '' -// Non-required parameters -param location = '' -param publicIpZones = [ - 1 - 2 - 3 -] -param skuName = 'VpnGw2AZ' ``` @@ -1314,7 +1249,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: 'dm-nvger' ] firstPipName: 'pip-nvger' - location: '' publicIpZones: [ 1 2 @@ -1361,9 +1295,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "firstPipName": { "value": "pip-nvger" }, - "location": { - "value": "" - }, "publicIpZones": { "value": [ 1, @@ -1400,7 +1331,6 @@ param domainNameLabel = [ 'dm-nvger' ] param firstPipName = 'pip-nvger' -param location = '' param publicIpZones = [ 1 2 @@ -1851,7 +1781,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: name: 'nvgnaz001' vNetResourceId: '' // Non-required parameters - location: '' publicIpZones: [] skuName: 'VpnGw1' } @@ -1886,9 +1815,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "value": "" }, // Non-required parameters - "location": { - "value": "" - }, "publicIpZones": { "value": [] }, @@ -1917,7 +1843,6 @@ param gatewayType = 'Vpn' param name = 'nvgnaz001' param vNetResourceId = '' // Non-required parameters -param location = '' param publicIpZones = [] param skuName = 'VpnGw1' ``` @@ -1954,7 +1879,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: enableBgpRouteTranslationForNat: true enablePrivateIpAddress: true gatewayDefaultSiteLocalNetworkGatewayId: '' - location: '' publicIpZones: [ 1 2 @@ -2015,9 +1939,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "gatewayDefaultSiteLocalNetworkGatewayId": { "value": "" }, - "location": { - "value": "" - }, "publicIpZones": { "value": [ 1, @@ -2064,7 +1985,6 @@ param domainNameLabel = [ param enableBgpRouteTranslationForNat = true param enablePrivateIpAddress = true param gatewayDefaultSiteLocalNetworkGatewayId = '' -param location = '' param publicIpZones = [ 1 2 @@ -2130,11 +2050,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: enableBgpRouteTranslationForNat: true enablePrivateIpAddress: true gatewayDefaultSiteLocalNetworkGatewayId: '' - location: '' - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } natRules: [ { externalMappings: [ @@ -2259,15 +2174,6 @@ module virtualNetworkGateway 'br/public:avm/res/network/virtual-network-gateway: "gatewayDefaultSiteLocalNetworkGatewayId": { "value": "" }, - "location": { - "value": "" - }, - "lock": { - "value": { - "kind": "CanNotDelete", - "name": "myCustomLockName" - } - }, "natRules": { "value": [ { @@ -2380,11 +2286,6 @@ param domainNameLabel = [ param enableBgpRouteTranslationForNat = true param enablePrivateIpAddress = true param gatewayDefaultSiteLocalNetworkGatewayId = '' -param location = '' -param lock = { - kind: 'CanNotDelete' - name: 'myCustomLockName' -} param natRules = [ { externalMappings: [ @@ -2446,7 +2347,6 @@ param vpnType = 'RouteBased' | [`clusterSettings`](#parameter-clustersettings) | object | Specifies one of the following four configurations: Active-Active with (clusterMode = activeActiveBgp) or without (clusterMode = activeActiveNoBgp) BGP, Active-Passive with (clusterMode = activePassiveBgp) or without (clusterMode = activePassiveNoBgp) BGP. | | [`gatewayType`](#parameter-gatewaytype) | string | Specifies the gateway type. E.g. VPN, ExpressRoute. | | [`name`](#parameter-name) | string | Specifies the Virtual Network Gateway name. | -| [`skuName`](#parameter-skuname) | string | The SKU of the Gateway. | | [`vNetResourceId`](#parameter-vnetresourceid) | string | Virtual Network resource ID. | **Optional parameters** @@ -2474,6 +2374,7 @@ param vpnType = 'RouteBased' | [`publicIPPrefixResourceId`](#parameter-publicipprefixresourceid) | string | Resource ID of the Public IP Prefix object. This is only needed if you want your Public IPs created in a PIP Prefix. | | [`publicIpZones`](#parameter-publicipzones) | array | Specifies the zones of the Public IP address. Basic IP SKU does not support Availability Zones. | | [`roleAssignments`](#parameter-roleassignments) | array | Array of role assignments to create. | +| [`skuName`](#parameter-skuname) | string | The SKU of the Gateway. | | [`tags`](#parameter-tags) | object | Tags of the resource. | | [`vpnClientAadConfiguration`](#parameter-vpnclientaadconfiguration) | object | Configuration for AAD Authentication for P2S Tunnel Type, Cannot be configured if clientRootCertData is provided. | | [`vpnClientAddressPoolPrefix`](#parameter-vpnclientaddresspoolprefix) | string | The IP address range from which VPN clients will receive an IP address when connected. Range specified must not overlap with on-premise network. | @@ -2492,16 +2393,22 @@ Specifies one of the following four configurations: Active-Active with (clusterM | Variant | Description | | :-- | :-- | -| [`activeActiveNoBgp`](#variant-clustersettingsclustermode-activeactivenobgp) | | -| [`activeActiveBgp`](#variant-clustersettingsclustermode-activeactivebgp) | | -| [`activePassiveBgp`](#variant-clustersettingsclustermode-activepassivebgp) | | -| [`activePassiveNoBgp`](#variant-clustersettingsclustermode-activepassivenobgp) | | +| [`activeActiveNoBgp`](#variant-clustersettingsclustermode-activeactivenobgp) | The type for an active-active no BGP configuration. | +| [`activeActiveBgp`](#variant-clustersettingsclustermode-activeactivebgp) | The type for an active-active BGP configuration. | +| [`activePassiveBgp`](#variant-clustersettingsclustermode-activepassivebgp) | The type for an active-passive BGP configuration. | +| [`activePassiveNoBgp`](#variant-clustersettingsclustermode-activepassivenobgp) | The type for an active-passive no BGP configuration. | ### Variant: `clusterSettings.clusterMode-activeActiveNoBgp` - +The type for an active-active no BGP configuration. To use this variant, set the property `clusterMode` to `activeActiveNoBgp`. +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`clusterMode`](#parameter-clustersettingsclustermode-activeactivenobgpclustermode) | string | The cluster mode deciding the configuration. | + **Optional parameters** | Parameter | Type | Description | @@ -2509,6 +2416,19 @@ To use this variant, set the property `clusterMode` to `activeActiveNoBgp`. | [`existingSecondPipResourceId`](#parameter-clustersettingsclustermode-activeactivenobgpexistingsecondpipresourceid) | string | The secondary Public IP resource ID to associate to the Virtual Network Gateway in the Active-Active mode. If empty, then a new secondary Public IP will be created as part of this module and applied to the Virtual Network Gateway. | | [`secondPipName`](#parameter-clustersettingsclustermode-activeactivenobgpsecondpipname) | string | Specifies the name of the secondary Public IP to be created for the Virtual Network Gateway in the Active-Active mode. This will only take effect if no existing secondary Public IP is provided. If neither an existing secondary Public IP nor this parameter is specified, a new secondary Public IP will be created with a default name, using the gateway's name with the '-pip2' suffix. | +### Parameter: `clusterSettings.clusterMode-activeActiveNoBgp.clusterMode` + +The cluster mode deciding the configuration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'activeActiveNoBgp' + ] + ``` + ### Parameter: `clusterSettings.clusterMode-activeActiveNoBgp.existingSecondPipResourceId` The secondary Public IP resource ID to associate to the Virtual Network Gateway in the Active-Active mode. If empty, then a new secondary Public IP will be created as part of this module and applied to the Virtual Network Gateway. @@ -2524,10 +2444,16 @@ Specifies the name of the secondary Public IP to be created for the Virtual Netw - Type: string ### Variant: `clusterSettings.clusterMode-activeActiveBgp` - +The type for an active-active BGP configuration. To use this variant, set the property `clusterMode` to `activeActiveBgp`. +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`clusterMode`](#parameter-clustersettingsclustermode-activeactivebgpclustermode) | string | The cluster mode deciding the configuration. | + **Optional parameters** | Parameter | Type | Description | @@ -2538,6 +2464,19 @@ To use this variant, set the property `clusterMode` to `activeActiveBgp`. | [`secondCustomBgpIpAddresses`](#parameter-clustersettingsclustermode-activeactivebgpsecondcustombgpipaddresses) | array | The list of the second custom BGP IP Address (APIPA) peering addresses which belong to IP configuration. | | [`secondPipName`](#parameter-clustersettingsclustermode-activeactivebgpsecondpipname) | string | Specifies the name of the secondary Public IP to be created for the Virtual Network Gateway in the Active-Active mode. This will only take effect if no existing secondary Public IP is provided. If neither an existing secondary Public IP nor this parameter is specified, a new secondary Public IP will be created with a default name, using the gateway's name with the '-pip2' suffix. | +### Parameter: `clusterSettings.clusterMode-activeActiveBgp.clusterMode` + +The cluster mode deciding the configuration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'activeActiveBgp' + ] + ``` + ### Parameter: `clusterSettings.clusterMode-activeActiveBgp.asn` The Autonomous System Number value. If it's not provided, a default '65515' value will be assigned to the ASN. @@ -2584,10 +2523,16 @@ Specifies the name of the secondary Public IP to be created for the Virtual Netw - MaxValue: 4294967295 ### Variant: `clusterSettings.clusterMode-activePassiveBgp` - +The type for an active-passive BGP configuration. To use this variant, set the property `clusterMode` to `activePassiveBgp`. +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`clusterMode`](#parameter-clustersettingsclustermode-activepassivebgpclustermode) | string | The cluster mode deciding the configuration. | + **Optional parameters** | Parameter | Type | Description | @@ -2595,6 +2540,19 @@ To use this variant, set the property `clusterMode` to `activePassiveBgp`. | [`asn`](#parameter-clustersettingsclustermode-activepassivebgpasn) | int | The Autonomous System Number value. If it's not provided, a default '65515' value will be assigned to the ASN. | | [`customBgpIpAddresses`](#parameter-clustersettingsclustermode-activepassivebgpcustombgpipaddresses) | array | The list of custom BGP IP Address (APIPA) peering addresses which belong to IP configuration. | +### Parameter: `clusterSettings.clusterMode-activePassiveBgp.clusterMode` + +The cluster mode deciding the configuration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'activePassiveBgp' + ] + ``` + ### Parameter: `clusterSettings.clusterMode-activePassiveBgp.asn` The Autonomous System Number value. If it's not provided, a default '65515' value will be assigned to the ASN. @@ -2614,10 +2572,29 @@ The list of custom BGP IP Address (APIPA) peering addresses which belong to IP c - MaxValue: 4294967295 ### Variant: `clusterSettings.clusterMode-activePassiveNoBgp` - +The type for an active-passive no BGP configuration. To use this variant, set the property `clusterMode` to `activePassiveNoBgp`. +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`clusterMode`](#parameter-clustersettingsclustermode-activepassivenobgpclustermode) | string | The cluster mode deciding the configuration. | + +### Parameter: `clusterSettings.clusterMode-activePassiveNoBgp.clusterMode` + +The cluster mode deciding the configuration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'activePassiveNoBgp' + ] + ``` + ### Parameter: `gatewayType` Specifies the gateway type. E.g. VPN, ExpressRoute. @@ -2639,36 +2616,6 @@ Specifies the Virtual Network Gateway name. - Required: Yes - Type: string -### Parameter: `skuName` - -The SKU of the Gateway. - -- Required: No -- Type: string -- Default: `[if(equals(parameters('gatewayType'), 'VPN'), 'VpnGw1AZ', 'ErGw1AZ')]` -- Allowed: - ```Bicep - [ - 'Basic' - 'ErGw1AZ' - 'ErGw2AZ' - 'ErGw3AZ' - 'HighPerformance' - 'Standard' - 'UltraPerformance' - 'VpnGw1' - 'VpnGw1AZ' - 'VpnGw2' - 'VpnGw2AZ' - 'VpnGw3' - 'VpnGw3AZ' - 'VpnGw4' - 'VpnGw4AZ' - 'VpnGw5' - 'VpnGw5AZ' - ] - ``` - ### Parameter: `vNetResourceId` Virtual Network resource ID. @@ -2725,7 +2672,7 @@ The diagnostic settings of the service. | [`logCategoriesAndGroups`](#parameter-diagnosticsettingslogcategoriesandgroups) | array | The name of logs that will be streamed. "allLogs" includes all possible logs for the resource. Set to `[]` to disable log collection. | | [`marketplacePartnerResourceId`](#parameter-diagnosticsettingsmarketplacepartnerresourceid) | string | The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs. | | [`metricCategories`](#parameter-diagnosticsettingsmetriccategories) | array | The name of metrics that will be streamed. "allMetrics" includes all possible metrics for the resource. Set to `[]` to disable metric collection. | -| [`name`](#parameter-diagnosticsettingsname) | string | The name of diagnostic setting. | +| [`name`](#parameter-diagnosticsettingsname) | string | The name of the diagnostic setting. | | [`storageAccountResourceId`](#parameter-diagnosticsettingsstorageaccountresourceid) | string | Resource ID of the diagnostic storage account. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub. | | [`workspaceResourceId`](#parameter-diagnosticsettingsworkspaceresourceid) | string | Resource ID of the diagnostic log analytics workspace. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub. | @@ -2835,7 +2782,7 @@ Enable or disable the category explicitly. Default is `true`. ### Parameter: `diagnosticSettings.name` -The name of diagnostic setting. +The name of the diagnostic setting. - Required: No - Type: string @@ -2995,7 +2942,7 @@ The diagnostic settings of the Public IP. | [`logCategoriesAndGroups`](#parameter-publicipdiagnosticsettingslogcategoriesandgroups) | array | The name of logs that will be streamed. "allLogs" includes all possible logs for the resource. Set to `[]` to disable log collection. | | [`marketplacePartnerResourceId`](#parameter-publicipdiagnosticsettingsmarketplacepartnerresourceid) | string | The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs. | | [`metricCategories`](#parameter-publicipdiagnosticsettingsmetriccategories) | array | The name of metrics that will be streamed. "allMetrics" includes all possible metrics for the resource. Set to `[]` to disable metric collection. | -| [`name`](#parameter-publicipdiagnosticsettingsname) | string | The name of diagnostic setting. | +| [`name`](#parameter-publicipdiagnosticsettingsname) | string | The name of the diagnostic setting. | | [`storageAccountResourceId`](#parameter-publicipdiagnosticsettingsstorageaccountresourceid) | string | Resource ID of the diagnostic storage account. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub. | | [`workspaceResourceId`](#parameter-publicipdiagnosticsettingsworkspaceresourceid) | string | Resource ID of the diagnostic log analytics workspace. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub. | @@ -3105,7 +3052,7 @@ Enable or disable the category explicitly. Default is `true`. ### Parameter: `publicIpDiagnosticSettings.name` -The name of diagnostic setting. +The name of the diagnostic setting. - Required: No - Type: string @@ -3251,6 +3198,36 @@ The principal type of the assigned principal ID. ] ``` +### Parameter: `skuName` + +The SKU of the Gateway. + +- Required: No +- Type: string +- Default: `[if(equals(parameters('gatewayType'), 'VPN'), 'VpnGw1AZ', 'ErGw1AZ')]` +- Allowed: + ```Bicep + [ + 'Basic' + 'ErGw1AZ' + 'ErGw2AZ' + 'ErGw3AZ' + 'HighPerformance' + 'Standard' + 'UltraPerformance' + 'VpnGw1' + 'VpnGw1AZ' + 'VpnGw2' + 'VpnGw2AZ' + 'VpnGw3' + 'VpnGw3AZ' + 'VpnGw4' + 'VpnGw4AZ' + 'VpnGw5' + 'VpnGw5AZ' + ] + ``` + ### Parameter: `tags` Tags of the resource. @@ -3322,6 +3299,7 @@ This section gives you an overview of all local-referenced module files (i.e., o | Reference | Type | | :-- | :-- | | `br/public:avm/res/network/public-ip-address:0.5.1` | Remote reference | +| `br/public:avm/utl/types/avm-common-types:0.5.1` | Remote reference | ## Data Collection diff --git a/avm/res/network/virtual-network-gateway/main.bicep b/avm/res/network/virtual-network-gateway/main.bicep index 50b856ea0e..81c1efba3c 100644 --- a/avm/res/network/virtual-network-gateway/main.bicep +++ b/avm/res/network/virtual-network-gateway/main.bicep @@ -42,7 +42,7 @@ param gatewayType string ]) param vpnGatewayGeneration string = 'None' -@description('Required. The SKU of the Gateway.') +@description('Optional. The SKU of the Gateway.') @allowed([ 'Basic' 'VpnGw1' @@ -110,17 +110,20 @@ param clientRootCertData string = '' @description('Optional. Thumbprint of the revoked certificate. This would revoke VPN client certificates matching this thumbprint from connecting to the VNet.') param clientRevokedCertThumbprint string = '' +import { diagnosticSettingFullType } from 'br/public:avm/utl/types/avm-common-types:0.5.1' @description('Optional. The diagnostic settings of the Public IP.') -param publicIpDiagnosticSettings diagnosticSettingType +param publicIpDiagnosticSettings diagnosticSettingFullType[]? @description('Optional. The diagnostic settings of the service.') -param diagnosticSettings diagnosticSettingType +param diagnosticSettings diagnosticSettingFullType[]? +import { roleAssignmentType } from 'br/public:avm/utl/types/avm-common-types:0.5.1' @description('Optional. Array of role assignments to create.') -param roleAssignments roleAssignmentType +param roleAssignments roleAssignmentType[]? +import { lockType } from 'br/public:avm/utl/types/avm-common-types:0.5.1' @description('Optional. The lock settings of the service.') -param lock lockType +param lock lockType? @description('Optional. Tags of the resource.') param tags object? @@ -152,18 +155,10 @@ var secondPipNameVar = isActiveActive ? (clusterSettings.?secondPipName ?? '${na var arrayPipNameVar = isActiveActive ? concat( - !empty(existingFirstPipResourceId) - ? [] - : [firstPipName], - !empty(existingSecondPipResourceIdVar) - ? [] - : [secondPipNameVar] - ) - : concat( - !empty(existingFirstPipResourceId) - ? [] - : [firstPipName] + !empty(existingFirstPipResourceId) ? [] : [firstPipName], + !empty(existingSecondPipResourceIdVar) ? [] : [secondPipNameVar] ) + : concat(!empty(existingFirstPipResourceId) ? [] : [firstPipName]) // Potential BGP configurations (Active-Active vs Active-Passive) var bgpSettingsVar = isActiveActive @@ -216,12 +211,12 @@ var ipConfiguration = isActiveActive } publicIPAddress: { id: isActiveActive - ? !empty(existingSecondPipResourceIdVar) - ? existingSecondPipResourceIdVar - : az.resourceId('Microsoft.Network/publicIPAddresses', secondPipNameVar) - : !empty(existingFirstPipResourceId) - ? existingFirstPipResourceId - : az.resourceId('Microsoft.Network/publicIPAddresses', firstPipName) + ? !empty(existingSecondPipResourceIdVar) + ? existingSecondPipResourceIdVar + : az.resourceId('Microsoft.Network/publicIPAddresses', secondPipNameVar) + : !empty(existingFirstPipResourceId) + ? existingFirstPipResourceId + : az.resourceId('Microsoft.Network/publicIPAddresses', firstPipName) } } name: 'vNetGatewayConfig2' @@ -407,11 +402,11 @@ module virtualNetworkGateway_natRules 'nat-rule/main.bicep' = [ params: { name: natRule.name virtualNetworkGatewayName: virtualNetworkGateway.name - externalMappings: natRule.?externalMappings ?? [] - internalMappings: natRule.?internalMappings ?? [] - ipConfigurationId: natRule.?ipConfigurationId ?? '' - mode: natRule.?mode ?? '' - type: natRule.?type ?? '' + externalMappings: natRule.?externalMappings + internalMappings: natRule.?internalMappings + ipConfigurationResourceId: natRule.?ipConfigurationResourceId + mode: natRule.?mode + type: natRule.?type } } ] @@ -498,104 +493,50 @@ output location string = virtualNetworkGateway.location // Definitions // // =============== // -type lockType = { - @description('Optional. Specify the name of lock.') - name: string? - - @description('Optional. Specify the type of lock.') - kind: ('CanNotDelete' | 'ReadOnly' | 'None')? -}? - -type roleAssignmentType = { - @description('Optional. The name (as GUID) of the role assignment. If not provided, a GUID will be generated.') - name: string? - - @description('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\'.') - roleDefinitionIdOrName: string - - @description('Required. The principal ID of the principal (user/group/identity) to assign the role to.') - principalId: string - - @description('Optional. The principal type of the assigned principal ID.') - principalType: ('ServicePrincipal' | 'Group' | 'User' | 'ForeignGroup' | 'Device')? - - @description('Optional. The description of the role assignment.') - description: string? - - @description('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".') - condition: string? - - @description('Optional. Version of the condition.') - conditionVersion: '2.0'? - - @description('Optional. The Resource Id of the delegated managed identity resource.') - delegatedManagedIdentityResourceId: string? -}[]? - -type diagnosticSettingType = { - @description('Optional. The name of diagnostic setting.') - name: string? - - @description('Optional. The name of logs that will be streamed. "allLogs" includes all possible logs for the resource. Set to `[]` to disable log collection.') - logCategoriesAndGroups: { - @description('Optional. Name of a Diagnostic Log category for a resource type this setting is applied to. Set the specific logs to collect here.') - category: string? +import { mappingType } from 'nat-rule/main.bicep' +@export() +@description('The type for a NAT rule.') +type natRuleType = { + @description('Required. The name of the NAT rule.') + name: string - @description('Optional. Name of a Diagnostic Log category group for a resource type this setting is applied to. Set to `allLogs` to collect all logs.') - categoryGroup: string? + @description('Optional. An address prefix range of destination IPs on the outside network that source IPs will be mapped to. In other words, your post-NAT address prefix range.') + externalMappings: mappingType[]? - @description('Optional. Enable or disable the category explicitly. Default is `true`.') - enabled: bool? - }[]? + @description('Optional. An address prefix range of source IPs on the inside network that will be mapped to a set of external IPs. In other words, your pre-NAT address prefix range.') + internalMappings: mappingType[]? - @description('Optional. The name of metrics that will be streamed. "allMetrics" includes all possible metrics for the resource. Set to `[]` to disable metric collection.') - metricCategories: { - @description('Required. Name of a Diagnostic Metric category for a resource type this setting is applied to. Set to `AllMetrics` to collect all metrics.') - category: string + @description('Optional. A NAT rule must be configured to a specific Virtual Network Gateway instance. This is applicable to Dynamic NAT only. Static NAT rules are automatically applied to both Virtual Network Gateway instances.') + ipConfigurationResourceId: string? - @description('Optional. Enable or disable the category explicitly. Default is `true`.') - enabled: bool? - }[]? + @description('Optional. The type of NAT rule for Virtual Network NAT. IngressSnat mode (also known as Ingress Source NAT) is applicable to traffic entering the Azure hub\'s site-to-site Virtual Network gateway. EgressSnat mode (also known as Egress Source NAT) is applicable to traffic leaving the Azure hub\'s Site-to-site Virtual Network gateway.') + mode: ('EgressSnat' | 'IngressSnat')? - @description('Optional. A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type.') - logAnalyticsDestinationType: ('Dedicated' | 'AzureDiagnostics')? - - @description('Optional. Resource ID of the diagnostic log analytics workspace. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub.') - workspaceResourceId: string? - - @description('Optional. Resource ID of the diagnostic storage account. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub.') - storageAccountResourceId: string? - - @description('Optional. Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to.') - eventHubAuthorizationRuleResourceId: string? - - @description('Optional. Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub.') - eventHubName: string? - - @description('Optional. The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.') - marketplacePartnerResourceId: string? -}[]? + @description('Optional. The type of NAT rule for Virtual Network NAT. Static one-to-one NAT establishes a one-to-one relationship between an internal address and an external address while Dynamic NAT assigns an IP and port based on availability.') + type: ('Dynamic' | 'Static')? +} +@description('The type for an active-passive no BGP configuration.') type activePassiveNoBgpType = { - + @description('Required. The cluster mode deciding the configuration.') clusterMode: 'activePassiveNoBgp' - } +@description('The type for an active-active no BGP configuration.') type activeActiveNoBgpType = { - + @description('Required. The cluster mode deciding the configuration.') clusterMode: 'activeActiveNoBgp' @description('Optional. The secondary Public IP resource ID to associate to the Virtual Network Gateway in the Active-Active mode. If empty, then a new secondary Public IP will be created as part of this module and applied to the Virtual Network Gateway.') existingSecondPipResourceId: string? - + @description('Optional. Specifies the name of the secondary Public IP to be created for the Virtual Network Gateway in the Active-Active mode. This will only take effect if no existing secondary Public IP is provided. If neither an existing secondary Public IP nor this parameter is specified, a new secondary Public IP will be created with a default name, using the gateway\'s name with the \'-pip2\' suffix.') secondPipName: string? - } +@description('The type for an active-passive BGP configuration.') type activePassiveBgpType = { - + @description('Required. The cluster mode deciding the configuration.') clusterMode: 'activePassiveBgp' @description('Optional. The Autonomous System Number value. If it\'s not provided, a default \'65515\' value will be assigned to the ASN.') @@ -607,16 +548,17 @@ type activePassiveBgpType = { customBgpIpAddresses: string[]? } +@description('The type for an active-active BGP configuration.') type activeActiveBgpType = { - + @description('Required. The cluster mode deciding the configuration.') clusterMode: 'activeActiveBgp' @description('Optional. The secondary Public IP resource ID to associate to the Virtual Network Gateway in the Active-Active mode. If empty, then a new secondary Public IP will be created as part of this module and applied to the Virtual Network Gateway.') existingSecondPipResourceId: string? - + @description('Optional. Specifies the name of the secondary Public IP to be created for the Virtual Network Gateway in the Active-Active mode. This will only take effect if no existing secondary Public IP is provided. If neither an existing secondary Public IP nor this parameter is specified, a new secondary Public IP will be created with a default name, using the gateway\'s name with the \'-pip2\' suffix.') secondPipName: string? - + @description('Optional. The Autonomous System Number value. If it\'s not provided, a default \'65515\' value will be assigned to the ASN.') @minValue(0) @maxValue(4294967295) @@ -624,9 +566,11 @@ type activeActiveBgpType = { @description('Optional. The list of custom BGP IP Address (APIPA) peering addresses which belong to IP configuration.') customBgpIpAddresses: string[]? + @description('Optional. The list of the second custom BGP IP Address (APIPA) peering addresses which belong to IP configuration.') secondCustomBgpIpAddresses: string[]? } +@export() @discriminator('clusterMode') type clusterSettingType = activeActiveNoBgpType | activeActiveBgpType | activePassiveBgpType | activePassiveNoBgpType diff --git a/avm/res/network/virtual-network-gateway/main.json b/avm/res/network/virtual-network-gateway/main.json index 8ea98d578e..234017efde 100644 --- a/avm/res/network/virtual-network-gateway/main.json +++ b/avm/res/network/virtual-network-gateway/main.json @@ -6,230 +6,76 @@ "_generator": { "name": "bicep", "version": "0.32.4.45862", - "templateHash": "1701161903666745494" + "templateHash": "17536710159061514896" }, "name": "Virtual Network Gateways", "description": "This module deploys a Virtual Network Gateway.", "owner": "Azure/module-maintainers" }, "definitions": { - "lockType": { + "natRuleType": { "type": "object", "properties": { "name": { "type": "string", + "metadata": { + "description": "Required. The name of the NAT rule." + } + }, + "externalMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/mappingType" + }, "nullable": true, "metadata": { - "description": "Optional. Specify the name of lock." + "description": "Optional. An address prefix range of destination IPs on the outside network that source IPs will be mapped to. In other words, your post-NAT address prefix range." } }, - "kind": { + "internalMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/mappingType" + }, + "nullable": true, + "metadata": { + "description": "Optional. An address prefix range of source IPs on the inside network that will be mapped to a set of external IPs. In other words, your pre-NAT address prefix range." + } + }, + "ipConfigurationResourceId": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. A NAT rule must be configured to a specific Virtual Network Gateway instance. This is applicable to Dynamic NAT only. Static NAT rules are automatically applied to both Virtual Network Gateway instances." + } + }, + "mode": { "type": "string", "allowedValues": [ - "CanNotDelete", - "None", - "ReadOnly" + "EgressSnat", + "IngressSnat" ], "nullable": true, "metadata": { - "description": "Optional. Specify the type of lock." - } - } - }, - "nullable": true - }, - "roleAssignmentType": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. The name (as GUID) of the role assignment. If not provided, a GUID will be generated." - } - }, - "roleDefinitionIdOrName": { - "type": "string", - "metadata": { - "description": "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'." - } - }, - "principalId": { - "type": "string", - "metadata": { - "description": "Required. The principal ID of the principal (user/group/identity) to assign the role to." - } - }, - "principalType": { - "type": "string", - "allowedValues": [ - "Device", - "ForeignGroup", - "Group", - "ServicePrincipal", - "User" - ], - "nullable": true, - "metadata": { - "description": "Optional. The principal type of the assigned principal ID." - } - }, - "description": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. The description of the role assignment." - } - }, - "condition": { - "type": "string", - "nullable": true, - "metadata": { - "description": "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": { - "type": "string", - "allowedValues": [ - "2.0" - ], - "nullable": true, - "metadata": { - "description": "Optional. Version of the condition." - } - }, - "delegatedManagedIdentityResourceId": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. The Resource Id of the delegated managed identity resource." - } + "description": "Optional. The type of NAT rule for Virtual Network NAT. IngressSnat mode (also known as Ingress Source NAT) is applicable to traffic entering the Azure hub's site-to-site Virtual Network gateway. EgressSnat mode (also known as Egress Source NAT) is applicable to traffic leaving the Azure hub's Site-to-site Virtual Network gateway." } - } - }, - "nullable": true - }, - "diagnosticSettingType": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. The name of diagnostic setting." - } - }, - "logCategoriesAndGroups": { - "type": "array", - "items": { - "type": "object", - "properties": { - "category": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. Name of a Diagnostic Log category for a resource type this setting is applied to. Set the specific logs to collect here." - } - }, - "categoryGroup": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. Name of a Diagnostic Log category group for a resource type this setting is applied to. Set to `allLogs` to collect all logs." - } - }, - "enabled": { - "type": "bool", - "nullable": true, - "metadata": { - "description": "Optional. Enable or disable the category explicitly. Default is `true`." - } - } - } - }, - "nullable": true, - "metadata": { - "description": "Optional. The name of logs that will be streamed. \"allLogs\" includes all possible logs for the resource. Set to `[]` to disable log collection." - } - }, - "metricCategories": { - "type": "array", - "items": { - "type": "object", - "properties": { - "category": { - "type": "string", - "metadata": { - "description": "Required. Name of a Diagnostic Metric category for a resource type this setting is applied to. Set to `AllMetrics` to collect all metrics." - } - }, - "enabled": { - "type": "bool", - "nullable": true, - "metadata": { - "description": "Optional. Enable or disable the category explicitly. Default is `true`." - } - } - } - }, - "nullable": true, - "metadata": { - "description": "Optional. The name of metrics that will be streamed. \"allMetrics\" includes all possible metrics for the resource. Set to `[]` to disable metric collection." - } - }, - "logAnalyticsDestinationType": { - "type": "string", - "allowedValues": [ - "AzureDiagnostics", - "Dedicated" - ], - "nullable": true, - "metadata": { - "description": "Optional. A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type." - } - }, - "workspaceResourceId": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. Resource ID of the diagnostic log analytics workspace. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub." - } - }, - "storageAccountResourceId": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. Resource ID of the diagnostic storage account. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub." - } - }, - "eventHubAuthorizationRuleResourceId": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to." - } - }, - "eventHubName": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub." - } - }, - "marketplacePartnerResourceId": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs." - } + }, + "type": { + "type": "string", + "allowedValues": [ + "Dynamic", + "Static" + ], + "nullable": true, + "metadata": { + "description": "Optional. The type of NAT rule for Virtual Network NAT. Static one-to-one NAT establishes a one-to-one relationship between an internal address and an external address while Dynamic NAT assigns an IP and port based on availability." } } }, - "nullable": true + "metadata": { + "__bicep_export!": true, + "description": "The type for a NAT rule." + } }, "activePassiveNoBgpType": { "type": "object", @@ -238,8 +84,14 @@ "type": "string", "allowedValues": [ "activePassiveNoBgp" - ] + ], + "metadata": { + "description": "Required. The cluster mode deciding the configuration." + } } + }, + "metadata": { + "description": "The type for an active-passive no BGP configuration." } }, "activeActiveNoBgpType": { @@ -249,7 +101,10 @@ "type": "string", "allowedValues": [ "activeActiveNoBgp" - ] + ], + "metadata": { + "description": "Required. The cluster mode deciding the configuration." + } }, "existingSecondPipResourceId": { "type": "string", @@ -265,6 +120,9 @@ "description": "Optional. Specifies the name of the secondary Public IP to be created for the Virtual Network Gateway in the Active-Active mode. This will only take effect if no existing secondary Public IP is provided. If neither an existing secondary Public IP nor this parameter is specified, a new secondary Public IP will be created with a default name, using the gateway's name with the '-pip2' suffix." } } + }, + "metadata": { + "description": "The type for an active-active no BGP configuration." } }, "activePassiveBgpType": { @@ -274,7 +132,10 @@ "type": "string", "allowedValues": [ "activePassiveBgp" - ] + ], + "metadata": { + "description": "Required. The cluster mode deciding the configuration." + } }, "asn": { "type": "int", @@ -295,6 +156,9 @@ "description": "Optional. The list of custom BGP IP Address (APIPA) peering addresses which belong to IP configuration." } } + }, + "metadata": { + "description": "The type for an active-passive BGP configuration." } }, "activeActiveBgpType": { @@ -304,7 +168,10 @@ "type": "string", "allowedValues": [ "activeActiveBgp" - ] + ], + "metadata": { + "description": "Required. The cluster mode deciding the configuration." + } }, "existingSecondPipResourceId": { "type": "string", @@ -349,6 +216,9 @@ "description": "Optional. The list of the second custom BGP IP Address (APIPA) peering addresses which belong to IP configuration." } } + }, + "metadata": { + "description": "The type for an active-active BGP configuration." } }, "clusterSettingType": { @@ -369,6 +239,260 @@ "$ref": "#/definitions/activePassiveNoBgpType" } } + }, + "metadata": { + "__bicep_export!": true + } + }, + "diagnosticSettingFullType": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. The name of the diagnostic setting." + } + }, + "logCategoriesAndGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. Name of a Diagnostic Log category for a resource type this setting is applied to. Set the specific logs to collect here." + } + }, + "categoryGroup": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. Name of a Diagnostic Log category group for a resource type this setting is applied to. Set to `allLogs` to collect all logs." + } + }, + "enabled": { + "type": "bool", + "nullable": true, + "metadata": { + "description": "Optional. Enable or disable the category explicitly. Default is `true`." + } + } + } + }, + "nullable": true, + "metadata": { + "description": "Optional. The name of logs that will be streamed. \"allLogs\" includes all possible logs for the resource. Set to `[]` to disable log collection." + } + }, + "metricCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "metadata": { + "description": "Required. Name of a Diagnostic Metric category for a resource type this setting is applied to. Set to `AllMetrics` to collect all metrics." + } + }, + "enabled": { + "type": "bool", + "nullable": true, + "metadata": { + "description": "Optional. Enable or disable the category explicitly. Default is `true`." + } + } + } + }, + "nullable": true, + "metadata": { + "description": "Optional. The name of metrics that will be streamed. \"allMetrics\" includes all possible metrics for the resource. Set to `[]` to disable metric collection." + } + }, + "logAnalyticsDestinationType": { + "type": "string", + "allowedValues": [ + "AzureDiagnostics", + "Dedicated" + ], + "nullable": true, + "metadata": { + "description": "Optional. A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type." + } + }, + "workspaceResourceId": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. Resource ID of the diagnostic log analytics workspace. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub." + } + }, + "storageAccountResourceId": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. Resource ID of the diagnostic storage account. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub." + } + }, + "eventHubAuthorizationRuleResourceId": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to." + } + }, + "eventHubName": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. For security reasons, it is recommended to set diagnostic settings to send data to either storage account, log analytics workspace or event hub." + } + }, + "marketplacePartnerResourceId": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs." + } + } + }, + "metadata": { + "description": "An AVM-aligned type for a diagnostic setting. To be used if both logs & metrics are supported by the resource provider.", + "__bicep_imported_from!": { + "sourceTemplate": "br:mcr.microsoft.com/bicep/avm/utl/types/avm-common-types:0.5.1" + } + } + }, + "lockType": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. Specify the name of lock." + } + }, + "kind": { + "type": "string", + "allowedValues": [ + "CanNotDelete", + "None", + "ReadOnly" + ], + "nullable": true, + "metadata": { + "description": "Optional. Specify the type of lock." + } + } + }, + "metadata": { + "description": "An AVM-aligned type for a lock.", + "__bicep_imported_from!": { + "sourceTemplate": "br:mcr.microsoft.com/bicep/avm/utl/types/avm-common-types:0.5.1" + } + } + }, + "mappingType": { + "type": "object", + "properties": { + "addressSpace": { + "type": "string", + "metadata": { + "description": "Required. Address space for Vpn NatRule mapping." + } + }, + "portRange": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. Port range for Vpn NatRule mapping." + } + } + }, + "metadata": { + "description": "The type for a mapping.", + "__bicep_imported_from!": { + "sourceTemplate": "nat-rule/main.bicep" + } + } + }, + "roleAssignmentType": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. The name (as GUID) of the role assignment. If not provided, a GUID will be generated." + } + }, + "roleDefinitionIdOrName": { + "type": "string", + "metadata": { + "description": "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'." + } + }, + "principalId": { + "type": "string", + "metadata": { + "description": "Required. The principal ID of the principal (user/group/identity) to assign the role to." + } + }, + "principalType": { + "type": "string", + "allowedValues": [ + "Device", + "ForeignGroup", + "Group", + "ServicePrincipal", + "User" + ], + "nullable": true, + "metadata": { + "description": "Optional. The principal type of the assigned principal ID." + } + }, + "description": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. The description of the role assignment." + } + }, + "condition": { + "type": "string", + "nullable": true, + "metadata": { + "description": "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": { + "type": "string", + "allowedValues": [ + "2.0" + ], + "nullable": true, + "metadata": { + "description": "Optional. Version of the condition." + } + }, + "delegatedManagedIdentityResourceId": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. The Resource Id of the delegated managed identity resource." + } + } + }, + "metadata": { + "description": "An AVM-aligned type for a role assignment.", + "__bicep_imported_from!": { + "sourceTemplate": "br:mcr.microsoft.com/bicep/avm/utl/types/avm-common-types:0.5.1" + } } } }, @@ -470,7 +594,7 @@ "ErGw3AZ" ], "metadata": { - "description": "Required. The SKU of the Gateway." + "description": "Optional. The SKU of the Gateway." } }, "vpnType": { @@ -574,25 +698,38 @@ } }, "publicIpDiagnosticSettings": { - "$ref": "#/definitions/diagnosticSettingType", + "type": "array", + "items": { + "$ref": "#/definitions/diagnosticSettingFullType" + }, + "nullable": true, "metadata": { "description": "Optional. The diagnostic settings of the Public IP." } }, "diagnosticSettings": { - "$ref": "#/definitions/diagnosticSettingType", + "type": "array", + "items": { + "$ref": "#/definitions/diagnosticSettingFullType" + }, + "nullable": true, "metadata": { "description": "Optional. The diagnostic settings of the service." } }, "roleAssignments": { - "$ref": "#/definitions/roleAssignmentType", + "type": "array", + "items": { + "$ref": "#/definitions/roleAssignmentType" + }, + "nullable": true, "metadata": { "description": "Optional. Array of role assignments to create." } }, "lock": { "$ref": "#/definitions/lockType", + "nullable": true, "metadata": { "description": "Optional. The lock settings of the service." } @@ -1461,34 +1598,59 @@ "value": "[parameters('name')]" }, "externalMappings": { - "value": "[coalesce(tryGet(parameters('natRules')[copyIndex()], 'externalMappings'), createArray())]" + "value": "[tryGet(parameters('natRules')[copyIndex()], 'externalMappings')]" }, "internalMappings": { - "value": "[coalesce(tryGet(parameters('natRules')[copyIndex()], 'internalMappings'), createArray())]" + "value": "[tryGet(parameters('natRules')[copyIndex()], 'internalMappings')]" }, - "ipConfigurationId": { - "value": "[coalesce(tryGet(parameters('natRules')[copyIndex()], 'ipConfigurationId'), '')]" + "ipConfigurationResourceId": { + "value": "[tryGet(parameters('natRules')[copyIndex()], 'ipConfigurationResourceId')]" }, "mode": { - "value": "[coalesce(tryGet(parameters('natRules')[copyIndex()], 'mode'), '')]" + "value": "[tryGet(parameters('natRules')[copyIndex()], 'mode')]" }, "type": { - "value": "[coalesce(tryGet(parameters('natRules')[copyIndex()], 'type'), '')]" + "value": "[tryGet(parameters('natRules')[copyIndex()], 'type')]" } }, "template": { "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", + "languageVersion": "2.0", "contentVersion": "1.0.0.0", "metadata": { "_generator": { "name": "bicep", "version": "0.32.4.45862", - "templateHash": "2235037112727909278" + "templateHash": "18080488621270812680" }, "name": "VPN Gateway NAT Rules", "description": "This module deploys a Virtual Network Gateway NAT Rule.", "owner": "Azure/module-maintainers" }, + "definitions": { + "mappingType": { + "type": "object", + "properties": { + "addressSpace": { + "type": "string", + "metadata": { + "description": "Required. Address space for Vpn NatRule mapping." + } + }, + "portRange": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. Port range for Vpn NatRule mapping." + } + } + }, + "metadata": { + "__bicep_export!": true, + "description": "The type for a mapping." + } + } + }, "parameters": { "name": { "type": "string", @@ -1504,30 +1666,35 @@ }, "externalMappings": { "type": "array", - "defaultValue": [], + "items": { + "$ref": "#/definitions/mappingType" + }, + "nullable": true, "metadata": { "description": "Optional. An address prefix range of destination IPs on the outside network that source IPs will be mapped to. In other words, your post-NAT address prefix range." } }, "internalMappings": { "type": "array", - "defaultValue": [], + "items": { + "$ref": "#/definitions/mappingType" + }, + "nullable": true, "metadata": { "description": "Optional. An address prefix range of source IPs on the inside network that will be mapped to a set of external IPs. In other words, your pre-NAT address prefix range." } }, - "ipConfigurationId": { + "ipConfigurationResourceId": { "type": "string", - "defaultValue": "", + "nullable": true, "metadata": { "description": "Optional. A NAT rule must be configured to a specific Virtual Network Gateway instance. This is applicable to Dynamic NAT only. Static NAT rules are automatically applied to both Virtual Network Gateway instances." } }, "mode": { "type": "string", - "defaultValue": "", + "nullable": true, "allowedValues": [ - "", "EgressSnat", "IngressSnat" ], @@ -1537,9 +1704,8 @@ }, "type": { "type": "string", - "defaultValue": "", + "nullable": true, "allowedValues": [ - "", "Dynamic", "Static" ], @@ -1548,20 +1714,26 @@ } } }, - "resources": [ - { + "resources": { + "virtualNetworkGateway": { + "existing": true, + "type": "Microsoft.Network/virtualNetworkGateways", + "apiVersion": "2023-04-01", + "name": "[parameters('virtualNetworkGatewayName')]" + }, + "natRule": { "type": "Microsoft.Network/virtualNetworkGateways/natRules", "apiVersion": "2023-04-01", "name": "[format('{0}/{1}', parameters('virtualNetworkGatewayName'), parameters('name'))]", "properties": { "externalMappings": "[parameters('externalMappings')]", "internalMappings": "[parameters('internalMappings')]", - "ipConfigurationId": "[if(not(empty(parameters('ipConfigurationId'))), parameters('ipConfigurationId'), null())]", - "mode": "[if(not(empty(parameters('mode'))), parameters('mode'), null())]", - "type": "[if(not(empty(parameters('type'))), parameters('type'), null())]" + "ipConfigurationId": "[parameters('ipConfigurationResourceId')]", + "mode": "[parameters('mode')]", + "type": "[parameters('type')]" } } - ], + }, "outputs": { "name": { "type": "string", diff --git a/avm/res/network/virtual-network-gateway/nat-rule/README.md b/avm/res/network/virtual-network-gateway/nat-rule/README.md index 4a3987328b..c9ecd7e0a7 100644 --- a/avm/res/network/virtual-network-gateway/nat-rule/README.md +++ b/avm/res/network/virtual-network-gateway/nat-rule/README.md @@ -34,7 +34,7 @@ This module deploys a Virtual Network Gateway NAT Rule. | :-- | :-- | :-- | | [`externalMappings`](#parameter-externalmappings) | array | An address prefix range of destination IPs on the outside network that source IPs will be mapped to. In other words, your post-NAT address prefix range. | | [`internalMappings`](#parameter-internalmappings) | array | An address prefix range of source IPs on the inside network that will be mapped to a set of external IPs. In other words, your pre-NAT address prefix range. | -| [`ipConfigurationId`](#parameter-ipconfigurationid) | string | A NAT rule must be configured to a specific Virtual Network Gateway instance. This is applicable to Dynamic NAT only. Static NAT rules are automatically applied to both Virtual Network Gateway instances. | +| [`ipConfigurationResourceId`](#parameter-ipconfigurationresourceid) | string | A NAT rule must be configured to a specific Virtual Network Gateway instance. This is applicable to Dynamic NAT only. Static NAT rules are automatically applied to both Virtual Network Gateway instances. | | [`mode`](#parameter-mode) | string | The type of NAT rule for Virtual Network NAT. IngressSnat mode (also known as Ingress Source NAT) is applicable to traffic entering the Azure hub's site-to-site Virtual Network gateway. EgressSnat mode (also known as Egress Source NAT) is applicable to traffic leaving the Azure hub's Site-to-site Virtual Network gateway. | | [`type`](#parameter-type) | string | The type of NAT rule for Virtual Network NAT. Static one-to-one NAT establishes a one-to-one relationship between an internal address and an external address while Dynamic NAT assigns an IP and port based on availability. | @@ -58,7 +58,32 @@ An address prefix range of destination IPs on the outside network that source IP - Required: No - Type: array -- Default: `[]` + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`addressSpace`](#parameter-externalmappingsaddressspace) | string | Address space for Vpn NatRule mapping. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`portRange`](#parameter-externalmappingsportrange) | string | Port range for Vpn NatRule mapping. | + +### Parameter: `externalMappings.addressSpace` + +Address space for Vpn NatRule mapping. + +- Required: Yes +- Type: string + +### Parameter: `externalMappings.portRange` + +Port range for Vpn NatRule mapping. + +- Required: No +- Type: string ### Parameter: `internalMappings` @@ -66,15 +91,39 @@ An address prefix range of source IPs on the inside network that will be mapped - Required: No - Type: array -- Default: `[]` -### Parameter: `ipConfigurationId` +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`addressSpace`](#parameter-internalmappingsaddressspace) | string | Address space for Vpn NatRule mapping. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`portRange`](#parameter-internalmappingsportrange) | string | Port range for Vpn NatRule mapping. | + +### Parameter: `internalMappings.addressSpace` + +Address space for Vpn NatRule mapping. + +- Required: Yes +- Type: string + +### Parameter: `internalMappings.portRange` + +Port range for Vpn NatRule mapping. + +- Required: No +- Type: string + +### Parameter: `ipConfigurationResourceId` A NAT rule must be configured to a specific Virtual Network Gateway instance. This is applicable to Dynamic NAT only. Static NAT rules are automatically applied to both Virtual Network Gateway instances. - Required: No - Type: string -- Default: `''` ### Parameter: `mode` @@ -82,11 +131,9 @@ The type of NAT rule for Virtual Network NAT. IngressSnat mode (also known as In - Required: No - Type: string -- Default: `''` - Allowed: ```Bicep [ - '' 'EgressSnat' 'IngressSnat' ] @@ -98,11 +145,9 @@ The type of NAT rule for Virtual Network NAT. Static one-to-one NAT establishes - Required: No - Type: string -- Default: `''` - Allowed: ```Bicep [ - '' 'Dynamic' 'Static' ] diff --git a/avm/res/network/virtual-network-gateway/nat-rule/main.bicep b/avm/res/network/virtual-network-gateway/nat-rule/main.bicep index 5134050345..e0d4511a42 100644 --- a/avm/res/network/virtual-network-gateway/nat-rule/main.bicep +++ b/avm/res/network/virtual-network-gateway/nat-rule/main.bicep @@ -9,29 +9,27 @@ param name string param virtualNetworkGatewayName string @description('Optional. An address prefix range of destination IPs on the outside network that source IPs will be mapped to. In other words, your post-NAT address prefix range.') -param externalMappings array = [] +param externalMappings mappingType[]? @description('Optional. An address prefix range of source IPs on the inside network that will be mapped to a set of external IPs. In other words, your pre-NAT address prefix range.') -param internalMappings array = [] +param internalMappings mappingType[]? @description('Optional. A NAT rule must be configured to a specific Virtual Network Gateway instance. This is applicable to Dynamic NAT only. Static NAT rules are automatically applied to both Virtual Network Gateway instances.') -param ipConfigurationId string = '' +param ipConfigurationResourceId string? @description('Optional. The type of NAT rule for Virtual Network NAT. IngressSnat mode (also known as Ingress Source NAT) is applicable to traffic entering the Azure hub\'s site-to-site Virtual Network gateway. EgressSnat mode (also known as Egress Source NAT) is applicable to traffic leaving the Azure hub\'s Site-to-site Virtual Network gateway.') @allowed([ - '' 'EgressSnat' 'IngressSnat' ]) -param mode string = '' +param mode string? @description('Optional. The type of NAT rule for Virtual Network NAT. Static one-to-one NAT establishes a one-to-one relationship between an internal address and an external address while Dynamic NAT assigns an IP and port based on availability.') @allowed([ - '' 'Dynamic' 'Static' ]) -param type string = '' +param type string? resource virtualNetworkGateway 'Microsoft.Network/virtualNetworkGateways@2023-04-01' existing = { name: virtualNetworkGatewayName @@ -43,9 +41,9 @@ resource natRule 'Microsoft.Network/virtualNetworkGateways/natRules@2023-04-01' properties: { externalMappings: externalMappings internalMappings: internalMappings - ipConfigurationId: !empty(ipConfigurationId) ? ipConfigurationId : null - mode: !empty(mode) ? any(mode) : null - type: !empty(type) ? any(type) : null + ipConfigurationId: ipConfigurationResourceId + mode: mode + type: type } } @@ -57,3 +55,17 @@ output resourceId string = natRule.id @description('The name of the resource group the NAT rule was deployed into.') output resourceGroupName string = resourceGroup().name + +// =============== // +// Definitions // +// =============== // + +@export() +@description('The type for a mapping.') +type mappingType = { + @description('Required. Address space for Vpn NatRule mapping.') + addressSpace: string + + @description('Optional. Port range for Vpn NatRule mapping.') + portRange: string? +} diff --git a/avm/res/network/virtual-network-gateway/nat-rule/main.json b/avm/res/network/virtual-network-gateway/nat-rule/main.json index 78feb63338..05e5b60425 100644 --- a/avm/res/network/virtual-network-gateway/nat-rule/main.json +++ b/avm/res/network/virtual-network-gateway/nat-rule/main.json @@ -1,16 +1,41 @@ { "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", + "languageVersion": "2.0", "contentVersion": "1.0.0.0", "metadata": { "_generator": { "name": "bicep", "version": "0.32.4.45862", - "templateHash": "2235037112727909278" + "templateHash": "18080488621270812680" }, "name": "VPN Gateway NAT Rules", "description": "This module deploys a Virtual Network Gateway NAT Rule.", "owner": "Azure/module-maintainers" }, + "definitions": { + "mappingType": { + "type": "object", + "properties": { + "addressSpace": { + "type": "string", + "metadata": { + "description": "Required. Address space for Vpn NatRule mapping." + } + }, + "portRange": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. Port range for Vpn NatRule mapping." + } + } + }, + "metadata": { + "__bicep_export!": true, + "description": "The type for a mapping." + } + } + }, "parameters": { "name": { "type": "string", @@ -26,30 +51,35 @@ }, "externalMappings": { "type": "array", - "defaultValue": [], + "items": { + "$ref": "#/definitions/mappingType" + }, + "nullable": true, "metadata": { "description": "Optional. An address prefix range of destination IPs on the outside network that source IPs will be mapped to. In other words, your post-NAT address prefix range." } }, "internalMappings": { "type": "array", - "defaultValue": [], + "items": { + "$ref": "#/definitions/mappingType" + }, + "nullable": true, "metadata": { "description": "Optional. An address prefix range of source IPs on the inside network that will be mapped to a set of external IPs. In other words, your pre-NAT address prefix range." } }, - "ipConfigurationId": { + "ipConfigurationResourceId": { "type": "string", - "defaultValue": "", + "nullable": true, "metadata": { "description": "Optional. A NAT rule must be configured to a specific Virtual Network Gateway instance. This is applicable to Dynamic NAT only. Static NAT rules are automatically applied to both Virtual Network Gateway instances." } }, "mode": { "type": "string", - "defaultValue": "", + "nullable": true, "allowedValues": [ - "", "EgressSnat", "IngressSnat" ], @@ -59,9 +89,8 @@ }, "type": { "type": "string", - "defaultValue": "", + "nullable": true, "allowedValues": [ - "", "Dynamic", "Static" ], @@ -70,20 +99,26 @@ } } }, - "resources": [ - { + "resources": { + "virtualNetworkGateway": { + "existing": true, + "type": "Microsoft.Network/virtualNetworkGateways", + "apiVersion": "2023-04-01", + "name": "[parameters('virtualNetworkGatewayName')]" + }, + "natRule": { "type": "Microsoft.Network/virtualNetworkGateways/natRules", "apiVersion": "2023-04-01", "name": "[format('{0}/{1}', parameters('virtualNetworkGatewayName'), parameters('name'))]", "properties": { "externalMappings": "[parameters('externalMappings')]", "internalMappings": "[parameters('internalMappings')]", - "ipConfigurationId": "[if(not(empty(parameters('ipConfigurationId'))), parameters('ipConfigurationId'), null())]", - "mode": "[if(not(empty(parameters('mode'))), parameters('mode'), null())]", - "type": "[if(not(empty(parameters('type'))), parameters('type'), null())]" + "ipConfigurationId": "[parameters('ipConfigurationResourceId')]", + "mode": "[parameters('mode')]", + "type": "[parameters('type')]" } } - ], + }, "outputs": { "name": { "type": "string", diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveBGP/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveBGP/main.test.bicep index 6270baf598..603738bc1d 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveBGP/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveBGP/main.test.bicep @@ -51,7 +51,6 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' vpnGatewayGeneration: 'Generation2' skuName: 'VpnGw2AZ' @@ -76,8 +75,5 @@ module testDeployment '../../../main.bicep' = [ allowRemoteVnetTraffic: true enableBgpRouteTranslationForNat: true } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveBgpAPIPA/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveBgpAPIPA/main.test.bicep index 16fe844184..5f9a9aadda 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveBgpAPIPA/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveBgpAPIPA/main.test.bicep @@ -51,7 +51,6 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' vpnGatewayGeneration: 'Generation2' skuName: 'VpnGw2AZ' @@ -59,8 +58,8 @@ module testDeployment '../../../main.bicep' = [ vNetResourceId: nestedDependencies.outputs.vnetResourceId clusterSettings: { clusterMode: 'activeActiveBgp' - customBgpIpAddresses: ['169.254.21.4','169.254.21.5'] - secondCustomBgpIpAddresses: ['169.254.22.4','169.254.22.5'] + customBgpIpAddresses: ['169.254.21.4', '169.254.21.5'] + secondCustomBgpIpAddresses: ['169.254.22.4', '169.254.22.5'] } domainNameLabel: [ @@ -78,8 +77,5 @@ module testDeployment '../../../main.bicep' = [ allowRemoteVnetTraffic: true enableBgpRouteTranslationForNat: true } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveExistingPip/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveExistingPip/main.test.bicep index 5a0f74ba0b..39dcb4d2a3 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveExistingPip/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveExistingPip/main.test.bicep @@ -53,14 +53,13 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' vpnGatewayGeneration: 'Generation2' skuName: 'VpnGw2AZ' gatewayType: 'Vpn' vNetResourceId: nestedDependencies.outputs.vnetResourceId existingFirstPipResourceId: nestedDependencies.outputs.existingFirstPipResourceId - + clusterSettings: { clusterMode: 'activeActiveNoBgp' existingSecondPipResourceId: nestedDependencies.outputs.existingSecondPipResourceId @@ -81,8 +80,5 @@ module testDeployment '../../../main.bicep' = [ allowRemoteVnetTraffic: true enableBgpRouteTranslationForNat: true } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveNoBGP/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveNoBGP/main.test.bicep index 7d799c5c2c..ff8d537cb7 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveNoBGP/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/activeActiveNoBGP/main.test.bicep @@ -51,7 +51,6 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' vpnGatewayGeneration: 'Generation2' skuName: 'VpnGw2AZ' @@ -76,8 +75,5 @@ module testDeployment '../../../main.bicep' = [ allowRemoteVnetTraffic: true enableBgpRouteTranslationForNat: true } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveBGP/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveBGP/main.test.bicep index 1aa9da7c34..bc0b27642d 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveBGP/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveBGP/main.test.bicep @@ -51,17 +51,16 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' vpnGatewayGeneration: 'Generation2' skuName: 'VpnGw2AZ' gatewayType: 'Vpn' vNetResourceId: nestedDependencies.outputs.vnetResourceId clusterSettings: { - clusterMode:'activePassiveBgp' - customBgpIpAddresses: ['169.254.21.4','169.254.21.5'] + clusterMode: 'activePassiveBgp' + customBgpIpAddresses: ['169.254.21.4', '169.254.21.5'] asn: 65815 - } + } domainNameLabel: [ '${namePrefix}-dm-${serviceShort}' @@ -78,8 +77,5 @@ module testDeployment '../../../main.bicep' = [ allowRemoteVnetTraffic: true enableBgpRouteTranslationForNat: true } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveExistingPip/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveExistingPip/main.test.bicep index 27c179eef4..156cde5e6d 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveExistingPip/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveExistingPip/main.test.bicep @@ -52,7 +52,6 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' vpnGatewayGeneration: 'Generation2' skuName: 'VpnGw2AZ' @@ -60,10 +59,10 @@ module testDeployment '../../../main.bicep' = [ vNetResourceId: nestedDependencies.outputs.vnetResourceId existingFirstPipResourceId: nestedDependencies.outputs.existingFirstPipResourceId clusterSettings: { - clusterMode:'activePassiveBgp' - customBgpIpAddresses: ['169.254.21.4','169.254.21.5'] + clusterMode: 'activePassiveBgp' + customBgpIpAddresses: ['169.254.21.4', '169.254.21.5'] asn: 65815 - } + } domainNameLabel: [ '${namePrefix}-dm-${serviceShort}' @@ -80,8 +79,5 @@ module testDeployment '../../../main.bicep' = [ allowRemoteVnetTraffic: true enableBgpRouteTranslationForNat: true } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveNoBGP/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveNoBGP/main.test.bicep index ee3904f4b8..7c90deb90f 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveNoBGP/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/activePassiveNoBGP/main.test.bicep @@ -51,15 +51,14 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' vpnGatewayGeneration: 'Generation2' skuName: 'VpnGw2AZ' gatewayType: 'Vpn' vNetResourceId: nestedDependencies.outputs.vnetResourceId clusterSettings: { - clusterMode:'activePassiveNoBgp' - } + clusterMode: 'activePassiveNoBgp' + } domainNameLabel: [ '${namePrefix}-dm-${serviceShort}' @@ -76,8 +75,5 @@ module testDeployment '../../../main.bicep' = [ allowRemoteVnetTraffic: true enableBgpRouteTranslationForNat: true } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/defaults/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/defaults/main.test.bicep index 06f382ecb5..6d0574fc9a 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/defaults/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/defaults/main.test.bicep @@ -52,22 +52,12 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' - skuName: 'VpnGw2AZ' gatewayType: 'Vpn' vNetResourceId: nestedDependencies.outputs.vnetResourceId - publicIpZones: [ - 1 - 2 - 3 - ] clusterSettings: { - clusterMode:'activeActiveNoBgp' + clusterMode: 'activeActiveNoBgp' } } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/expressRoute/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/expressRoute/main.test.bicep index 1e1790c927..ec85da5661 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/expressRoute/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/expressRoute/main.test.bicep @@ -50,12 +50,11 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' skuName: 'ErGw1AZ' gatewayType: 'ExpressRoute' vNetResourceId: nestedDependencies.outputs.vnetResourceId - clusterSettings:{ + clusterSettings: { clusterMode: 'activePassiveBgp' } domainNameLabel: [ @@ -68,8 +67,5 @@ module testDeployment '../../../main.bicep' = [ 3 ] } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/max/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/max/main.test.bicep index 8ea291f857..2a40a88027 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/max/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/max/main.test.bicep @@ -172,9 +172,5 @@ module testDeployment '../../../main.bicep' = [ ] enableBgpRouteTranslationForNat: true } - dependsOn: [ - nestedDependencies - diagnosticDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/vpn-no-az/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/vpn-no-az/main.test.bicep index fc3410af52..7f9e7d17be 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/vpn-no-az/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/vpn-no-az/main.test.bicep @@ -52,7 +52,6 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' skuName: 'VpnGw1' gatewayType: 'Vpn' @@ -62,8 +61,5 @@ module testDeployment '../../../main.bicep' = [ clusterMode: 'activePassiveNoBgp' } } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/vpn/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/vpn/main.test.bicep index 4258c36c8a..e1b2795392 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/vpn/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/vpn/main.test.bicep @@ -51,13 +51,12 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' vpnGatewayGeneration: 'Generation2' skuName: 'VpnGw2AZ' gatewayType: 'Vpn' vNetResourceId: nestedDependencies.outputs.vnetResourceId - clusterSettings:{ + clusterSettings: { clusterMode: 'activeActiveNoBgp' } domainNameLabel: [ @@ -75,8 +74,5 @@ module testDeployment '../../../main.bicep' = [ allowRemoteVnetTraffic: true enableBgpRouteTranslationForNat: true } - dependsOn: [ - nestedDependencies - ] } ] diff --git a/avm/res/network/virtual-network-gateway/tests/e2e/waf-aligned/main.test.bicep b/avm/res/network/virtual-network-gateway/tests/e2e/waf-aligned/main.test.bicep index 7b3e651866..c465d28884 100644 --- a/avm/res/network/virtual-network-gateway/tests/e2e/waf-aligned/main.test.bicep +++ b/avm/res/network/virtual-network-gateway/tests/e2e/waf-aligned/main.test.bicep @@ -64,7 +64,6 @@ module testDeployment '../../../main.bicep' = [ scope: resourceGroup name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { - location: resourceLocation name: '${namePrefix}${serviceShort}001' vpnGatewayGeneration: 'Generation2' skuName: 'VpnGw2AZ' @@ -93,10 +92,6 @@ module testDeployment '../../../main.bicep' = [ domainNameLabel: [ '${namePrefix}-dm-${serviceShort}' ] - lock: { - kind: 'CanNotDelete' - name: 'myCustomLockName' - } publicIpZones: [ 1 2 @@ -148,9 +143,5 @@ module testDeployment '../../../main.bicep' = [ ] enableBgpRouteTranslationForNat: true } - dependsOn: [ - nestedDependencies - diagnosticDependencies - ] } ] From 5cadd3f7069cc570eb1c8fe358c08aab777a9be0 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Tue, 14 Jan 2025 21:27:37 +0100 Subject: [PATCH 33/43] Update to latest --- avm/res/network/virtual-network-gateway/version.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/avm/res/network/virtual-network-gateway/version.json b/avm/res/network/virtual-network-gateway/version.json index ea4f3b6e67..21226dd43f 100644 --- a/avm/res/network/virtual-network-gateway/version.json +++ b/avm/res/network/virtual-network-gateway/version.json @@ -1,6 +1,6 @@ { "$schema": "https://aka.ms/bicep-registry-module-version-file-schema#", - "version": "0.5", + "version": "0.6", "pathFilters": [ "./main.json" ] From 7f4e4c341a695a0836772cd88448a4097eebeae8 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Tue, 14 Jan 2025 21:44:55 +0100 Subject: [PATCH 34/43] Update to latest --- avm/res/insights/metric-alert/README.md | 128 ++++++++-- avm/res/insights/metric-alert/main.bicep | 70 +++--- avm/res/insights/metric-alert/main.json | 218 +++++++++++------- .../tests/e2e/defaults/main.test.bicep | 1 - .../tests/e2e/waf-aligned/main.test.bicep | 1 - 5 files changed, 277 insertions(+), 141 deletions(-) diff --git a/avm/res/insights/metric-alert/README.md b/avm/res/insights/metric-alert/README.md index 329901dcb7..efe541e217 100644 --- a/avm/res/insights/metric-alert/README.md +++ b/avm/res/insights/metric-alert/README.md @@ -8,6 +8,7 @@ This module deploys a Metric Alert. - [Usage examples](#Usage-examples) - [Parameters](#Parameters) - [Outputs](#Outputs) +- [Cross-referenced modules](#Cross-referenced-modules) - [Data Collection](#Data-Collection) ## Resource Types @@ -59,7 +60,6 @@ module metricAlert 'br/public:avm/res/insights/metric-alert:' = { } name: 'imamin001' // Non-required parameters - location: 'Global' scopes: [ '' ] @@ -100,9 +100,6 @@ module metricAlert 'br/public:avm/res/insights/metric-alert:' = { "value": "imamin001" }, // Non-required parameters - "location": { - "value": "Global" - }, "scopes": { "value": [ "" @@ -139,7 +136,6 @@ param criteria = { } param name = 'imamin001' // Non-required parameters -param location = 'Global' param scopes = [ '' ] @@ -384,7 +380,6 @@ module metricAlert 'br/public:avm/res/insights/metric-alert:' = { '' ] evaluationFrequency: 'PT5M' - location: 'global' scopes: [ '' '' @@ -432,9 +427,6 @@ module metricAlert 'br/public:avm/res/insights/metric-alert:' = { "evaluationFrequency": { "value": "PT5M" }, - "location": { - "value": "global" - }, "scopes": { "value": [ "", @@ -478,7 +470,6 @@ param actions = [ '' ] param evaluationFrequency = 'PT5M' -param location = 'global' param scopes = [ '' '' @@ -539,25 +530,122 @@ Maps to the 'odata.type' field. Specifies the type of the alert criteria. | Variant | Description | | :-- | :-- | -| [`Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria`](#variant-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteria) | | -| [`Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria`](#variant-criteriaodatatype-microsoftazuremonitorsingleresourcemultiplemetriccriteria) | | -| [`Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria`](#variant-criteriaodatatype-microsoftazuremonitormultipleresourcemultiplemetriccriteria) | | +| [`Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria`](#variant-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteria) | The alert type for a web test scenario. | +| [`Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria`](#variant-criteriaodatatype-microsoftazuremonitorsingleresourcemultiplemetriccriteria) | The alert type for a single resource scenario. | +| [`Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria`](#variant-criteriaodatatype-microsoftazuremonitormultipleresourcemultiplemetriccriteria) | The alert type for multiple resources scenario. | ### Variant: `criteria.odata.type-Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria` - +The alert type for a web test scenario. To use this variant, set the property `odata.type` to `Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria`. -### Variant: `criteria.odata.type-Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria` +**Required parameters** +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`componentResourceId`](#parameter-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteriacomponentresourceid) | string | The Application Insights resource Id. | +| [`failedLocationCount`](#parameter-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteriafailedlocationcount) | int | The number of failed locations. | +| [`odata.type`](#parameter-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteriaodatatype) | string | The type of the alert criteria. | +| [`webTestResourceId`](#parameter-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteriawebtestresourceid) | string | The Application Insights web test resource Id. | + +### Parameter: `criteria.odata.type-Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria.componentResourceId` + +The Application Insights resource Id. + +- Required: Yes +- Type: string + +### Parameter: `criteria.odata.type-Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria.failedLocationCount` + +The number of failed locations. + +- Required: Yes +- Type: int + +### Parameter: `criteria.odata.type-Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria.odata.type` + +The type of the alert criteria. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + 'odata.type': [ + 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' + ] + ``` + +### Parameter: `criteria.odata.type-Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria.webTestResourceId` + +The Application Insights web test resource Id. + +- Required: Yes +- Type: string + +### Variant: `criteria.odata.type-Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria` +The alert type for a single resource scenario. To use this variant, set the property `odata.type` to `Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria`. -### Variant: `criteria.odata.type-Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria` +**Required parameters** +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`allof`](#parameter-criteriaodatatype-microsoftazuremonitorsingleresourcemultiplemetriccriteriaallof) | array | The list of metric criteria for this 'all of' operation. | +| [`odata.type`](#parameter-criteriaodatatype-microsoftazuremonitorsingleresourcemultiplemetriccriteriaodatatype) | string | The type of the alert criteria. | + +### Parameter: `criteria.odata.type-Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria.allof` + +The list of metric criteria for this 'all of' operation. + +- Required: Yes +- Type: array + +### Parameter: `criteria.odata.type-Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria.odata.type` + +The type of the alert criteria. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + 'odata.type': [ + 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' + ] + ``` + +### Variant: `criteria.odata.type-Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria` +The alert type for multiple resources scenario. To use this variant, set the property `odata.type` to `Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria`. +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`allof`](#parameter-criteriaodatatype-microsoftazuremonitormultipleresourcemultiplemetriccriteriaallof) | array | The list of multiple metric criteria for this 'all of' operation. | +| [`odata.type`](#parameter-criteriaodatatype-microsoftazuremonitormultipleresourcemultiplemetriccriteriaodatatype) | string | The type of the alert criteria. | + +### Parameter: `criteria.odata.type-Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria.allof` + +The list of multiple metric criteria for this 'all of' operation. + +- Required: Yes +- Type: array + +### Parameter: `criteria.odata.type-Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria.odata.type` + +The type of the alert criteria. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + 'odata.type': [ + 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' + ] + ``` + ### Parameter: `name` The name of the alert. @@ -816,6 +904,14 @@ the period of time (in ISO 8601 duration format) that is used to monitor alert a | `resourceGroupName` | string | The resource group the metric alert was deployed into. | | `resourceId` | string | The resource ID of the metric alert. | +## Cross-referenced modules + +This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs). + +| Reference | Type | +| :-- | :-- | +| `br/public:avm/utl/types/avm-common-types:0.5.1` | Remote reference | + ## Data Collection The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the [repository](https://aka.ms/avm/telemetry). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at . You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. diff --git a/avm/res/insights/metric-alert/main.bicep b/avm/res/insights/metric-alert/main.bicep index 43027a01fb..b7d0ec5bd8 100644 --- a/avm/res/insights/metric-alert/main.bicep +++ b/avm/res/insights/metric-alert/main.bicep @@ -67,8 +67,9 @@ param actions array = [] @description('Required. Maps to the \'odata.type\' field. Specifies the type of the alert criteria.') param criteria alertType +import { roleAssignmentType } from 'br/public:avm/utl/types/avm-common-types:0.5.1' @description('Optional. Array of role assignments to create.') -param roleAssignments roleAssignmentType +param roleAssignments roleAssignmentType[]? @description('Optional. Tags of the resource.') param tags object? @@ -140,15 +141,13 @@ resource metricAlert 'Microsoft.Insights/metricAlerts@2018-03-01' = { windowSize: windowSize targetResourceType: targetResourceType targetResourceRegion: targetResourceRegion - criteria: union( - { - 'odata.type': criteria['odata.type'] - }, - (contains(criteria, 'allof') ? { allof: criteria.allof } : {}), - (contains(criteria, 'componentResourceId') ? { componentId: criteria.componentResourceId } : {}), - (contains(criteria, 'failedLocationCount') ? { failedLocationCount: criteria.failedLocationCount } : {}), - (contains(criteria, 'webTestResourceId') ? { webTestId: criteria.webTestResourceId } : {}) - ) + criteria: { + 'odata.type': criteria['odata.type'] + ...(contains(criteria, 'allof') ? { allof: criteria.allof } : {}) + ...(contains(criteria, 'componentResourceId') ? { componentId: criteria.componentResourceId } : {}) + ...(contains(criteria, 'failedLocationCount') ? { failedLocationCount: criteria.failedLocationCount } : {}) + ...(contains(criteria, 'webTestResourceId') ? { webTestId: criteria.webTestResourceId } : {}) + } autoMitigate: autoMitigate actions: actionGroups } @@ -181,49 +180,44 @@ output resourceId string = metricAlert.id @description('The location the resource was deployed into.') output location string = metricAlert.location + // =============== // // Definitions // // =============== // -type roleAssignmentType = { - @description('Optional. The name (as GUID) of the role assignment. If not provided, a GUID will be generated.') - name: string? - - @description('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\'.') - roleDefinitionIdOrName: string - - @description('Required. The principal ID of the principal (user/group/identity) to assign the role to.') - principalId: string - - @description('Optional. The principal type of the assigned principal ID.') - principalType: ('ServicePrincipal' | 'Group' | 'User' | 'ForeignGroup' | 'Device')? - - @description('Optional. The description of the role assignment.') - description: string? - - @description('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".') - condition: string? - - @description('Optional. Version of the condition.') - conditionVersion: '2.0'? - - @description('Optional. The Resource Id of the delegated managed identity resource.') - delegatedManagedIdentityResourceId: string? -}[]? - +@export() @discriminator('odata.type') type alertType = alertWebtestType | alertResourceType | alertMultiResourceType + +@description('The alert type for a single resource scenario.') type alertResourceType = { + @description('Required. The type of the alert criteria.') 'odata.type': 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' - allof: array + + @description('Required. The list of metric criteria for this \'all of\' operation.') + allof: object[] } + +@description('The alert type for multiple resources scenario.') type alertMultiResourceType = { + @description('Required. The type of the alert criteria.') 'odata.type': 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' - allof: array + + @description('Required. The list of multiple metric criteria for this \'all of\' operation.') + allof: object[] } + +@description('The alert type for a web test scenario.') type alertWebtestType = { + @description('Required. The type of the alert criteria.') 'odata.type': 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' + + @description('Required. The Application Insights resource Id.') componentResourceId: string + + @description('Required. The number of failed locations.') failedLocationCount: int + + @description('Required. The Application Insights web test resource Id.') webTestResourceId: string } diff --git a/avm/res/insights/metric-alert/main.json b/avm/res/insights/metric-alert/main.json index ed68723cfc..0feb5a4e30 100644 --- a/avm/res/insights/metric-alert/main.json +++ b/avm/res/insights/metric-alert/main.json @@ -5,87 +5,14 @@ "metadata": { "_generator": { "name": "bicep", - "version": "0.29.47.4906", - "templateHash": "4451159667263078094" + "version": "0.32.4.45862", + "templateHash": "6522555779360038003" }, "name": "Metric Alerts", "description": "This module deploys a Metric Alert.", "owner": "Azure/module-maintainers" }, "definitions": { - "roleAssignmentType": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. The name (as GUID) of the role assignment. If not provided, a GUID will be generated." - } - }, - "roleDefinitionIdOrName": { - "type": "string", - "metadata": { - "description": "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'." - } - }, - "principalId": { - "type": "string", - "metadata": { - "description": "Required. The principal ID of the principal (user/group/identity) to assign the role to." - } - }, - "principalType": { - "type": "string", - "allowedValues": [ - "Device", - "ForeignGroup", - "Group", - "ServicePrincipal", - "User" - ], - "nullable": true, - "metadata": { - "description": "Optional. The principal type of the assigned principal ID." - } - }, - "description": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. The description of the role assignment." - } - }, - "condition": { - "type": "string", - "nullable": true, - "metadata": { - "description": "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": { - "type": "string", - "allowedValues": [ - "2.0" - ], - "nullable": true, - "metadata": { - "description": "Optional. Version of the condition." - } - }, - "delegatedManagedIdentityResourceId": { - "type": "string", - "nullable": true, - "metadata": { - "description": "Optional. The Resource Id of the delegated managed identity resource." - } - } - } - }, - "nullable": true - }, "alertType": { "type": "object", "discriminator": { @@ -101,6 +28,9 @@ "$ref": "#/definitions/alertMultiResourceType" } } + }, + "metadata": { + "__bicep_export!": true } }, "alertResourceType": { @@ -110,11 +40,23 @@ "type": "string", "allowedValues": [ "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" - ] + ], + "metadata": { + "description": "Required. The type of the alert criteria." + } }, "allof": { - "type": "array" + "type": "array", + "items": { + "type": "object" + }, + "metadata": { + "description": "Required. The list of metric criteria for this 'all of' operation." + } } + }, + "metadata": { + "description": "The alert type for a single resource scenario." } }, "alertMultiResourceType": { @@ -124,11 +66,23 @@ "type": "string", "allowedValues": [ "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" - ] + ], + "metadata": { + "description": "Required. The type of the alert criteria." + } }, "allof": { - "type": "array" + "type": "array", + "items": { + "type": "object" + }, + "metadata": { + "description": "Required. The list of multiple metric criteria for this 'all of' operation." + } } + }, + "metadata": { + "description": "The alert type for multiple resources scenario." } }, "alertWebtestType": { @@ -138,16 +92,106 @@ "type": "string", "allowedValues": [ "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" - ] + ], + "metadata": { + "description": "Required. The type of the alert criteria." + } }, "componentResourceId": { - "type": "string" + "type": "string", + "metadata": { + "description": "Required. The Application Insights resource Id." + } }, "failedLocationCount": { - "type": "int" + "type": "int", + "metadata": { + "description": "Required. The number of failed locations." + } }, "webTestResourceId": { - "type": "string" + "type": "string", + "metadata": { + "description": "Required. The Application Insights web test resource Id." + } + } + }, + "metadata": { + "description": "The alert type for a web test scenario." + } + }, + "roleAssignmentType": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. The name (as GUID) of the role assignment. If not provided, a GUID will be generated." + } + }, + "roleDefinitionIdOrName": { + "type": "string", + "metadata": { + "description": "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'." + } + }, + "principalId": { + "type": "string", + "metadata": { + "description": "Required. The principal ID of the principal (user/group/identity) to assign the role to." + } + }, + "principalType": { + "type": "string", + "allowedValues": [ + "Device", + "ForeignGroup", + "Group", + "ServicePrincipal", + "User" + ], + "nullable": true, + "metadata": { + "description": "Optional. The principal type of the assigned principal ID." + } + }, + "description": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. The description of the role assignment." + } + }, + "condition": { + "type": "string", + "nullable": true, + "metadata": { + "description": "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": { + "type": "string", + "allowedValues": [ + "2.0" + ], + "nullable": true, + "metadata": { + "description": "Optional. Version of the condition." + } + }, + "delegatedManagedIdentityResourceId": { + "type": "string", + "nullable": true, + "metadata": { + "description": "Optional. The Resource Id of the delegated managed identity resource." + } + } + }, + "metadata": { + "description": "An AVM-aligned type for a role assignment.", + "__bicep_imported_from!": { + "sourceTemplate": "br:mcr.microsoft.com/bicep/avm/utl/types/avm-common-types:0.5.1" } } } @@ -269,7 +313,11 @@ } }, "roleAssignments": { - "$ref": "#/definitions/roleAssignmentType", + "type": "array", + "items": { + "$ref": "#/definitions/roleAssignmentType" + }, + "nullable": true, "metadata": { "description": "Optional. Array of role assignments to create." } @@ -349,7 +397,7 @@ "windowSize": "[parameters('windowSize')]", "targetResourceType": "[parameters('targetResourceType')]", "targetResourceRegion": "[parameters('targetResourceRegion')]", - "criteria": "[union(createObject('odata.type', parameters('criteria')['odata.type']), if(contains(parameters('criteria'), 'allof'), createObject('allof', parameters('criteria').allof), createObject()), if(contains(parameters('criteria'), 'componentResourceId'), createObject('componentId', parameters('criteria').componentResourceId), createObject()), if(contains(parameters('criteria'), 'failedLocationCount'), createObject('failedLocationCount', parameters('criteria').failedLocationCount), createObject()), if(contains(parameters('criteria'), 'webTestResourceId'), createObject('webTestId', parameters('criteria').webTestResourceId), createObject()))]", + "criteria": "[shallowMerge(createArray(createObject('odata.type', parameters('criteria')['odata.type']), if(contains(parameters('criteria'), 'allof'), createObject('allof', parameters('criteria').allof), createObject()), if(contains(parameters('criteria'), 'componentResourceId'), createObject('componentId', parameters('criteria').componentResourceId), createObject()), if(contains(parameters('criteria'), 'failedLocationCount'), createObject('failedLocationCount', parameters('criteria').failedLocationCount), createObject()), if(contains(parameters('criteria'), 'webTestResourceId'), createObject('webTestId', parameters('criteria').webTestResourceId), createObject())))]", "autoMitigate": "[parameters('autoMitigate')]", "actions": "[variables('actionGroups')]" } diff --git a/avm/res/insights/metric-alert/tests/e2e/defaults/main.test.bicep b/avm/res/insights/metric-alert/tests/e2e/defaults/main.test.bicep index d3ed8b3f3c..178a80a0f4 100644 --- a/avm/res/insights/metric-alert/tests/e2e/defaults/main.test.bicep +++ b/avm/res/insights/metric-alert/tests/e2e/defaults/main.test.bicep @@ -52,7 +52,6 @@ module testDeployment '../../../main.bicep' = [ name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { name: '${namePrefix}${serviceShort}001' - location: 'Global' criteria: { allof: [ { diff --git a/avm/res/insights/metric-alert/tests/e2e/waf-aligned/main.test.bicep b/avm/res/insights/metric-alert/tests/e2e/waf-aligned/main.test.bicep index f656e6f105..d30631f54f 100644 --- a/avm/res/insights/metric-alert/tests/e2e/waf-aligned/main.test.bicep +++ b/avm/res/insights/metric-alert/tests/e2e/waf-aligned/main.test.bicep @@ -52,7 +52,6 @@ module testDeployment '../../../main.bicep' = [ name: '${uniqueString(deployment().name, resourceLocation)}-test-${serviceShort}-${iteration}' params: { name: '${namePrefix}${serviceShort}001' - location: 'global' scopes: [ nestedDependencies.outputs.pingTestResourceId nestedDependencies.outputs.appInsightsResourceId From d38d771f756226fb12214bd13fc6d5afeaeebb9f Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Tue, 14 Jan 2025 21:49:30 +0100 Subject: [PATCH 35/43] Update to latest --- avm/res/network/virtual-network-gateway/main.bicep | 2 +- avm/res/network/virtual-network-gateway/main.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/avm/res/network/virtual-network-gateway/main.bicep b/avm/res/network/virtual-network-gateway/main.bicep index 81c1efba3c..377fc82524 100644 --- a/avm/res/network/virtual-network-gateway/main.bicep +++ b/avm/res/network/virtual-network-gateway/main.bicep @@ -62,7 +62,7 @@ param vpnGatewayGeneration string = 'None' 'ErGw2AZ' 'ErGw3AZ' ]) -param skuName string = (gatewayType == 'VPN') ? 'VpnGw1AZ' : 'ErGw1AZ' +param skuName string = (gatewayType == 'Vpn') ? 'VpnGw1AZ' : 'ErGw1AZ' @description('Optional. Specifies the VPN type.') @allowed([ diff --git a/avm/res/network/virtual-network-gateway/main.json b/avm/res/network/virtual-network-gateway/main.json index 234017efde..d0f2622e2c 100644 --- a/avm/res/network/virtual-network-gateway/main.json +++ b/avm/res/network/virtual-network-gateway/main.json @@ -573,7 +573,7 @@ }, "skuName": { "type": "string", - "defaultValue": "[if(equals(parameters('gatewayType'), 'VPN'), 'VpnGw1AZ', 'ErGw1AZ')]", + "defaultValue": "[if(equals(parameters('gatewayType'), 'Vpn'), 'VpnGw1AZ', 'ErGw1AZ')]", "allowedValues": [ "Basic", "VpnGw1", From 715b25938af29a876daf0265a175d5805d496819 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Tue, 14 Jan 2025 21:56:13 +0100 Subject: [PATCH 36/43] Update to latest --- avm/res/network/virtual-network-gateway/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/avm/res/network/virtual-network-gateway/README.md b/avm/res/network/virtual-network-gateway/README.md index 12792e023c..c373dd5d2c 100644 --- a/avm/res/network/virtual-network-gateway/README.md +++ b/avm/res/network/virtual-network-gateway/README.md @@ -3204,7 +3204,7 @@ The SKU of the Gateway. - Required: No - Type: string -- Default: `[if(equals(parameters('gatewayType'), 'VPN'), 'VpnGw1AZ', 'ErGw1AZ')]` +- Default: `[if(equals(parameters('gatewayType'), 'Vpn'), 'VpnGw1AZ', 'ErGw1AZ')]` - Allowed: ```Bicep [ From aa138e128c7c67c883089fbd8a1bdf3582485c77 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Fri, 7 Mar 2025 18:51:50 +0100 Subject: [PATCH 37/43] Fixed bug regarding max & min values --- .../operational-insights/workspace/README.md | 242 ------------------ .../sharedScripts/Set-ModuleReadMe.ps1 | 9 +- 2 files changed, 7 insertions(+), 244 deletions(-) diff --git a/avm/res/operational-insights/workspace/README.md b/avm/res/operational-insights/workspace/README.md index 1d86fc74b0..6fef3968e0 100644 --- a/avm/res/operational-insights/workspace/README.md +++ b/avm/res/operational-insights/workspace/README.md @@ -2650,7 +2650,6 @@ LAW data export instances to be deployed. - Required: No - Type: array -- MinValue: -1 **Required parameters** @@ -2672,7 +2671,6 @@ Name of the data export. - Required: Yes - Type: string -- MinValue: -1 ### Parameter: `dataExports.tableNames` @@ -2680,7 +2678,6 @@ The list of table names to export. - Required: Yes - Type: array -- MinValue: -1 ### Parameter: `dataExports.destination` @@ -2688,7 +2685,6 @@ The destination of the data export. - Required: No - Type: object -- MinValue: -1 **Required parameters** @@ -2708,7 +2704,6 @@ The destination resource ID. - Required: Yes - Type: string -- MinValue: -1 ### Parameter: `dataExports.destination.metaData` @@ -2716,7 +2711,6 @@ The destination metadata. - Required: No - Type: object -- MinValue: -1 **Optional parameters** @@ -2730,7 +2724,6 @@ Allows to define an Event Hub name. Not applicable when destination is Storage A - Required: No - Type: string -- MinValue: -1 ### Parameter: `dataExports.enable` @@ -2738,7 +2731,6 @@ Enable or disable the data export. - Required: No - Type: bool -- MinValue: -1 ### Parameter: `dataRetention` @@ -2756,8 +2748,6 @@ LAW data sources to configure. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 **Required parameters** @@ -2789,8 +2779,6 @@ The kind of data source. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.name` @@ -2798,8 +2786,6 @@ Name of the data source. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.counterName` @@ -2807,8 +2793,6 @@ Counter name to configure when kind is WindowsPerformanceCounter. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.eventLogName` @@ -2816,8 +2800,6 @@ The name of the event log to configure when kind is WindowsEvent. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.eventTypes` @@ -2825,8 +2807,6 @@ The event types to configure when kind is WindowsEvent. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.instanceName` @@ -2834,8 +2814,6 @@ Name of the instance to configure when kind is WindowsPerformanceCounter or Linu - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.intervalSeconds` @@ -2843,8 +2821,6 @@ Interval in seconds to configure when kind is WindowsPerformanceCounter or Linux - Required: No - Type: int -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.linkedResourceId` @@ -2852,8 +2828,6 @@ The resource id of the resource that will be linked to the workspace. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.objectName` @@ -2861,8 +2835,6 @@ Name of the object to configure when kind is WindowsPerformanceCounter or LinuxP - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.performanceCounters` @@ -2870,8 +2842,6 @@ List of counters to configure when the kind is LinuxPerformanceObject. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.state` @@ -2879,8 +2849,6 @@ State to configure when kind is IISLogs or LinuxSyslogCollection or LinuxPerform - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.syslogName` @@ -2888,8 +2856,6 @@ System log to configure when kind is LinuxSyslog. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.syslogSeverities` @@ -2897,8 +2863,6 @@ Severities to configure when kind is LinuxSyslog. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dataSources.tags` @@ -2906,8 +2870,6 @@ Tags to configure in the resource. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings` @@ -2915,8 +2877,6 @@ The diagnostic settings of the service. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 **Optional parameters** @@ -2939,8 +2899,6 @@ Resource ID of the diagnostic event hub authorization rule for the Event Hubs na - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.eventHubName` @@ -2948,8 +2906,6 @@ Name of the diagnostic event hub within the namespace to which logs are streamed - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.logAnalyticsDestinationType` @@ -2964,8 +2920,6 @@ A string indicating whether the export to Log Analytics should use the default d 'Dedicated' ] ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.logCategoriesAndGroups` @@ -2973,8 +2927,6 @@ The name of logs that will be streamed. "allLogs" includes all possible logs for - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 **Optional parameters** @@ -2990,8 +2942,6 @@ Name of a Diagnostic Log category for a resource type this setting is applied to - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.categoryGroup` @@ -2999,8 +2949,6 @@ Name of a Diagnostic Log category group for a resource type this setting is appl - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.enabled` @@ -3008,8 +2956,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.marketplacePartnerResourceId` @@ -3017,8 +2963,6 @@ The full ARM resource ID of the Marketplace resource to which you would like to - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.metricCategories` @@ -3026,8 +2970,6 @@ The name of metrics that will be streamed. "allMetrics" includes all possible me - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 **Required parameters** @@ -3047,8 +2989,6 @@ Name of a Diagnostic Metric category for a resource type this setting is applied - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.metricCategories.enabled` @@ -3056,8 +2996,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.name` @@ -3065,8 +3003,6 @@ The name of diagnostic setting. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.storageAccountResourceId` @@ -3074,8 +3010,6 @@ Resource ID of the diagnostic storage account. For security reasons, it is recom - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.useThisWorkspace` @@ -3083,8 +3017,6 @@ Instead of using an external reference, use the deployed instance as the target - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 730 ### Parameter: `diagnosticSettings.workspaceResourceId` @@ -3092,8 +3024,6 @@ Resource ID of the diagnostic log analytics workspace. For security reasons, it - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `enableTelemetry` @@ -3102,8 +3032,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `features` @@ -3111,8 +3039,6 @@ The workspace features. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 730 **Optional parameters** @@ -3129,8 +3055,6 @@ Disable Non-EntraID based Auth. Default is true. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 730 ### Parameter: `features.enableDataExport` @@ -3138,8 +3062,6 @@ Flag that indicate if data should be exported. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 730 ### Parameter: `features.enableLogAccessUsingOnlyResourcePermissions` @@ -3147,8 +3069,6 @@ Enable log access using only resource permissions. Default is false. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 730 ### Parameter: `features.immediatePurgeDataOn30Days` @@ -3156,8 +3076,6 @@ Flag that describes if we want to remove the data after 30 days. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 730 ### Parameter: `forceCmkForQuery` @@ -3166,8 +3084,6 @@ Indicates whether customer managed storage is mandatory for query management. - Required: No - Type: bool - Default: `True` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `gallerySolutions` @@ -3175,8 +3091,6 @@ List of gallerySolutions to be created in the log analytics workspace. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 **Required parameters** @@ -3191,8 +3105,6 @@ Name of the solution.

For solutions authored by Microsoft, the name must be in - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `gallerySolutions.plan` @@ -3200,8 +3112,6 @@ Plan for solution object supported by the OperationsManagement resource provider - Required: Yes - Type: object -- MinValue: 0 -- MaxValue: 730 **Required parameters** @@ -3222,8 +3132,6 @@ The product name of the deployed solution.

For Microsoft published gallery sol - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `gallerySolutions.plan.name` @@ -3231,8 +3139,6 @@ Name of the solution to be created.

For solutions authored by Microsoft, the n - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `gallerySolutions.plan.publisher` @@ -3240,8 +3146,6 @@ The publisher name of the deployed solution. For Microsoft published gallery sol - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `linkedServices` @@ -3249,8 +3153,6 @@ List of services to be linked. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 **Required parameters** @@ -3271,8 +3173,6 @@ Name of the linked service. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `linkedServices.resourceId` @@ -3280,8 +3180,6 @@ The resource id of the resource that will be linked to the workspace. This shoul - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `linkedServices.writeAccessResourceId` @@ -3289,8 +3187,6 @@ The resource id of the resource that will be linked to the workspace. This shoul - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `location` @@ -3299,8 +3195,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `lock` @@ -3308,8 +3202,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 730 **Optional parameters** @@ -3332,8 +3224,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `lock.name` @@ -3341,8 +3231,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `managedIdentities` @@ -3350,8 +3238,6 @@ The managed identity definition for this resource. Only one type of identity is - Required: No - Type: object -- MinValue: 0 -- MaxValue: 730 **Optional parameters** @@ -3366,8 +3252,6 @@ Enables system assigned managed identity on the resource. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 730 ### Parameter: `managedIdentities.userAssignedResourceIds` @@ -3375,8 +3259,6 @@ The resource ID(s) to assign to the resource. Required if a user assigned identi - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 ### Parameter: `onboardWorkspaceToSentinel` @@ -3385,8 +3267,6 @@ Onboard the Log Analytics Workspace to Sentinel. Requires 'SecurityInsights' sol - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `publicNetworkAccessForIngestion` @@ -3402,8 +3282,6 @@ The network access type for accessing Log Analytics ingestion. 'Enabled' ] ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `publicNetworkAccessForQuery` @@ -3419,8 +3297,6 @@ The network access type for accessing Log Analytics query. 'Enabled' ] ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `roleAssignments` @@ -3428,8 +3304,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 - Roles configurable by name: - `'Contributor'` - `'Log Analytics Contributor'` @@ -3467,8 +3341,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -3476,8 +3348,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `roleAssignments.condition` @@ -3485,8 +3355,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `roleAssignments.conditionVersion` @@ -3500,8 +3368,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -3509,8 +3375,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `roleAssignments.description` @@ -3518,8 +3382,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `roleAssignments.name` @@ -3527,8 +3389,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `roleAssignments.principalType` @@ -3546,8 +3406,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `savedSearches` @@ -3555,8 +3413,6 @@ Kusto Query Language searches to save. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 **Required parameters** @@ -3583,8 +3439,6 @@ The category of the saved search. This helps the user to find a saved search fas - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `savedSearches.displayName` @@ -3592,8 +3446,6 @@ Display name for the search. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `savedSearches.name` @@ -3601,8 +3453,6 @@ Name of the saved search. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `savedSearches.query` @@ -3610,8 +3460,6 @@ The query expression for the saved search. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `savedSearches.etag` @@ -3619,8 +3467,6 @@ The ETag of the saved search. To override an existing saved search, use "*" or s - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `savedSearches.functionAlias` @@ -3628,8 +3474,6 @@ The function alias if query serves as a function. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `savedSearches.functionParameters` @@ -3637,8 +3481,6 @@ The optional function parameters if query serves as a function. Value should be - Required: No - Type: string -- MinValue: 0 -- MaxValue: 730 ### Parameter: `savedSearches.tags` @@ -3646,8 +3488,6 @@ The tags attached to the saved search. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 730 ### Parameter: `savedSearches.version` @@ -3655,8 +3495,6 @@ The version number of the query language. The current version is 2 and is the de - Required: No - Type: int -- MinValue: 0 -- MaxValue: 730 ### Parameter: `skuCapacityReservationLevel` @@ -3688,8 +3526,6 @@ The name of the SKU. 'Standard' ] ``` -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `storageInsightsConfigs` @@ -3697,8 +3533,6 @@ List of storage accounts to be read by the workspace. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 5000 **Required parameters** @@ -3719,8 +3553,6 @@ Resource ID of the storage account to be linked. - Required: Yes - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `storageInsightsConfigs.containers` @@ -3728,8 +3560,6 @@ The names of the blob containers that the workspace should read. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `storageInsightsConfigs.tables` @@ -3737,8 +3567,6 @@ List of tables to be read by the workspace. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables` @@ -3746,8 +3574,6 @@ LAW custom tables to be deployed. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 5000 **Required parameters** @@ -3773,8 +3599,6 @@ The name of the table. - Required: Yes - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.plan` @@ -3782,8 +3606,6 @@ The plan for the table. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.restoredLogs` @@ -3791,8 +3613,6 @@ The restored logs for the table. - Required: No - Type: object -- MinValue: 100 -- MaxValue: 5000 **Optional parameters** @@ -3808,8 +3628,6 @@ The timestamp to end the restore by (UTC). - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.restoredLogs.sourceTable` @@ -3817,8 +3635,6 @@ The table to restore data from. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.restoredLogs.startRestoreTime` @@ -3826,8 +3642,6 @@ The timestamp to start the restore from (UTC). - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.retentionInDays` @@ -3835,8 +3649,6 @@ The retention in days for the table. - Required: No - Type: int -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.roleAssignments` @@ -3844,8 +3656,6 @@ The role assignments for the table. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 5000 - Roles configurable by name: - `'Contributor'` - `'Log Analytics Contributor'` @@ -3881,8 +3691,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.roleAssignments.roleDefinitionIdOrName` @@ -3890,8 +3698,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.roleAssignments.condition` @@ -3899,8 +3705,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.roleAssignments.conditionVersion` @@ -3914,8 +3718,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.roleAssignments.delegatedManagedIdentityResourceId` @@ -3923,8 +3725,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.roleAssignments.description` @@ -3932,8 +3732,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.roleAssignments.name` @@ -3941,8 +3739,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.roleAssignments.principalType` @@ -3960,8 +3756,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.schema` @@ -3969,8 +3763,6 @@ The schema for the table. - Required: No - Type: object -- MinValue: 100 -- MaxValue: 5000 **Required parameters** @@ -3992,8 +3784,6 @@ A list of table custom columns. - Required: Yes - Type: array -- MinValue: 100 -- MaxValue: 5000 **Required parameters** @@ -4016,8 +3806,6 @@ The column name. - Required: Yes - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.schema.columns.type` @@ -4038,8 +3826,6 @@ The column type. 'string' ] ``` -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.schema.columns.dataTypeHint` @@ -4056,8 +3842,6 @@ The column data type logical hint. 'uri' ] ``` -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.schema.columns.description` @@ -4065,8 +3849,6 @@ The column description. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.schema.columns.displayName` @@ -4074,8 +3856,6 @@ Column display name. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.schema.name` @@ -4083,8 +3863,6 @@ The table name. - Required: Yes - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.schema.description` @@ -4092,8 +3870,6 @@ The table description. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.schema.displayName` @@ -4101,8 +3877,6 @@ The table display name. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.searchResults` @@ -4110,8 +3884,6 @@ The search results for the table. - Required: No - Type: object -- MinValue: 100 -- MaxValue: 5000 **Required parameters** @@ -4134,8 +3906,6 @@ The search job query. - Required: Yes - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.searchResults.description` @@ -4143,8 +3913,6 @@ The search description. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.searchResults.endSearchTime` @@ -4152,8 +3920,6 @@ The timestamp to end the search by (UTC). - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.searchResults.limit` @@ -4161,8 +3927,6 @@ Limit the search job to return up to specified number of rows. - Required: No - Type: int -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.searchResults.startSearchTime` @@ -4170,8 +3934,6 @@ The timestamp to start the search from (UTC). - Required: No - Type: string -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tables.totalRetentionInDays` @@ -4179,8 +3941,6 @@ The total retention in days for the table. - Required: No - Type: int -- MinValue: 100 -- MaxValue: 5000 ### Parameter: `tags` @@ -4188,8 +3948,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 100 -- MaxValue: 5000 ## Outputs diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 27986225ca..857b1e45ae 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -446,11 +446,16 @@ function Set-DefinitionSection { } # add MinValue and maxValue to the description - if ($parameter.ContainsKey('minValue')) { + if ($parameter.Keys -contains 'minValue') { $formattedMinValue = "- MinValue: $($parameter['minValue'])" + } else { + $formattedMinValue = $null # Reset value for future iterations } - if ($parameter.ContainsKey('maxValue')) { + + if ($parameter.Keys -contains 'maxValue') { $formattedMaxValue = "- MaxValue: $($parameter['maxValue'])" + } else { + $formattedMaxValue = $null # Reset value for future iterations } # Special case for 'roleAssignments' parameter From 0f83616284e51646ac6801263c47791880a41756 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Fri, 7 Mar 2025 20:20:24 +0100 Subject: [PATCH 38/43] Regenerated all readme's --- avm/ptn/app/container-job-toolkit/README.md | 24 -- .../pim-role-assignment/README.md | 348 ++++++++++++++++++ avm/ptn/azd/acr-container-app/README.md | 31 -- avm/ptn/azd/container-app-upsert/README.md | 25 -- avm/ptn/azd/ml-ai-environment/README.md | 8 - avm/ptn/azd/ml-hub-dependencies/README.md | 50 --- avm/ptn/lz/sub-vending/README.md | 113 ++++++ avm/ptn/policy-insights/remediation/README.md | 8 - .../configuration-store/README.md | 2 - avm/res/app/container-app/README.md | 24 -- avm/res/app/job/README.md | 18 - .../software-update-configuration/README.md | 22 -- avm/res/cache/redis-enterprise/README.md | 127 ++++++- .../cache/redis-enterprise/database/README.md | 127 ++++++- avm/res/cache/redis/README.md | 24 -- .../managed-cluster/README.md | 65 ---- .../managed-cluster/agent-pool/README.md | 68 ---- .../db-for-my-sql/flexible-server/README.md | 106 ------ .../flexible-server/README.md | 186 ---------- avm/res/dev-ops-infrastructure/pool/README.md | 128 ------- .../document-db/database-account/README.md | 267 -------------- .../sql-database/container/README.md | 13 - avm/res/elastic-san/elastic-san/README.md | 166 --------- .../elastic-san/volume-group/README.md | 4 - .../elastic-san/volume-group/volume/README.md | 10 - avm/res/event-grid/namespace/README.md | 112 ------ avm/res/event-grid/namespace/topic/README.md | 30 -- avm/res/event-hub/namespace/README.md | 122 ------ .../event-hub/namespace/eventhub/README.md | 32 -- avm/res/hybrid-compute/license/README.md | 10 - avm/res/insights/component/README.md | 2 - avm/res/kusto/cluster/README.md | 234 ------------ avm/res/net-app/net-app-account/README.md | 172 --------- .../net-app-account/backup-policies/README.md | 10 - .../net-app-account/capacity-pool/README.md | 156 -------- .../snapshot-policies/README.md | 8 - avm/res/network/application-gateway/README.md | 202 ---------- avm/res/network/azure-firewall/README.md | 61 --- avm/res/network/connection/README.md | 34 -- avm/res/network/dns-zone/README.md | 4 - avm/res/network/front-door/README.md | 1 - .../load-balancer/inbound-nat-rule/README.md | 16 - avm/res/network/network-manager/README.md | 20 - .../security-admin-configuration/README.md | 20 - .../rule-collection/README.md | 20 - .../rule-collection/rule/README.md | 26 -- .../network/network-security-group/README.md | 24 -- .../network-watcher/flow-log/README.md | 6 - avm/res/network/public-ip-prefix/README.md | 44 --- .../network/virtual-network-gateway/README.md | 10 - avm/res/network/virtual-network/README.md | 56 --- .../workspace/table/README.md | 50 --- avm/res/search/search-service/README.md | 114 ------ .../storage-account/blob-service/README.md | 61 --- .../image-template/README.md | 80 ---- 55 files changed, 683 insertions(+), 3018 deletions(-) diff --git a/avm/ptn/app/container-job-toolkit/README.md b/avm/ptn/app/container-job-toolkit/README.md index 563df5d721..f0f9c0f0fb 100644 --- a/avm/ptn/app/container-job-toolkit/README.md +++ b/avm/ptn/app/container-job-toolkit/README.md @@ -868,8 +868,6 @@ Network protocol this rule applies to. 'Udp' ] ``` -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.description` @@ -877,8 +875,6 @@ The description of the security rule. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.destinationAddressPrefix` @@ -886,8 +882,6 @@ The destination address prefix. CIDR or destination IP range. Asterisk "*" can a - Required: No - Type: string -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.destinationAddressPrefixes` @@ -895,8 +889,6 @@ The destination address prefixes. CIDR or destination IP ranges. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.destinationApplicationSecurityGroupResourceIds` @@ -904,8 +896,6 @@ The resource IDs of the application security groups specified as destination. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.destinationPortRange` @@ -913,8 +903,6 @@ The destination port or range. Integer or range between 0 and 65535. Asterisk "* - Required: No - Type: string -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.destinationPortRanges` @@ -922,8 +910,6 @@ The destination port ranges. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.sourceAddressPrefix` @@ -931,8 +917,6 @@ The CIDR or source IP range. Asterisk "*" can also be used to match all source I - Required: No - Type: string -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.sourceAddressPrefixes` @@ -940,8 +924,6 @@ The CIDR or source IP ranges. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.sourceApplicationSecurityGroupResourceIds` @@ -949,8 +931,6 @@ The resource IDs of the application security groups specified as source. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.sourcePortRange` @@ -958,8 +938,6 @@ The source port or range. Integer or range between 0 and 65535. Asterisk "*" can - Required: No - Type: string -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `customNetworkSecurityGroups.properties.sourcePortRanges` @@ -967,8 +945,6 @@ The source port ranges. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `deployInVnet` diff --git a/avm/ptn/authorization/pim-role-assignment/README.md b/avm/ptn/authorization/pim-role-assignment/README.md index 9a6cbac336..38a5cc647f 100644 --- a/avm/ptn/authorization/pim-role-assignment/README.md +++ b/avm/ptn/authorization/pim-role-assignment/README.md @@ -397,6 +397,354 @@ The type of the PIM role assignment whether its active or eligible. - Required: Yes - Type: object +- Type-deciding property: roleAssignmentType + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`Active`](#variant-pimroleassignmenttyperoleassignmenttype-active) | | +| [`Eligible`](#variant-pimroleassignmenttyperoleassignmenttype-eligible) | | + +### Variant: `pimRoleAssignmentType.roleAssignmentType-Active` + + +To use this variant, set the property `roleAssignmentType` to `Active`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`roleAssignmentType`](#parameter-pimroleassignmenttyperoleassignmenttype-activeroleassignmenttype) | string | The type of the role assignment. | +| [`scheduleInfo`](#parameter-pimroleassignmenttyperoleassignmenttype-activescheduleinfo) | object | The schedule information for the role assignment. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`linkedRoleEligibilityScheduleId`](#parameter-pimroleassignmenttyperoleassignmenttype-activelinkedroleeligibilityscheduleid) | string | The linked role eligibility schedule id - to activate an eligibility. | +| [`targetRoleAssignmentScheduleId`](#parameter-pimroleassignmenttyperoleassignmenttype-activetargetroleassignmentscheduleid) | string | The resultant role assignment schedule id or the role assignment schedule id being updated. | +| [`targetRoleAssignmentScheduleInstanceId`](#parameter-pimroleassignmenttyperoleassignmenttype-activetargetroleassignmentscheduleinstanceid) | string | The role assignment schedule instance id being updated. | + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.roleAssignmentType` + +The type of the role assignment. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Active' + ] + ``` + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo` + +The schedule information for the role assignment. + +- Required: Yes +- Type: object +- Type-deciding property: durationType + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`NoExpiration`](#variant-pimroleassignmenttyperoleassignmenttype-activescheduleinfodurationtype-noexpiration) | | +| [`AfterDuration`](#variant-pimroleassignmenttyperoleassignmenttype-activescheduleinfodurationtype-afterduration) | | +| [`AfterDateTime`](#variant-pimroleassignmenttyperoleassignmenttype-activescheduleinfodurationtype-afterdatetime) | | + +### Variant: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo.durationType-NoExpiration` + + +To use this variant, set the property `durationType` to `NoExpiration`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`durationType`](#parameter-pimroleassignmenttyperoleassignmenttype-activescheduleinfodurationtype-noexpirationdurationtype) | string | The type of the duration. | + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo.durationType-NoExpiration.durationType` + +The type of the duration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'NoExpiration' + ] + ``` + +### Variant: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo.durationType-AfterDuration` + + +To use this variant, set the property `durationType` to `AfterDuration`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`duration`](#parameter-pimroleassignmenttyperoleassignmenttype-activescheduleinfodurationtype-afterdurationduration) | string | The duration for the role assignment. | +| [`durationType`](#parameter-pimroleassignmenttyperoleassignmenttype-activescheduleinfodurationtype-afterdurationdurationtype) | string | The type of the duration. | +| [`startTime`](#parameter-pimroleassignmenttyperoleassignmenttype-activescheduleinfodurationtype-afterdurationstarttime) | string | The start time for the role assignment. | + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo.durationType-AfterDuration.duration` + +The duration for the role assignment. + +- Required: Yes +- Type: string + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo.durationType-AfterDuration.durationType` + +The type of the duration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AfterDuration' + ] + ``` + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo.durationType-AfterDuration.startTime` + +The start time for the role assignment. + +- Required: Yes +- Type: string + +### Variant: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo.durationType-AfterDateTime` + + +To use this variant, set the property `durationType` to `AfterDateTime`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`durationType`](#parameter-pimroleassignmenttyperoleassignmenttype-activescheduleinfodurationtype-afterdatetimedurationtype) | string | The type of the duration. | +| [`endDateTime`](#parameter-pimroleassignmenttyperoleassignmenttype-activescheduleinfodurationtype-afterdatetimeenddatetime) | string | The end date and time for the role assignment. | +| [`startTime`](#parameter-pimroleassignmenttyperoleassignmenttype-activescheduleinfodurationtype-afterdatetimestarttime) | string | The start date and time for the role assignment. | + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo.durationType-AfterDateTime.durationType` + +The type of the duration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AfterDateTime' + ] + ``` + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo.durationType-AfterDateTime.endDateTime` + +The end date and time for the role assignment. + +- Required: Yes +- Type: string + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.scheduleInfo.durationType-AfterDateTime.startTime` + +The start date and time for the role assignment. + +- Required: Yes +- Type: string + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.linkedRoleEligibilityScheduleId` + +The linked role eligibility schedule id - to activate an eligibility. + +- Required: No +- Type: string + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.targetRoleAssignmentScheduleId` + +The resultant role assignment schedule id or the role assignment schedule id being updated. + +- Required: No +- Type: string + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Active.targetRoleAssignmentScheduleInstanceId` + +The role assignment schedule instance id being updated. + +- Required: No +- Type: string + +### Variant: `pimRoleAssignmentType.roleAssignmentType-Eligible` + + +To use this variant, set the property `roleAssignmentType` to `Eligible`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`roleAssignmentType`](#parameter-pimroleassignmenttyperoleassignmenttype-eligibleroleassignmenttype) | string | The type of the role assignment. | +| [`scheduleInfo`](#parameter-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfo) | object | The schedule information for the role assignment. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`targetRoleEligibilityScheduleId`](#parameter-pimroleassignmenttyperoleassignmenttype-eligibletargetroleeligibilityscheduleid) | string | The resultant role eligibility schedule id or the role eligibility schedule id being updated. | +| [`targetRoleEligibilityScheduleInstanceId`](#parameter-pimroleassignmenttyperoleassignmenttype-eligibletargetroleeligibilityscheduleinstanceid) | string | The role eligibility assignment instance id being updated. | + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.roleAssignmentType` + +The type of the role assignment. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'Eligible' + ] + ``` + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo` + +The schedule information for the role assignment. + +- Required: Yes +- Type: object +- Type-deciding property: durationType + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`NoExpiration`](#variant-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfodurationtype-noexpiration) | | +| [`AfterDuration`](#variant-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfodurationtype-afterduration) | | +| [`AfterDateTime`](#variant-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfodurationtype-afterdatetime) | | + +### Variant: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo.durationType-NoExpiration` + + +To use this variant, set the property `durationType` to `NoExpiration`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`durationType`](#parameter-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfodurationtype-noexpirationdurationtype) | string | The type of the duration. | + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo.durationType-NoExpiration.durationType` + +The type of the duration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'NoExpiration' + ] + ``` + +### Variant: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo.durationType-AfterDuration` + + +To use this variant, set the property `durationType` to `AfterDuration`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`duration`](#parameter-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfodurationtype-afterdurationduration) | string | The duration for the role assignment. | +| [`durationType`](#parameter-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfodurationtype-afterdurationdurationtype) | string | The type of the duration. | +| [`startTime`](#parameter-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfodurationtype-afterdurationstarttime) | string | The start time for the role assignment. | + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo.durationType-AfterDuration.duration` + +The duration for the role assignment. + +- Required: Yes +- Type: string + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo.durationType-AfterDuration.durationType` + +The type of the duration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AfterDuration' + ] + ``` + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo.durationType-AfterDuration.startTime` + +The start time for the role assignment. + +- Required: Yes +- Type: string + +### Variant: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo.durationType-AfterDateTime` + + +To use this variant, set the property `durationType` to `AfterDateTime`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`durationType`](#parameter-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfodurationtype-afterdatetimedurationtype) | string | The type of the duration. | +| [`endDateTime`](#parameter-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfodurationtype-afterdatetimeenddatetime) | string | The end date and time for the role assignment. | +| [`startTime`](#parameter-pimroleassignmenttyperoleassignmenttype-eligiblescheduleinfodurationtype-afterdatetimestarttime) | string | The start date and time for the role assignment. | + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo.durationType-AfterDateTime.durationType` + +The type of the duration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AfterDateTime' + ] + ``` + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo.durationType-AfterDateTime.endDateTime` + +The end date and time for the role assignment. + +- Required: Yes +- Type: string + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.scheduleInfo.durationType-AfterDateTime.startTime` + +The start date and time for the role assignment. + +- Required: Yes +- Type: string + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.targetRoleEligibilityScheduleId` + +The resultant role eligibility schedule id or the role eligibility schedule id being updated. + +- Required: No +- Type: string + +### Parameter: `pimRoleAssignmentType.roleAssignmentType-Eligible.targetRoleEligibilityScheduleInstanceId` + +The role eligibility assignment instance id being updated. + +- Required: No +- Type: string ### Parameter: `principalId` diff --git a/avm/ptn/azd/acr-container-app/README.md b/avm/ptn/azd/acr-container-app/README.md index e7c87da927..678f06055f 100644 --- a/avm/ptn/azd/acr-container-app/README.md +++ b/avm/ptn/azd/acr-container-app/README.md @@ -191,7 +191,6 @@ Memory allocated to a single container instance, e.g., 1Gi. - Required: No - Type: string - Default: `'1.0Gi'` -- MinValue: 1 ### Parameter: `containerMinReplicas` @@ -200,7 +199,6 @@ The minimum number of replicas to run. Must be at least 2. - Required: No - Type: int - Default: `2` -- MinValue: 1 ### Parameter: `containerName` @@ -209,7 +207,6 @@ The name of the container. - Required: No - Type: string - Default: `'main'` -- MinValue: 1 ### Parameter: `containerRegistryHostSuffix` @@ -218,7 +215,6 @@ Hostname suffix for container registry. Set when deploying to sovereign clouds. - Required: No - Type: string - Default: `'azurecr.io'` -- MinValue: 1 ### Parameter: `containerRegistryName` @@ -227,7 +223,6 @@ The name of the container registry. - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `daprAppId` @@ -236,7 +231,6 @@ The Dapr app ID. - Required: No - Type: string - Default: `[parameters('containerName')]` -- MinValue: 1 ### Parameter: `daprAppProtocol` @@ -252,7 +246,6 @@ The protocol used by Dapr to connect to the app, e.g., http or grpc. 'http' ] ``` -- MinValue: 1 ### Parameter: `daprEnabled` @@ -261,7 +254,6 @@ Enable Dapr. - Required: No - Type: bool - Default: `False` -- MinValue: 1 ### Parameter: `enableTelemetry` @@ -270,7 +262,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 1 ### Parameter: `env` @@ -278,7 +269,6 @@ The environment variables for the container. - Required: No - Type: array -- MinValue: 1 **Required parameters** @@ -299,7 +289,6 @@ Environment variable name. - Required: Yes - Type: string -- MinValue: 1 ### Parameter: `env.secretRef` @@ -307,7 +296,6 @@ Name of the Container App secret from which to pull the environment variable val - Required: No - Type: string -- MinValue: 1 ### Parameter: `env.value` @@ -315,7 +303,6 @@ Non-secret environment variable value. - Required: No - Type: string -- MinValue: 1 ### Parameter: `external` @@ -324,7 +311,6 @@ Specifies if the resource ingress is exposed externally. - Required: No - Type: bool - Default: `True` -- MinValue: 1 ### Parameter: `identityName` @@ -333,7 +319,6 @@ The name of the user-assigned identity. - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `identityType` @@ -350,7 +335,6 @@ The type of identity for the resource. 'UserAssigned' ] ``` -- MinValue: 1 ### Parameter: `imageName` @@ -359,7 +343,6 @@ The name of the container image. - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `includeAddOns` @@ -368,7 +351,6 @@ Toggle to include the service configuration. - Required: No - Type: bool - Default: `False` -- MinValue: 1 ### Parameter: `ingressAllowInsecure` @@ -377,7 +359,6 @@ Bool indicating if HTTP connections to is allowed. If set to false HTTP connecti - Required: No - Type: bool - Default: `True` -- MinValue: 1 ### Parameter: `ingressEnabled` @@ -386,7 +367,6 @@ Specifies if Ingress is enabled for the container app. - Required: No - Type: bool - Default: `True` -- MinValue: 1 ### Parameter: `ingressTransport` @@ -404,7 +384,6 @@ Ingress transport protocol. 'tcp' ] ``` -- MinValue: 1 ### Parameter: `ipSecurityRestrictions` @@ -413,7 +392,6 @@ Rules to restrict incoming IP address. - Required: No - Type: array - Default: `[]` -- MinValue: 1 ### Parameter: `location` @@ -422,7 +400,6 @@ Location for all Resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 1 ### Parameter: `principalId` @@ -431,7 +408,6 @@ The principal ID of the principal to assign the role to. - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `revisionMode` @@ -447,7 +423,6 @@ Controls how active revisions are handled for the Container app. 'Single' ] ``` -- MinValue: 1 ### Parameter: `secrets` @@ -456,7 +431,6 @@ The secrets required for the container. - Required: No - Type: secureObject - Default: `{}` -- MinValue: 1 ### Parameter: `serviceBinds` @@ -465,7 +439,6 @@ The service binds associated with the container. - Required: No - Type: array - Default: `[]` -- MinValue: 1 ### Parameter: `serviceType` @@ -474,7 +447,6 @@ The name of the container apps add-on to use. e.g. redis. - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `tags` @@ -482,7 +454,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 1 ### Parameter: `targetPort` @@ -491,7 +462,6 @@ The target port for the container. - Required: No - Type: int - Default: `80` -- MinValue: 1 ### Parameter: `userAssignedIdentityResourceId` @@ -500,7 +470,6 @@ The resource id of the user-assigned identity. - Required: No - Type: string - Default: `''` -- MinValue: 1 ## Outputs diff --git a/avm/ptn/azd/container-app-upsert/README.md b/avm/ptn/azd/container-app-upsert/README.md index bd1b15cdda..91e85eea36 100644 --- a/avm/ptn/azd/container-app-upsert/README.md +++ b/avm/ptn/azd/container-app-upsert/README.md @@ -369,7 +369,6 @@ The amount of memory allocated to a single container instance, e.g., 1Gi. - Required: No - Type: string - Default: `'1.0Gi'` -- MinValue: 1 ### Parameter: `containerMinReplicas` @@ -387,7 +386,6 @@ The name of the container. - Required: No - Type: string - Default: `'main'` -- MinValue: 1 ### Parameter: `containerRegistryHostSuffix` @@ -396,7 +394,6 @@ Hostname suffix for container registry. Set when deploying to sovereign clouds. - Required: No - Type: string - Default: `'azurecr.io'` -- MinValue: 1 ### Parameter: `containerRegistryName` @@ -405,7 +402,6 @@ The name of the container registry. - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `daprAppId` @@ -414,7 +410,6 @@ The Dapr app ID. - Required: No - Type: string - Default: `[parameters('containerName')]` -- MinValue: 1 ### Parameter: `daprAppProtocol` @@ -430,7 +425,6 @@ The protocol used by Dapr to connect to the app, e.g., HTTP or gRPC. 'http' ] ``` -- MinValue: 1 ### Parameter: `daprEnabled` @@ -439,7 +433,6 @@ Enable or disable Dapr for the container app. - Required: No - Type: bool - Default: `False` -- MinValue: 1 ### Parameter: `enableTelemetry` @@ -448,7 +441,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 1 ### Parameter: `env` @@ -456,7 +448,6 @@ The environment variables for the container. - Required: No - Type: array -- MinValue: 1 **Required parameters** @@ -477,7 +468,6 @@ Environment variable name. - Required: Yes - Type: string -- MinValue: 1 ### Parameter: `env.secretRef` @@ -485,7 +475,6 @@ Name of the Container App secret from which to pull the environment variable val - Required: No - Type: string -- MinValue: 1 ### Parameter: `env.value` @@ -493,7 +482,6 @@ Non-secret environment variable value. - Required: No - Type: string -- MinValue: 1 ### Parameter: `exists` @@ -502,7 +490,6 @@ Specifies if the resource already exists. - Required: No - Type: bool - Default: `False` -- MinValue: 1 ### Parameter: `external` @@ -511,7 +498,6 @@ Specifies if the resource ingress is exposed externally. - Required: No - Type: bool - Default: `True` -- MinValue: 1 ### Parameter: `identityName` @@ -520,7 +506,6 @@ The name of the user-assigned identity. - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `identityPrincipalId` @@ -529,7 +514,6 @@ The principal ID of the principal to assign the role to. - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `identityType` @@ -546,7 +530,6 @@ The type of identity for the resource. 'UserAssigned' ] ``` -- MinValue: 1 ### Parameter: `imageName` @@ -555,7 +538,6 @@ The name of the container image. - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `ingressEnabled` @@ -564,7 +546,6 @@ Specifies if Ingress is enabled for the container app. - Required: No - Type: bool - Default: `True` -- MinValue: 1 ### Parameter: `location` @@ -573,7 +554,6 @@ Location for all Resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 1 ### Parameter: `secrets` @@ -582,7 +562,6 @@ The secrets required for the container. - Required: No - Type: secureObject - Default: `{}` -- MinValue: 1 ### Parameter: `serviceBinds` @@ -591,7 +570,6 @@ The service binds associated with the container. - Required: No - Type: array - Default: `[]` -- MinValue: 1 ### Parameter: `tags` @@ -599,7 +577,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 1 ### Parameter: `targetPort` @@ -608,7 +585,6 @@ The target port for the container. - Required: No - Type: int - Default: `80` -- MinValue: 1 ### Parameter: `userAssignedIdentityResourceId` @@ -617,7 +593,6 @@ The resource id of the user-assigned identity. - Required: No - Type: string - Default: `''` -- MinValue: 1 ## Outputs diff --git a/avm/ptn/azd/ml-ai-environment/README.md b/avm/ptn/azd/ml-ai-environment/README.md index 339276bf10..d6d77f708b 100644 --- a/avm/ptn/azd/ml-ai-environment/README.md +++ b/avm/ptn/azd/ml-ai-environment/README.md @@ -482,8 +482,6 @@ The Azure Search connection name. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `tags` @@ -491,8 +489,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 12 - Example: ```Bicep { @@ -507,8 +503,6 @@ The User Assigned Identity resource name. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `searchServiceName` @@ -517,8 +511,6 @@ The Azure Search resource name. Required if the parameter searchServiceName is n - Required: No - Type: string - Default: `''` -- MinValue: 1 -- MaxValue: 12 ## Outputs diff --git a/avm/ptn/azd/ml-hub-dependencies/README.md b/avm/ptn/azd/ml-hub-dependencies/README.md index b036e7fc03..9838054938 100644 --- a/avm/ptn/azd/ml-hub-dependencies/README.md +++ b/avm/ptn/azd/ml-hub-dependencies/README.md @@ -537,8 +537,6 @@ When set to true, calls to the search service will not be permitted to utilize A - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `dnsEndpointType` @@ -555,8 +553,6 @@ Allows you to specify the type of endpoint in the storage account. Set this to A 'Standard' ] ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `enablePurgeProtection` @@ -565,8 +561,6 @@ Provide 'true' to enable Key Vault's purge protection feature. - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `enableRbacAuthorization` @@ -575,8 +569,6 @@ Property that controls how data actions are authorized. When true, the key vault - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `enableTelemetry` @@ -585,8 +577,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `enableVaultForDeployment` @@ -595,8 +585,6 @@ Specifies if the vault is enabled for deployment by script or compute. - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `enableVaultForTemplateDeployment` @@ -605,8 +593,6 @@ Specifies if the vault is enabled for a template deployment. - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `fileServices` @@ -620,8 +606,6 @@ File service and shares to deploy. name: 'default' } ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `hostingMode` @@ -637,8 +621,6 @@ Applicable only for the standard3 SKU. You can set this property to enable up to 'highDensity' ] ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `keyVaultSku` @@ -654,8 +636,6 @@ Specifies the SKU for the vault. 'standard' ] ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `location` @@ -664,8 +644,6 @@ Location for all Resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `logAnalyticsName` @@ -674,8 +652,6 @@ The resource operational insights workspaces name. - Required: No - Type: string - Default: `''` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `logAnalyticsSkuName` @@ -697,8 +673,6 @@ The name of the SKU. 'Standard' ] ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `networkAcls` @@ -713,8 +687,6 @@ Networks ACLs, this value contains IPs to whitelist and/or Subnet information. I defaultAction: 'Allow' } ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `networkRuleSet` @@ -729,8 +701,6 @@ Network specific rules that determine how the Azure Cognitive Search service may ipRules: [] } ``` -- MinValue: 0 -- MaxValue: 730 ### Parameter: `partitionCount` @@ -757,8 +727,6 @@ Whether or not public network access is allowed for the storage account. For sec 'Enabled' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `queueServices` @@ -772,8 +740,6 @@ Queue service and queues to create. name: 'default' } ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `registryAcrSku` @@ -790,8 +756,6 @@ Tier of your Azure container registry. 'Standard' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `registryPublicNetworkAccess` @@ -800,8 +764,6 @@ Public network access setting. - Required: No - Type: string - Default: `'Enabled'` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `replicaCount` @@ -820,8 +782,6 @@ Name of the Azure Cognitive Search service. - Required: No - Type: string - Default: `''` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `searchServicePublicNetworkAccess` @@ -837,8 +797,6 @@ This value can be set to 'Enabled' to avoid breaking changes on existing custome 'Enabled' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `searchServiceSku` @@ -859,8 +817,6 @@ Defines the SKU of an Azure Cognitive Search Service, which determines price tie 'storage_optimized_l2' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `semanticSearch` @@ -877,8 +833,6 @@ Sets options that control the availability of semantic search. This configuratio 'standard' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `tableServices` @@ -892,8 +846,6 @@ Table service and tables to create. name: 'default' } ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `tags` @@ -901,8 +853,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 12 - Example: ```Bicep { diff --git a/avm/ptn/lz/sub-vending/README.md b/avm/ptn/lz/sub-vending/README.md index fa68f5a3be..d0ede6dded 100644 --- a/avm/ptn/lz/sub-vending/README.md +++ b/avm/ptn/lz/sub-vending/README.md @@ -1841,6 +1841,119 @@ The schedule information for the role assignment. - Required: Yes - Type: object +- Type-deciding property: durationType + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`NoExpiration`](#variant-pimroleassignmentsscheduleinfodurationtype-noexpiration) | | +| [`AfterDuration`](#variant-pimroleassignmentsscheduleinfodurationtype-afterduration) | | +| [`AfterDateTime`](#variant-pimroleassignmentsscheduleinfodurationtype-afterdatetime) | | + +### Variant: `pimRoleAssignments.scheduleInfo.durationType-NoExpiration` + + +To use this variant, set the property `durationType` to `NoExpiration`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`durationType`](#parameter-pimroleassignmentsscheduleinfodurationtype-noexpirationdurationtype) | string | The type of the duration. | + +### Parameter: `pimRoleAssignments.scheduleInfo.durationType-NoExpiration.durationType` + +The type of the duration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'NoExpiration' + ] + ``` + +### Variant: `pimRoleAssignments.scheduleInfo.durationType-AfterDuration` + + +To use this variant, set the property `durationType` to `AfterDuration`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`duration`](#parameter-pimroleassignmentsscheduleinfodurationtype-afterdurationduration) | string | The duration for the role assignment. | +| [`durationType`](#parameter-pimroleassignmentsscheduleinfodurationtype-afterdurationdurationtype) | string | The type of the duration. | +| [`startTime`](#parameter-pimroleassignmentsscheduleinfodurationtype-afterdurationstarttime) | string | The start time for the role assignment. | + +### Parameter: `pimRoleAssignments.scheduleInfo.durationType-AfterDuration.duration` + +The duration for the role assignment. + +- Required: Yes +- Type: string + +### Parameter: `pimRoleAssignments.scheduleInfo.durationType-AfterDuration.durationType` + +The type of the duration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AfterDuration' + ] + ``` + +### Parameter: `pimRoleAssignments.scheduleInfo.durationType-AfterDuration.startTime` + +The start time for the role assignment. + +- Required: Yes +- Type: string + +### Variant: `pimRoleAssignments.scheduleInfo.durationType-AfterDateTime` + + +To use this variant, set the property `durationType` to `AfterDateTime`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`durationType`](#parameter-pimroleassignmentsscheduleinfodurationtype-afterdatetimedurationtype) | string | The type of the duration. | +| [`endDateTime`](#parameter-pimroleassignmentsscheduleinfodurationtype-afterdatetimeenddatetime) | string | The end date and time for the role assignment. | +| [`startTime`](#parameter-pimroleassignmentsscheduleinfodurationtype-afterdatetimestarttime) | string | The start date and time for the role assignment. | + +### Parameter: `pimRoleAssignments.scheduleInfo.durationType-AfterDateTime.durationType` + +The type of the duration. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AfterDateTime' + ] + ``` + +### Parameter: `pimRoleAssignments.scheduleInfo.durationType-AfterDateTime.endDateTime` + +The end date and time for the role assignment. + +- Required: Yes +- Type: string + +### Parameter: `pimRoleAssignments.scheduleInfo.durationType-AfterDateTime.startTime` + +The start date and time for the role assignment. + +- Required: Yes +- Type: string ### Parameter: `pimRoleAssignments.justification` diff --git a/avm/ptn/policy-insights/remediation/README.md b/avm/ptn/policy-insights/remediation/README.md index 521a3c10d8..d8f0f8b046 100644 --- a/avm/ptn/policy-insights/remediation/README.md +++ b/avm/ptn/policy-insights/remediation/README.md @@ -671,8 +671,6 @@ The policy definition reference ID of the individual definition that should be r - Required: No - Type: string - Default: `''` -- MinValue: 1 -- MaxValue: 30 ### Parameter: `resourceCount` @@ -698,8 +696,6 @@ The way resources to remediate are discovered. Defaults to ExistingNonCompliant 'ReEvaluateCompliance' ] ``` -- MinValue: 1 -- MaxValue: 50000 ### Parameter: `resourceGroupName` @@ -708,8 +704,6 @@ The target scope for the remediation. The name of the resource group for the pol - Required: No - Type: string - Default: `''` -- MinValue: 1 -- MaxValue: 50000 ### Parameter: `subscriptionId` @@ -718,8 +712,6 @@ The target scope for the remediation. The subscription ID of the subscription fo - Required: No - Type: string - Default: `''` -- MinValue: 1 -- MaxValue: 50000 ## Outputs diff --git a/avm/res/app-configuration/configuration-store/README.md b/avm/res/app-configuration/configuration-store/README.md index d7417623b4..67034f402b 100644 --- a/avm/res/app-configuration/configuration-store/README.md +++ b/avm/res/app-configuration/configuration-store/README.md @@ -1912,8 +1912,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 7 ## Outputs diff --git a/avm/res/app/container-app/README.md b/avm/res/app/container-app/README.md index e07c1f8f48..7493d9cace 100644 --- a/avm/res/app/container-app/README.md +++ b/avm/res/app/container-app/README.md @@ -1103,8 +1103,6 @@ HTTPGet specifies the http request to perform. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 10 **Required parameters** @@ -1127,8 +1125,6 @@ Path to access on the HTTP server. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10 ### Parameter: `containers.probes.httpGet.port` @@ -1136,8 +1132,6 @@ Name or number of the port to access on the container. - Required: Yes - Type: int -- MinValue: 1 -- MaxValue: 10 ### Parameter: `containers.probes.httpGet.host` @@ -1145,8 +1139,6 @@ Host name to connect to. Defaults to the pod IP. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10 ### Parameter: `containers.probes.httpGet.httpHeaders` @@ -1154,8 +1146,6 @@ HTTP headers to set in the request. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10 **Required parameters** @@ -1170,8 +1160,6 @@ Name of the header. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10 ### Parameter: `containers.probes.httpGet.httpHeaders.value` @@ -1179,8 +1167,6 @@ Value of the header. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10 ### Parameter: `containers.probes.httpGet.scheme` @@ -1195,8 +1181,6 @@ Scheme to use for connecting to the host. Defaults to HTTP. 'HTTPS' ] ``` -- MinValue: 1 -- MaxValue: 10 ### Parameter: `containers.probes.initialDelaySeconds` @@ -1231,8 +1215,6 @@ The TCP socket specifies an action involving a TCP port. TCP hooks not yet suppo - Required: No - Type: object -- MinValue: 1 -- MaxValue: 10 **Required parameters** @@ -1261,8 +1243,6 @@ Host name to connect to, defaults to the pod IP. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 65535 ### Parameter: `containers.probes.terminationGracePeriodSeconds` @@ -1270,8 +1250,6 @@ Optional duration in seconds the pod needs to terminate gracefully upon probe fa - Required: No - Type: int -- MinValue: 1 -- MaxValue: 10 ### Parameter: `containers.probes.timeoutSeconds` @@ -1296,8 +1274,6 @@ The type of probe. 'Startup' ] ``` -- MinValue: 1 -- MaxValue: 240 ### Parameter: `containers.volumeMounts` diff --git a/avm/res/app/job/README.md b/avm/res/app/job/README.md index f0c6d811af..77024517b1 100644 --- a/avm/res/app/job/README.md +++ b/avm/res/app/job/README.md @@ -1110,8 +1110,6 @@ HTTPGet specifies the http request to perform. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 10 **Required parameters** @@ -1134,8 +1132,6 @@ Path to access on the HTTP server. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10 ### Parameter: `containers.probes.httpGet.port` @@ -1152,8 +1148,6 @@ Host name to connect to, defaults to the pod IP. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 65535 ### Parameter: `containers.probes.httpGet.httpHeaders` @@ -1161,8 +1155,6 @@ Custom headers to set in the request. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 65535 **Required parameters** @@ -1177,8 +1169,6 @@ The header field name. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 65535 ### Parameter: `containers.probes.httpGet.httpHeaders.value` @@ -1186,8 +1176,6 @@ The header field value. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 65535 ### Parameter: `containers.probes.httpGet.scheme` @@ -1202,8 +1190,6 @@ Scheme to use for connecting to the host. Defaults to HTTP. 'HTTPS' ] ``` -- MinValue: 1 -- MaxValue: 65535 ### Parameter: `containers.probes.initialDelaySeconds` @@ -1238,8 +1224,6 @@ TCPSocket specifies an action involving a TCP port. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 10 **Required parameters** @@ -1254,8 +1238,6 @@ Host name to connect to, defaults to the pod IP. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10 ### Parameter: `containers.probes.tcpSocket.port` diff --git a/avm/res/automation/automation-account/software-update-configuration/README.md b/avm/res/automation/automation-account/software-update-configuration/README.md index ac288c5f9b..3301767455 100644 --- a/avm/res/automation/automation-account/software-update-configuration/README.md +++ b/avm/res/automation/automation-account/software-update-configuration/README.md @@ -186,7 +186,6 @@ Enables the deployment schedule. - Required: No - Type: bool - Default: `True` -- MaxValue: 100 ### Parameter: `maintenanceWindow` @@ -195,7 +194,6 @@ Maximum time allowed for the deployment schedule to run. Duration needs to be sp - Required: No - Type: string - Default: `'PT2H'` -- MaxValue: 100 ### Parameter: `monthDays` @@ -239,7 +237,6 @@ Can be used with frequency 'Month'. Provides the specific days of the month to r 31 ] ``` -- MaxValue: 100 ### Parameter: `monthlyOccurrences` @@ -247,7 +244,6 @@ Can be used with frequency 'Month'. Provides the pattern/cadence for running the - Required: No - Type: array -- MaxValue: 100 ### Parameter: `nextRun` @@ -256,7 +252,6 @@ The next time the deployment schedule runs in ISO 8601 format. YYYY-MM-DDTHH:MM: - Required: No - Type: string - Default: `''` -- MaxValue: 100 ### Parameter: `nextRunOffsetMinutes` @@ -265,7 +260,6 @@ The next run's offset in minutes. - Required: No - Type: int - Default: `0` -- MaxValue: 100 ### Parameter: `nonAzureComputerNames` @@ -274,7 +268,6 @@ List of names of non-azure machines in scope for the deployment schedule. - Required: No - Type: array - Default: `[]` -- MaxValue: 100 ### Parameter: `nonAzureQueries` @@ -283,7 +276,6 @@ Array of functions from a Log Analytics workspace, used to scope the deployment - Required: No - Type: array - Default: `[]` -- MaxValue: 100 ### Parameter: `postTaskParameters` @@ -291,7 +283,6 @@ Parameters provided to the task running after the deployment schedule. - Required: No - Type: object -- MaxValue: 100 ### Parameter: `postTaskSource` @@ -299,7 +290,6 @@ The source of the task running after the deployment schedule. - Required: No - Type: string -- MaxValue: 100 ### Parameter: `preTaskParameters` @@ -307,7 +297,6 @@ Parameters provided to the task running before the deployment schedule. - Required: No - Type: object -- MaxValue: 100 ### Parameter: `preTaskSource` @@ -315,7 +304,6 @@ The source of the task running before the deployment schedule. - Required: No - Type: string -- MaxValue: 100 ### Parameter: `scheduleDescription` @@ -324,7 +312,6 @@ The schedules description. - Required: No - Type: string - Default: `''` -- MaxValue: 100 ### Parameter: `scopeByLocations` @@ -333,7 +320,6 @@ Specify locations to which to scope the deployment schedule to. - Required: No - Type: array - Default: `[]` -- MaxValue: 100 ### Parameter: `scopeByResources` @@ -347,7 +333,6 @@ Specify the resources to scope the deployment schedule to. '[subscription().id]' ] ``` -- MaxValue: 100 ### Parameter: `scopeByTags` @@ -356,7 +341,6 @@ Specify tags to which to scope the deployment schedule to. - Required: No - Type: object - Default: `{}` -- MaxValue: 100 ### Parameter: `scopeByTagsOperation` @@ -372,7 +356,6 @@ Enables the scopeByTags to require All (Tag A and Tag B) or Any (Tag A or Tag B) 'Any' ] ``` -- MaxValue: 100 ### Parameter: `startTime` @@ -381,7 +364,6 @@ The start time of the deployment schedule in ISO 8601 format. To specify a speci - Required: No - Type: string - Default: `''` -- MaxValue: 100 ### Parameter: `timeZone` @@ -390,7 +372,6 @@ Time zone for the deployment schedule. IANA ID or a Windows Time Zone ID. - Required: No - Type: string - Default: `'UTC'` -- MaxValue: 100 ### Parameter: `updateClassifications` @@ -419,7 +400,6 @@ Update classification included in the deployment schedule. 'Updates' ] ``` -- MaxValue: 100 ### Parameter: `weekDays` @@ -439,7 +419,6 @@ Required when used with frequency 'Week'. Specified the day of the week to run t 'Wednesday' ] ``` -- MaxValue: 100 ### Parameter: `baseTime` @@ -448,7 +427,6 @@ Do not touch. Is used to provide the base time for time comparison for startTime - Required: No - Type: string - Default: `[utcNow('u')]` -- MaxValue: 100 ## Outputs diff --git a/avm/res/cache/redis-enterprise/README.md b/avm/res/cache/redis-enterprise/README.md index 5dc42f9da4..dcf077d75f 100644 --- a/avm/res/cache/redis-enterprise/README.md +++ b/avm/res/cache/redis-enterprise/README.md @@ -1729,6 +1729,117 @@ The persistence settings of the service. - Required: No - Type: object +- Type-deciding property: type + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`disabled`](#variant-databasepersistencetype-disabled) | | +| [`aof`](#variant-databasepersistencetype-aof) | | +| [`rdb`](#variant-databasepersistencetype-rdb) | | + +### Variant: `database.persistence.type-disabled` + + +To use this variant, set the property `type` to `disabled`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`type`](#parameter-databasepersistencetype-disabledtype) | string | Disabled persistence type. | + +### Parameter: `database.persistence.type-disabled.type` + +Disabled persistence type. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'disabled' + ] + ``` + +### Variant: `database.persistence.type-aof` + + +To use this variant, set the property `type` to `aof`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`frequency`](#parameter-databasepersistencetype-aoffrequency) | string | The frequency at which data is written to disk. | +| [`type`](#parameter-databasepersistencetype-aoftype) | string | AOF persistence type. | + +### Parameter: `database.persistence.type-aof.frequency` + +The frequency at which data is written to disk. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + '1s' + ] + ``` + +### Parameter: `database.persistence.type-aof.type` + +AOF persistence type. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'aof' + ] + ``` + +### Variant: `database.persistence.type-rdb` + + +To use this variant, set the property `type` to `rdb`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`frequency`](#parameter-databasepersistencetype-rdbfrequency) | string | The frequency at which an RDB snapshot of the database is created. | +| [`type`](#parameter-databasepersistencetype-rdbtype) | string | RDB persistence type. | + +### Parameter: `database.persistence.type-rdb.frequency` + +The frequency at which an RDB snapshot of the database is created. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + '12h' + '1h' + '6h' + ] + ``` + +### Parameter: `database.persistence.type-rdb.type` + +RDB persistence type. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'rdb' + ] + ``` ### Parameter: `database.port` @@ -1745,8 +1856,6 @@ Key vault reference and secret settings for the module's secrets export. - Required: No - Type: object -- MinValue: 10000 -- MaxValue: 10000 **Required parameters** @@ -1771,8 +1880,6 @@ The resource ID of the key vault where to store the secrets of this module. - Required: Yes - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `database.secretsExportConfiguration.primaryAccessKeyName` @@ -1780,8 +1887,6 @@ The primaryAccessKey secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `database.secretsExportConfiguration.primaryConnectionStringName` @@ -1789,8 +1894,6 @@ The primaryConnectionString secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `database.secretsExportConfiguration.primaryStackExchangeRedisConnectionStringName` @@ -1798,8 +1901,6 @@ The primaryStackExchangeRedisConnectionString secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `database.secretsExportConfiguration.secondaryAccessKeyName` @@ -1807,8 +1908,6 @@ The secondaryAccessKey secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `database.secretsExportConfiguration.secondaryConnectionStringName` @@ -1816,8 +1915,6 @@ The secondaryConnectionString secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `database.secretsExportConfiguration.secondaryStackExchangeRedisConnectionStringName` @@ -1825,8 +1922,6 @@ The secondaryStackExchangeRedisConnectionString secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `diagnosticSettings` diff --git a/avm/res/cache/redis-enterprise/database/README.md b/avm/res/cache/redis-enterprise/database/README.md index 28382a40a4..96964ad35e 100644 --- a/avm/res/cache/redis-enterprise/database/README.md +++ b/avm/res/cache/redis-enterprise/database/README.md @@ -401,6 +401,117 @@ The persistence settings of the service. type: 'disabled' } ``` +- Type-deciding property: type + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`disabled`](#variant-persistencetype-disabled) | | +| [`aof`](#variant-persistencetype-aof) | | +| [`rdb`](#variant-persistencetype-rdb) | | + +### Variant: `persistence.type-disabled` + + +To use this variant, set the property `type` to `disabled`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`type`](#parameter-persistencetype-disabledtype) | string | Disabled persistence type. | + +### Parameter: `persistence.type-disabled.type` + +Disabled persistence type. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'disabled' + ] + ``` + +### Variant: `persistence.type-aof` + + +To use this variant, set the property `type` to `aof`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`frequency`](#parameter-persistencetype-aoffrequency) | string | The frequency at which data is written to disk. | +| [`type`](#parameter-persistencetype-aoftype) | string | AOF persistence type. | + +### Parameter: `persistence.type-aof.frequency` + +The frequency at which data is written to disk. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + '1s' + ] + ``` + +### Parameter: `persistence.type-aof.type` + +AOF persistence type. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'aof' + ] + ``` + +### Variant: `persistence.type-rdb` + + +To use this variant, set the property `type` to `rdb`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`frequency`](#parameter-persistencetype-rdbfrequency) | string | The frequency at which an RDB snapshot of the database is created. | +| [`type`](#parameter-persistencetype-rdbtype) | string | RDB persistence type. | + +### Parameter: `persistence.type-rdb.frequency` + +The frequency at which an RDB snapshot of the database is created. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + '12h' + '1h' + '6h' + ] + ``` + +### Parameter: `persistence.type-rdb.type` + +RDB persistence type. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'rdb' + ] + ``` ### Parameter: `port` @@ -418,8 +529,6 @@ Key vault reference and secret settings for the module's secrets export. - Required: No - Type: object -- MinValue: 10000 -- MaxValue: 10000 **Required parameters** @@ -444,8 +553,6 @@ The resource ID of the key vault where to store the secrets of this module. - Required: Yes - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `secretsExportConfiguration.primaryAccessKeyName` @@ -453,8 +560,6 @@ The primaryAccessKey secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `secretsExportConfiguration.primaryConnectionStringName` @@ -462,8 +567,6 @@ The primaryConnectionString secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `secretsExportConfiguration.primaryStackExchangeRedisConnectionStringName` @@ -471,8 +574,6 @@ The primaryStackExchangeRedisConnectionString secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `secretsExportConfiguration.secondaryAccessKeyName` @@ -480,8 +581,6 @@ The secondaryAccessKey secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `secretsExportConfiguration.secondaryConnectionStringName` @@ -489,8 +588,6 @@ The secondaryConnectionString secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ### Parameter: `secretsExportConfiguration.secondaryStackExchangeRedisConnectionStringName` @@ -498,8 +595,6 @@ The secondaryStackExchangeRedisConnectionString secret name to create. - Required: No - Type: string -- MinValue: 10000 -- MaxValue: 10000 ## Outputs diff --git a/avm/res/cache/redis/README.md b/avm/res/cache/redis/README.md index a47ace669a..a47cea8a39 100644 --- a/avm/res/cache/redis/README.md +++ b/avm/res/cache/redis/README.md @@ -1989,7 +1989,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -2022,7 +2021,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -2030,7 +2028,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 ### Parameter: `roleAssignments.condition` @@ -2038,7 +2035,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 ### Parameter: `roleAssignments.conditionVersion` @@ -2052,7 +2048,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -2060,7 +2055,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 ### Parameter: `roleAssignments.description` @@ -2068,7 +2062,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 ### Parameter: `roleAssignments.name` @@ -2076,7 +2069,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 ### Parameter: `roleAssignments.principalType` @@ -2094,7 +2086,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 ### Parameter: `secretsExportConfiguration` @@ -2102,7 +2093,6 @@ Key vault reference and secret settings for the module's secrets export. - Required: No - Type: object -- MinValue: 1 **Required parameters** @@ -2127,7 +2117,6 @@ The resource ID of the key vault where to store the secrets of this module. - Required: Yes - Type: string -- MinValue: 1 ### Parameter: `secretsExportConfiguration.primaryAccessKeyName` @@ -2135,7 +2124,6 @@ The primaryAccessKey secret name to create. - Required: No - Type: string -- MinValue: 1 ### Parameter: `secretsExportConfiguration.primaryConnectionStringName` @@ -2143,7 +2131,6 @@ The primaryConnectionString secret name to create. - Required: No - Type: string -- MinValue: 1 ### Parameter: `secretsExportConfiguration.primaryStackExchangeRedisConnectionStringName` @@ -2151,7 +2138,6 @@ The primaryStackExchangeRedisConnectionString secret name to create. - Required: No - Type: string -- MinValue: 1 ### Parameter: `secretsExportConfiguration.secondaryAccessKeyName` @@ -2159,7 +2145,6 @@ The secondaryAccessKey secret name to create. - Required: No - Type: string -- MinValue: 1 ### Parameter: `secretsExportConfiguration.secondaryConnectionStringName` @@ -2167,7 +2152,6 @@ The secondaryConnectionString secret name to create. - Required: No - Type: string -- MinValue: 1 ### Parameter: `secretsExportConfiguration.secondaryStackExchangeRedisConnectionStringName` @@ -2175,7 +2159,6 @@ The secondaryStackExchangeRedisConnectionString secret name to create. - Required: No - Type: string -- MinValue: 1 ### Parameter: `shardCount` @@ -2200,7 +2183,6 @@ The type of Redis cache to deploy. 'Standard' ] ``` -- MinValue: 1 ### Parameter: `staticIP` @@ -2209,7 +2191,6 @@ Static IP address. Optionally, may be specified when deploying a Redis cache ins - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `subnetResourceId` @@ -2218,7 +2199,6 @@ The full resource ID of a subnet in a virtual network to deploy the Redis cache - Required: No - Type: string - Default: `''` -- MinValue: 1 ### Parameter: `tags` @@ -2226,7 +2206,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 1 ### Parameter: `tenantSettings` @@ -2235,7 +2214,6 @@ A dictionary of tenant settings. - Required: No - Type: object - Default: `{}` -- MinValue: 1 ### Parameter: `zoneRedundant` @@ -2244,7 +2222,6 @@ When true, replicas will be provisioned in availability zones specified in the z - Required: No - Type: bool - Default: `True` -- MinValue: 1 ### Parameter: `zones` @@ -2260,7 +2237,6 @@ If the zoneRedundant parameter is true, replicas will be provisioned in the avai 3 ] ``` -- MinValue: 1 ## Outputs diff --git a/avm/res/container-service/managed-cluster/README.md b/avm/res/container-service/managed-cluster/README.md index c89189db84..3e6182c30b 100644 --- a/avm/res/container-service/managed-cluster/README.md +++ b/avm/res/container-service/managed-cluster/README.md @@ -4400,7 +4400,6 @@ Specifies whether the ingressApplicationGateway (AGIC) add-on is enabled or not. - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `istioServiceMeshCertificateAuthority` @@ -4408,7 +4407,6 @@ The Istio Certificate Authority definition. - Required: No - Type: object -- MinValue: 24 **Required parameters** @@ -4426,7 +4424,6 @@ The Certificate chain object name in Azure Key Vault. - Required: Yes - Type: string -- MinValue: 24 ### Parameter: `istioServiceMeshCertificateAuthority.certObjectName` @@ -4434,7 +4431,6 @@ The Intermediate certificate object name in Azure Key Vault. - Required: Yes - Type: string -- MinValue: 24 ### Parameter: `istioServiceMeshCertificateAuthority.keyObjectName` @@ -4442,7 +4438,6 @@ The Intermediate certificate private key object name in Azure Key Vault. - Required: Yes - Type: string -- MinValue: 24 ### Parameter: `istioServiceMeshCertificateAuthority.keyVaultResourceId` @@ -4450,7 +4445,6 @@ The resource ID of a key vault to reference a Certificate Authority from. - Required: Yes - Type: string -- MinValue: 24 ### Parameter: `istioServiceMeshCertificateAuthority.rootCertObjectName` @@ -4458,7 +4452,6 @@ Root certificate object name in Azure Key Vault. - Required: Yes - Type: string -- MinValue: 24 ### Parameter: `istioServiceMeshEnabled` @@ -4467,7 +4460,6 @@ Specifies whether the Istio ServiceMesh add-on is enabled or not. - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `istioServiceMeshExternalIngressGatewayEnabled` @@ -4476,7 +4468,6 @@ Specifies whether the External Istio Ingress Gateway is enabled or not. - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `istioServiceMeshInternalIngressGatewayEnabled` @@ -4485,7 +4476,6 @@ Specifies whether the Internal Istio Ingress Gateway is enabled or not. - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `istioServiceMeshRevisions` @@ -4493,7 +4483,6 @@ The list of revisions of the Istio control plane. When an upgrade is not in prog - Required: No - Type: array -- MinValue: 24 ### Parameter: `kedaAddon` @@ -4502,7 +4491,6 @@ Enables Kubernetes Event-driven Autoscaling (KEDA). - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `kubeDashboardEnabled` @@ -4511,7 +4499,6 @@ Specifies whether the kubeDashboard add-on is enabled or not. - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `kubernetesVersion` @@ -4519,7 +4506,6 @@ Version of Kubernetes specified when creating the managed cluster. - Required: No - Type: string -- MinValue: 24 ### Parameter: `loadBalancerSku` @@ -4535,7 +4521,6 @@ Specifies the sku of the load balancer used by the virtual machine scale sets us 'standard' ] ``` -- MinValue: 24 ### Parameter: `location` @@ -4544,7 +4529,6 @@ Specifies the location of AKS cluster. It picks up Resource Group's location by - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 24 ### Parameter: `lock` @@ -4552,7 +4536,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 24 **Optional parameters** @@ -4575,7 +4558,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 24 ### Parameter: `lock.name` @@ -4583,7 +4565,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 24 ### Parameter: `maintenanceConfigurations` @@ -4591,7 +4572,6 @@ Whether or not to use AKS Automatic mode. - Required: No - Type: array -- MinValue: 24 **Required parameters** @@ -4606,7 +4586,6 @@ Maintenance window for the maintenance configuration. - Required: Yes - Type: object -- MinValue: 24 ### Parameter: `maintenanceConfigurations.name` @@ -4621,7 +4600,6 @@ Name of maintenance window. 'aksManagedNodeOSUpgradeSchedule' ] ``` -- MinValue: 24 ### Parameter: `managedIdentities` @@ -4629,7 +4607,6 @@ The managed identity definition for this resource. Only one type of identity is - Required: No - Type: object -- MinValue: 24 **Optional parameters** @@ -4644,7 +4621,6 @@ Enables system assigned managed identity on the resource. - Required: No - Type: bool -- MinValue: 24 ### Parameter: `managedIdentities.userAssignedResourceIds` @@ -4652,7 +4628,6 @@ The resource ID(s) to assign to the resource. Required if a user assigned identi - Required: No - Type: array -- MinValue: 24 ### Parameter: `managedOutboundIPCount` @@ -4661,7 +4636,6 @@ Outbound IP Count for the Load balancer. - Required: No - Type: int - Default: `0` -- MinValue: 24 ### Parameter: `metricAnnotationsAllowList` @@ -4670,7 +4644,6 @@ A comma-separated list of Kubernetes cluster metrics annotations. - Required: No - Type: string - Default: `''` -- MinValue: 24 ### Parameter: `metricLabelsAllowlist` @@ -4679,7 +4652,6 @@ A comma-separated list of kubernetes cluster metrics labels. - Required: No - Type: string - Default: `''` -- MinValue: 24 ### Parameter: `monitoringWorkspaceResourceId` @@ -4687,7 +4659,6 @@ Resource ID of the monitoring log analytics workspace. - Required: No - Type: string -- MinValue: 24 ### Parameter: `networkDataplane` @@ -4702,7 +4673,6 @@ Network dataplane used in the Kubernetes cluster. Not compatible with kubenet ne 'cilium' ] ``` -- MinValue: 24 ### Parameter: `networkPlugin` @@ -4717,7 +4687,6 @@ Specifies the network plugin used for building Kubernetes network. 'kubenet' ] ``` -- MinValue: 24 ### Parameter: `networkPluginMode` @@ -4731,7 +4700,6 @@ Network plugin mode used for building the Kubernetes network. Not compatible wit 'overlay' ] ``` -- MinValue: 24 ### Parameter: `networkPolicy` @@ -4747,7 +4715,6 @@ Specifies the network policy used for building Kubernetes network. - calico or a 'cilium' ] ``` -- MinValue: 24 ### Parameter: `nodeProvisioningProfileMode` @@ -4762,7 +4729,6 @@ Node provisioning settings that apply to the whole cluster. AUTO MODE IS A PARAM 'Manual' ] ``` -- MinValue: 24 ### Parameter: `nodeResourceGroup` @@ -4771,7 +4737,6 @@ Name of the resource group containing agent pool nodes. - Required: No - Type: string - Default: `[format('{0}_aks_{1}_nodes', resourceGroup().name, parameters('name'))]` -- MinValue: 24 ### Parameter: `nodeResourceGroupProfile` @@ -4779,7 +4744,6 @@ The node resource group configuration profile. - Required: No - Type: object -- MinValue: 24 ### Parameter: `omsAgentEnabled` @@ -4788,7 +4752,6 @@ Specifies whether the OMS agent is enabled. - Required: No - Type: bool - Default: `True` -- MinValue: 24 ### Parameter: `omsAgentUseAADAuth` @@ -4797,7 +4760,6 @@ Specifies whether the OMS agent is using managed identity authentication. - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `openServiceMeshEnabled` @@ -4806,7 +4768,6 @@ Specifies whether the openServiceMesh add-on is enabled or not. - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `outboundType` @@ -4824,7 +4785,6 @@ Specifies outbound (egress) routing method. 'userDefinedRouting' ] ``` -- MinValue: 24 ### Parameter: `podCidr` @@ -4832,7 +4792,6 @@ Specifies the CIDR notation IP range from which to assign pod IPs when kubenet i - Required: No - Type: string -- MinValue: 24 ### Parameter: `podIdentityProfileAllowNetworkPluginKubenet` @@ -4841,7 +4800,6 @@ Running in Kubenet is disabled by default due to the security related nature of - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `podIdentityProfileEnable` @@ -4850,7 +4808,6 @@ Whether the pod identity addon is enabled. - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `podIdentityProfileUserAssignedIdentities` @@ -4858,7 +4815,6 @@ The pod identities to use in the cluster. - Required: No - Type: array -- MinValue: 24 ### Parameter: `podIdentityProfileUserAssignedIdentityExceptions` @@ -4866,7 +4822,6 @@ The pod identity exceptions to allow. - Required: No - Type: array -- MinValue: 24 ### Parameter: `privateDNSZone` @@ -4874,7 +4829,6 @@ Private DNS Zone configuration. Set to 'system' and AKS will create a private DN - Required: No - Type: string -- MinValue: 24 ### Parameter: `publicNetworkAccess` @@ -4891,7 +4845,6 @@ Allow or deny public network access for AKS. 'SecuredByPerimeter' ] ``` -- MinValue: 24 ### Parameter: `roleAssignments` @@ -4899,7 +4852,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 24 - Roles configurable by name: - `'Azure Kubernetes Fleet Manager Contributor Role'` - `'Azure Kubernetes Fleet Manager RBAC Admin'` @@ -4945,7 +4897,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 24 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -4953,7 +4904,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 24 ### Parameter: `roleAssignments.condition` @@ -4961,7 +4911,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 24 ### Parameter: `roleAssignments.conditionVersion` @@ -4975,7 +4924,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 24 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -4983,7 +4931,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 24 ### Parameter: `roleAssignments.description` @@ -4991,7 +4938,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 24 ### Parameter: `roleAssignments.name` @@ -4999,7 +4945,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 24 ### Parameter: `roleAssignments.principalType` @@ -5017,7 +4962,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 24 ### Parameter: `serviceCidr` @@ -5025,7 +4969,6 @@ A CIDR notation IP range from which to assign service cluster IPs. It must not o - Required: No - Type: string -- MinValue: 24 ### Parameter: `skuName` @@ -5041,7 +4984,6 @@ Name of a managed cluster SKU. AUTOMATIC CLUSTER SKU IS A PARAMETER USED FOR A P 'Base' ] ``` -- MinValue: 24 ### Parameter: `skuTier` @@ -5058,7 +5000,6 @@ Tier of a managed cluster SKU. 'Standard' ] ``` -- MinValue: 24 ### Parameter: `sshPublicKey` @@ -5066,7 +5007,6 @@ Specifies the SSH RSA public key string for the Linux nodes. - Required: No - Type: string -- MinValue: 24 ### Parameter: `supportPlan` @@ -5082,7 +5022,6 @@ The support plan for the Managed Cluster. 'KubernetesOfficial' ] ``` -- MinValue: 24 ### Parameter: `syslogPort` @@ -5091,7 +5030,6 @@ The syslog host port. If not specified, the default port is 28330. - Required: No - Type: int - Default: `28330` -- MinValue: 24 ### Parameter: `tags` @@ -5099,7 +5037,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 24 ### Parameter: `vpaAddon` @@ -5108,7 +5045,6 @@ Whether to enable VPA add-on in cluster. Default value is false. - Required: No - Type: bool - Default: `False` -- MinValue: 24 ### Parameter: `webApplicationRoutingEnabled` @@ -5117,7 +5053,6 @@ Specifies whether the webApplicationRoutingEnabled add-on is enabled or not. - Required: No - Type: bool - Default: `False` -- MinValue: 24 ## Outputs diff --git a/avm/res/container-service/managed-cluster/agent-pool/README.md b/avm/res/container-service/managed-cluster/agent-pool/README.md index f5aefdd3da..e3ffd43e4c 100644 --- a/avm/res/container-service/managed-cluster/agent-pool/README.md +++ b/avm/res/container-service/managed-cluster/agent-pool/README.md @@ -115,8 +115,6 @@ Whether to enable auto-scaler. - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `enableEncryptionAtHost` @@ -125,8 +123,6 @@ This is only supported on certain VM sizes and in certain Azure regions. For mor - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `enableFIPS` @@ -135,8 +131,6 @@ See Add a FIPS-enabled node pool (https://learn.microsoft.com/en-us/azure/aks/us - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `enableNodePublicIP` @@ -145,8 +139,6 @@ Some scenarios may require nodes in a node pool to receive their own dedicated p - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `enableSecureBoot` @@ -155,8 +147,6 @@ Secure Boot is a feature of Trusted Launch which ensures that only signed operat - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `enableUltraSSD` @@ -165,8 +155,6 @@ Whether to enable UltraSSD. - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `enableVTPM` @@ -175,8 +163,6 @@ vTPM is a Trusted Launch feature for configuring a dedicated secure vault for ke - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `gpuInstanceProfile` @@ -194,8 +180,6 @@ GPUInstanceProfile to be used to specify GPU MIG instance profile for supported 'MIG7g' ] ``` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `kubeletDiskType` @@ -203,8 +187,6 @@ Determines the placement of emptyDir volumes, container runtime data root, and K - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `maxCount` @@ -212,8 +194,6 @@ The maximum number of nodes for auto-scaling. - Required: No - Type: int -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `maxPods` @@ -221,8 +201,6 @@ The maximum number of pods that can run on a node. - Required: No - Type: int -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `maxSurge` @@ -230,8 +208,6 @@ This can either be set to an integer (e.g. "5") or a percentage (e.g. "50%"). If - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `minCount` @@ -239,8 +215,6 @@ The minimum number of nodes for auto-scaling. - Required: No - Type: int -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `mode` @@ -248,8 +222,6 @@ A cluster must have at least one "System" Agent Pool at all times. For additiona - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `nodeLabels` @@ -257,8 +229,6 @@ The node labels to be persisted across all nodes in agent pool. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `nodePublicIpPrefixResourceId` @@ -266,8 +236,6 @@ ResourceId of the node PublicIPPrefix. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `nodeTaints` @@ -275,8 +243,6 @@ The taints added to new nodes during node pool create and scale. For example, ke - Required: No - Type: array -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `orchestratorVersion` @@ -284,8 +250,6 @@ As a best practice, you should upgrade all node pools in an AKS cluster to the s - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `osDiskSizeGB` @@ -293,8 +257,6 @@ OS Disk Size in GB to be used to specify the disk size for every machine in the - Required: No - Type: int -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `osDiskType` @@ -309,8 +271,6 @@ The default is "Ephemeral" if the VM supports it and has a cache disk larger tha 'Managed' ] ``` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `osSKU` @@ -328,8 +288,6 @@ Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is 'Windows2022' ] ``` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `osType` @@ -345,8 +303,6 @@ The operating system type. The default is Linux. 'Windows' ] ``` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `podSubnetResourceId` @@ -354,8 +310,6 @@ Subnet resource ID for the pod IPs. If omitted, pod IPs are statically assigned - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `proximityPlacementGroupResourceId` @@ -363,8 +317,6 @@ The ID for the Proximity Placement Group. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `scaleDownMode` @@ -380,8 +332,6 @@ Describes how VMs are added to or removed from Agent Pools. See [billing states] 'Delete' ] ``` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `scaleSetEvictionPolicy` @@ -397,8 +347,6 @@ The eviction policy specifies what to do with the VM when it is evicted. The def 'Delete' ] ``` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `scaleSetPriority` @@ -413,8 +361,6 @@ The Virtual Machine Scale Set priority. 'Spot' ] ``` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `sourceResourceId` @@ -422,8 +368,6 @@ This is the ARM ID of the source object to be used to create the target object. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `spotMaxPrice` @@ -431,8 +375,6 @@ Possible values are any decimal value greater than zero or -1 which indicates th - Required: No - Type: int -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `tags` @@ -440,8 +382,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `type` @@ -449,8 +389,6 @@ The type of Agent Pool. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `vmSize` @@ -459,8 +397,6 @@ VM size. VM size availability varies by region. If a node contains insufficient - Required: No - Type: string - Default: `'Standard_D2s_v3'` -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `vnetSubnetResourceId` @@ -468,8 +404,6 @@ Node Subnet ID. If this is not specified, a VNET and subnet will be generated an - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ### Parameter: `workloadRuntime` @@ -477,8 +411,6 @@ Determines the type of workload a node can run. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 1000 ## Outputs diff --git a/avm/res/db-for-my-sql/flexible-server/README.md b/avm/res/db-for-my-sql/flexible-server/README.md index d3e1095566..e8654878a0 100644 --- a/avm/res/db-for-my-sql/flexible-server/README.md +++ b/avm/res/db-for-my-sql/flexible-server/README.md @@ -1126,8 +1126,6 @@ The mode to create a new MySQL server. 'Replica' ] ``` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `customerManagedKey` @@ -1135,8 +1133,6 @@ The customer managed key definition to use for the managed service. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 35 **Required parameters** @@ -1158,8 +1154,6 @@ The name of the customer managed key to use for encryption. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `customerManagedKey.keyVaultResourceId` @@ -1167,8 +1161,6 @@ The resource ID of a key vault to reference a customer managed key for encryptio - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `customerManagedKey.keyVersion` @@ -1176,8 +1168,6 @@ The version of the customer managed key to reference for encryption. If not prov - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `customerManagedKey.userAssignedIdentityResourceId` @@ -1185,8 +1175,6 @@ User assigned identity to use when fetching the customer managed key. Required i - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `customerManagedKeyGeo` @@ -1194,8 +1182,6 @@ The customer managed key definition to use when geoRedundantBackup is "Enabled". - Required: No - Type: object -- MinValue: 1 -- MaxValue: 35 **Required parameters** @@ -1217,8 +1203,6 @@ The name of the customer managed key to use for encryption. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `customerManagedKeyGeo.keyVaultResourceId` @@ -1226,8 +1210,6 @@ The resource ID of a key vault to reference a customer managed key for encryptio - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `customerManagedKeyGeo.keyVersion` @@ -1235,8 +1217,6 @@ The version of the customer managed key to reference for encryption. If not prov - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `customerManagedKeyGeo.userAssignedIdentityResourceId` @@ -1244,8 +1224,6 @@ User assigned identity to use when fetching the customer managed key. Required i - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `databases` @@ -1254,8 +1232,6 @@ The databases to create in the server. - Required: No - Type: array - Default: `[]` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `delegatedSubnetResourceId` @@ -1263,8 +1239,6 @@ Delegated subnet arm resource ID. Used when the desired connectivity mode is "Pr - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings` @@ -1272,8 +1246,6 @@ The diagnostic settings of the service. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 35 **Optional parameters** @@ -1295,8 +1267,6 @@ Resource ID of the diagnostic event hub authorization rule for the Event Hubs na - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.eventHubName` @@ -1304,8 +1274,6 @@ Name of the diagnostic event hub within the namespace to which logs are streamed - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.logAnalyticsDestinationType` @@ -1320,8 +1288,6 @@ A string indicating whether the export to Log Analytics should use the default d 'Dedicated' ] ``` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.logCategoriesAndGroups` @@ -1329,8 +1295,6 @@ The name of logs that will be streamed. "allLogs" includes all possible logs for - Required: No - Type: array -- MinValue: 1 -- MaxValue: 35 **Optional parameters** @@ -1346,8 +1310,6 @@ Name of a Diagnostic Log category for a resource type this setting is applied to - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.categoryGroup` @@ -1355,8 +1317,6 @@ Name of a Diagnostic Log category group for a resource type this setting is appl - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.enabled` @@ -1364,8 +1324,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.marketplacePartnerResourceId` @@ -1373,8 +1331,6 @@ The full ARM resource ID of the Marketplace resource to which you would like to - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.metricCategories` @@ -1382,8 +1338,6 @@ The name of metrics that will be streamed. "allMetrics" includes all possible me - Required: No - Type: array -- MinValue: 1 -- MaxValue: 35 **Required parameters** @@ -1403,8 +1357,6 @@ Name of a Diagnostic Metric category for a resource type this setting is applied - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.metricCategories.enabled` @@ -1412,8 +1364,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.name` @@ -1421,8 +1371,6 @@ The name of the diagnostic setting. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.storageAccountResourceId` @@ -1430,8 +1378,6 @@ Resource ID of the diagnostic storage account. For security reasons, it is recom - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `diagnosticSettings.workspaceResourceId` @@ -1439,8 +1385,6 @@ Resource ID of the diagnostic log analytics workspace. For security reasons, it - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `enableTelemetry` @@ -1449,8 +1393,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `firewallRules` @@ -1459,8 +1401,6 @@ The firewall rules to create in the MySQL flexible server. - Required: No - Type: array - Default: `[]` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `geoRedundantBackup` @@ -1476,8 +1416,6 @@ A value indicating whether Geo-Redundant backup is enabled on the server. If "En 'Enabled' ] ``` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `highAvailability` @@ -1494,8 +1432,6 @@ The mode for High Availability (HA). It is not supported for the Burstable prici 'ZoneRedundant' ] ``` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `highAvailabilityZone` @@ -1504,8 +1440,6 @@ Standby availability zone information of the server. Default will have no prefer - Required: No - Type: string - Default: `''` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `location` @@ -1514,8 +1448,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `lock` @@ -1523,8 +1455,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 35 **Optional parameters** @@ -1547,8 +1477,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `lock.name` @@ -1556,8 +1484,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `maintenanceWindow` @@ -1566,8 +1492,6 @@ Properties for the maintenence window. If provided, "customWindow" property must - Required: No - Type: object - Default: `{}` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `publicNetworkAccess` @@ -1583,8 +1507,6 @@ Specifies whether public network access is allowed for this server. Set to "Enab 'Enabled' ] ``` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `replicationRole` @@ -1601,8 +1523,6 @@ The replication role. 'Source' ] ``` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `roleAssignments` @@ -1610,8 +1530,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 35 - Roles configurable by name: - `'Contributor'` - `'MySQL Backup And Export Operator'` @@ -1644,8 +1562,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -1653,8 +1569,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `roleAssignments.condition` @@ -1662,8 +1576,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `roleAssignments.conditionVersion` @@ -1677,8 +1589,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -1686,8 +1596,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `roleAssignments.description` @@ -1695,8 +1603,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `roleAssignments.name` @@ -1704,8 +1610,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 35 ### Parameter: `roleAssignments.principalType` @@ -1723,8 +1627,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `storageAutoIoScaling` @@ -1740,8 +1642,6 @@ Enable IO Auto Scaling or not. The server scales IOPs up or down automatically d 'Enabled' ] ``` -- MinValue: 1 -- MaxValue: 35 ### Parameter: `storageIOPS` @@ -1776,8 +1676,6 @@ Max storage allowed for a server. In all compute tiers, the minimum storage supp 16384 ] ``` -- MinValue: 360 -- MaxValue: 48000 ### Parameter: `tags` @@ -1785,8 +1683,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 360 -- MaxValue: 48000 ### Parameter: `version` @@ -1802,8 +1698,6 @@ MySQL Server version. '8.0.21' ] ``` -- MinValue: 360 -- MaxValue: 48000 ## Outputs diff --git a/avm/res/db-for-postgre-sql/flexible-server/README.md b/avm/res/db-for-postgre-sql/flexible-server/README.md index c4b73fcbce..2147531553 100644 --- a/avm/res/db-for-postgre-sql/flexible-server/README.md +++ b/avm/res/db-for-postgre-sql/flexible-server/README.md @@ -1499,8 +1499,6 @@ The configurations to create in the server. - Required: No - Type: array - Default: `[]` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `createMode` @@ -1520,8 +1518,6 @@ The mode to create a new PostgreSQL server. 'Update' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `customerManagedKey` @@ -1529,8 +1525,6 @@ The customer managed key definition. - Required: No - Type: object -- MinValue: 7 -- MaxValue: 35 **Required parameters** @@ -1552,8 +1546,6 @@ The name of the customer managed key to use for encryption. - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `customerManagedKey.keyVaultResourceId` @@ -1561,8 +1553,6 @@ The resource ID of a key vault to reference a customer managed key for encryptio - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `customerManagedKey.keyVersion` @@ -1570,8 +1560,6 @@ The version of the customer managed key to reference for encryption. If not prov - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `customerManagedKey.userAssignedIdentityResourceId` @@ -1579,8 +1567,6 @@ User assigned identity to use when fetching the customer managed key. Required i - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `databases` @@ -1589,8 +1575,6 @@ The databases to create in the server. - Required: No - Type: array - Default: `[]` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `delegatedSubnetResourceId` @@ -1599,8 +1583,6 @@ Delegated subnet arm resource ID. Used when the desired connectivity mode is 'Pr - Required: No - Type: string - Default: `''` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings` @@ -1608,8 +1590,6 @@ The diagnostic settings of the service. - Required: No - Type: array -- MinValue: 7 -- MaxValue: 35 **Optional parameters** @@ -1631,8 +1611,6 @@ Resource ID of the diagnostic event hub authorization rule for the Event Hubs na - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.eventHubName` @@ -1640,8 +1618,6 @@ Name of the diagnostic event hub within the namespace to which logs are streamed - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.logAnalyticsDestinationType` @@ -1656,8 +1632,6 @@ A string indicating whether the export to Log Analytics should use the default d 'Dedicated' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.logCategoriesAndGroups` @@ -1665,8 +1639,6 @@ The name of logs that will be streamed. "allLogs" includes all possible logs for - Required: No - Type: array -- MinValue: 7 -- MaxValue: 35 **Optional parameters** @@ -1682,8 +1654,6 @@ Name of a Diagnostic Log category for a resource type this setting is applied to - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.categoryGroup` @@ -1691,8 +1661,6 @@ Name of a Diagnostic Log category group for a resource type this setting is appl - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.enabled` @@ -1700,8 +1668,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.marketplacePartnerResourceId` @@ -1709,8 +1675,6 @@ The full ARM resource ID of the Marketplace resource to which you would like to - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.metricCategories` @@ -1718,8 +1682,6 @@ The name of metrics that will be streamed. "allMetrics" includes all possible me - Required: No - Type: array -- MinValue: 7 -- MaxValue: 35 **Required parameters** @@ -1739,8 +1701,6 @@ Name of a Diagnostic Metric category for a resource type this setting is applied - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.metricCategories.enabled` @@ -1748,8 +1708,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.name` @@ -1757,8 +1715,6 @@ The name of the diagnostic setting. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.storageAccountResourceId` @@ -1766,8 +1722,6 @@ Resource ID of the diagnostic storage account. For security reasons, it is recom - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `diagnosticSettings.workspaceResourceId` @@ -1775,8 +1729,6 @@ Resource ID of the diagnostic log analytics workspace. For security reasons, it - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `enableAdvancedThreatProtection` @@ -1785,8 +1737,6 @@ Enable/Disable advanced threat protection. - Required: No - Type: bool - Default: `True` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `enableTelemetry` @@ -1795,8 +1745,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `firewallRules` @@ -1805,8 +1753,6 @@ The firewall rules to create in the PostgreSQL flexible server. - Required: No - Type: array - Default: `[]` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `geoRedundantBackup` @@ -1822,8 +1768,6 @@ A value indicating whether Geo-Redundant backup is enabled on the server. Should 'Enabled' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `highAvailability` @@ -1840,8 +1784,6 @@ The mode for high availability. 'ZoneRedundant' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `location` @@ -1850,8 +1792,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `lock` @@ -1859,8 +1799,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 7 -- MaxValue: 35 **Optional parameters** @@ -1883,8 +1821,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `lock.name` @@ -1892,8 +1828,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `maintenanceWindow` @@ -1910,8 +1844,6 @@ Properties for the maintenence window. If provided, 'customWindow' property must startMinute: 0 } ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateDnsZoneArmResourceId` @@ -1920,8 +1852,6 @@ Private dns zone arm resource ID. Used when the desired connectivity mode is 'Pr - Required: No - Type: string - Default: `''` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints` @@ -1929,8 +1859,6 @@ Configuration details for private endpoints. Used when the desired connectivity - Required: No - Type: array -- MinValue: 7 -- MaxValue: 35 **Required parameters** @@ -1965,8 +1893,6 @@ Resource ID of the subnet where the endpoint needs to be created. - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.applicationSecurityGroupResourceIds` @@ -1974,8 +1900,6 @@ Application security groups in which the Private Endpoint IP configuration is in - Required: No - Type: array -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.customDnsConfigs` @@ -1983,8 +1907,6 @@ Custom DNS configurations. - Required: No - Type: array -- MinValue: 7 -- MaxValue: 35 **Required parameters** @@ -2004,8 +1926,6 @@ A list of private IP addresses of the private endpoint. - Required: Yes - Type: array -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.customDnsConfigs.fqdn` @@ -2013,8 +1933,6 @@ FQDN that resolves to private endpoint IP address. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.customNetworkInterfaceName` @@ -2022,8 +1940,6 @@ The custom name of the network interface attached to the Private Endpoint. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.enableTelemetry` @@ -2031,8 +1947,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.ipConfigurations` @@ -2040,8 +1954,6 @@ A list of IP configurations of the Private Endpoint. This will be used to map to - Required: No - Type: array -- MinValue: 7 -- MaxValue: 35 **Required parameters** @@ -2056,8 +1968,6 @@ The name of the resource that is unique within a resource group. - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.ipConfigurations.properties` @@ -2065,8 +1975,6 @@ Properties of private endpoint IP configurations. - Required: Yes - Type: object -- MinValue: 7 -- MaxValue: 35 **Required parameters** @@ -2082,8 +1990,6 @@ The ID of a group obtained from the remote resource that this private endpoint s - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.ipConfigurations.properties.memberName` @@ -2091,8 +1997,6 @@ The member name of a group obtained from the remote resource that this private e - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.ipConfigurations.properties.privateIPAddress` @@ -2100,8 +2004,6 @@ A private IP address obtained from the private endpoint's subnet. - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.isManualConnection` @@ -2109,8 +2011,6 @@ If Manual Private Link Connection is required. - Required: No - Type: bool -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.location` @@ -2118,8 +2018,6 @@ The location to deploy the Private Endpoint to. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.lock` @@ -2127,8 +2025,6 @@ Specify the type of lock. - Required: No - Type: object -- MinValue: 7 -- MaxValue: 35 **Optional parameters** @@ -2151,8 +2047,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.lock.name` @@ -2160,8 +2054,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.manualConnectionRequestMessage` @@ -2169,8 +2061,6 @@ A message passed to the owner of the remote resource with the manual connection - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.name` @@ -2178,8 +2068,6 @@ The name of the Private Endpoint. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.privateDnsZoneGroup` @@ -2187,8 +2075,6 @@ The private DNS Zone Group to configure for the Private Endpoint. - Required: No - Type: object -- MinValue: 7 -- MaxValue: 35 **Required parameters** @@ -2208,8 +2094,6 @@ The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group - Required: Yes - Type: array -- MinValue: 7 -- MaxValue: 35 **Required parameters** @@ -2229,8 +2113,6 @@ The resource id of the private DNS zone. - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name` @@ -2238,8 +2120,6 @@ The name of the private DNS Zone Group config. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.privateDnsZoneGroup.name` @@ -2247,8 +2127,6 @@ The name of the Private DNS Zone Group. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.privateLinkServiceConnectionName` @@ -2256,8 +2134,6 @@ The name of the private link connection to create. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.resourceGroupResourceId` @@ -2265,8 +2141,6 @@ The resource ID of the Resource Group the Private Endpoint will be created in. I - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.roleAssignments` @@ -2274,8 +2148,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 7 -- MaxValue: 35 - Roles configurable by name: - `'Contributor'` - `'DNS Resolver Contributor'` @@ -2312,8 +2184,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.roleAssignments.roleDefinitionIdOrName` @@ -2321,8 +2191,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.roleAssignments.condition` @@ -2330,8 +2198,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.roleAssignments.conditionVersion` @@ -2345,8 +2211,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId` @@ -2354,8 +2218,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.roleAssignments.description` @@ -2363,8 +2225,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.roleAssignments.name` @@ -2372,8 +2232,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.roleAssignments.principalType` @@ -2391,8 +2249,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.service` @@ -2400,8 +2256,6 @@ The subresource to deploy the Private Endpoint for. For example "vault" for a Ke - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `privateEndpoints.tags` @@ -2409,8 +2263,6 @@ Tags to be applied on all resources/Resource Groups in this deployment. - Required: No - Type: object -- MinValue: 7 -- MaxValue: 35 ### Parameter: `publicNetworkAccess` @@ -2426,8 +2278,6 @@ Determines whether or not public network access is enabled or not. 'Enabled' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `replica` @@ -2435,8 +2285,6 @@ The replication settings for the server. Can only be set on existing flexible se - Required: No - Type: object -- MinValue: 7 -- MaxValue: 35 **Conditional parameters** @@ -2459,8 +2307,6 @@ Sets the promote mode for a replica server. This is a write only property. 'stan 'switchover' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `replica.promoteOption` @@ -2475,8 +2321,6 @@ Sets the promote options for a replica server. This is a write only property. 'f 'planned' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `replica.role` @@ -2493,8 +2337,6 @@ Used to indicate role of the server in replication set. 'AsyncReplica', 'GeoAsyn 'Primary' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `roleAssignments` @@ -2502,8 +2344,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 7 -- MaxValue: 35 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -2535,8 +2375,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -2544,8 +2382,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `roleAssignments.condition` @@ -2553,8 +2389,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `roleAssignments.conditionVersion` @@ -2568,8 +2402,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -2577,8 +2409,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `roleAssignments.description` @@ -2586,8 +2416,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `roleAssignments.name` @@ -2595,8 +2423,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `roleAssignments.principalType` @@ -2614,8 +2440,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `serverThreatProtection` @@ -2631,8 +2455,6 @@ Specifies the state of the Threat Protection, whether it is enabled or disabled 'Enabled' ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `storageSizeGB` @@ -2656,8 +2478,6 @@ Max storage allowed for a server. 16384 ] ``` -- MinValue: 7 -- MaxValue: 35 ### Parameter: `tags` @@ -2665,8 +2485,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 7 -- MaxValue: 35 ### Parameter: `tenantId` @@ -2674,8 +2492,6 @@ Tenant id of the server. - Required: No - Type: string -- MinValue: 7 -- MaxValue: 35 ### Parameter: `version` @@ -2695,8 +2511,6 @@ PostgreSQL Server version. '16' ] ``` -- MinValue: 7 -- MaxValue: 35 ## Outputs diff --git a/avm/res/dev-ops-infrastructure/pool/README.md b/avm/res/dev-ops-infrastructure/pool/README.md index d9810aebf5..a0192ed3e7 100644 --- a/avm/res/dev-ops-infrastructure/pool/README.md +++ b/avm/res/dev-ops-infrastructure/pool/README.md @@ -1692,8 +1692,6 @@ The resource id of the DevCenter Project the pool belongs to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `fabricProfileSkuName` @@ -1701,8 +1699,6 @@ The Azure SKU name of the machines in the pool. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `images` @@ -1710,8 +1706,6 @@ The VM images of the machines in the pool. - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 10000 **Conditional parameters** @@ -1733,8 +1727,6 @@ The specific resource id of the marketplace or compute gallery image. Required i - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `images.wellKnownImageName` @@ -1742,8 +1734,6 @@ The image to use from a well-known set of images made available to customers. Re - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `images.aliases` @@ -1751,8 +1741,6 @@ List of aliases to reference the image by. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `images.buffer` @@ -1760,8 +1748,6 @@ The percentage of the buffer to be allocated to this image. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `name` @@ -1769,8 +1755,6 @@ Name of the pool. It needs to be globally unique. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `organizationProfile` @@ -1778,8 +1762,6 @@ Defines the organization in which the pool will be used. - Required: Yes - Type: object -- MinValue: 1 -- MaxValue: 10000 **Required parameters** @@ -1806,8 +1788,6 @@ Azure DevOps organization profile. 'AzureDevOps' ] ``` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `organizationProfile.organizations` @@ -1815,8 +1795,6 @@ The list of Azure DevOps organizations the pool should be present in.. - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 10000 **Required parameters** @@ -1837,8 +1815,6 @@ The Azure DevOps organization URL in which the pool should be created. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `organizationProfile.organizations.parallelism` @@ -1855,8 +1831,6 @@ List of projects in which the pool should be created. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `organizationProfile.permissionProfile` @@ -1864,8 +1838,6 @@ The type of permission which determines which accounts are admins on the Azure D - Required: No - Type: object -- MinValue: 1 -- MaxValue: 10000 **Required parameters** @@ -1894,8 +1866,6 @@ Determines who has admin permissions to the Azure DevOps pool. 'SpecificAccounts' ] ``` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `organizationProfile.permissionProfile.groups` @@ -1903,8 +1873,6 @@ Group email addresses. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `organizationProfile.permissionProfile.users` @@ -1912,8 +1880,6 @@ User email addresses. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings` @@ -1921,8 +1887,6 @@ The diagnostic settings of the service. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10000 **Optional parameters** @@ -1944,8 +1908,6 @@ Resource ID of the diagnostic event hub authorization rule for the Event Hubs na - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.eventHubName` @@ -1953,8 +1915,6 @@ Name of the diagnostic event hub within the namespace to which logs are streamed - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.logAnalyticsDestinationType` @@ -1969,8 +1929,6 @@ A string indicating whether the export to Log Analytics should use the default d 'Dedicated' ] ``` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.logCategoriesAndGroups` @@ -1978,8 +1936,6 @@ The name of logs that will be streamed. "allLogs" includes all possible logs for - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10000 **Optional parameters** @@ -1995,8 +1951,6 @@ Name of a Diagnostic Log category for a resource type this setting is applied to - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.categoryGroup` @@ -2004,8 +1958,6 @@ Name of a Diagnostic Log category group for a resource type this setting is appl - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.enabled` @@ -2013,8 +1965,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.marketplacePartnerResourceId` @@ -2022,8 +1972,6 @@ The full ARM resource ID of the Marketplace resource to which you would like to - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.metricCategories` @@ -2031,8 +1979,6 @@ The name of metrics that will be streamed. "allMetrics" includes all possible me - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10000 **Required parameters** @@ -2052,8 +1998,6 @@ Name of a Diagnostic Metric category for a resource type this setting is applied - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.metricCategories.enabled` @@ -2061,8 +2005,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.name` @@ -2070,8 +2012,6 @@ The name of the diagnostic setting. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.storageAccountResourceId` @@ -2079,8 +2019,6 @@ Resource ID of the diagnostic storage account. For security reasons, it is recom - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `diagnosticSettings.workspaceResourceId` @@ -2088,8 +2026,6 @@ Resource ID of the diagnostic log analytics workspace. For security reasons, it - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `enableTelemetry` @@ -2098,8 +2034,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `location` @@ -2108,8 +2042,6 @@ The geo-location where the resource lives. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `lock` @@ -2117,8 +2049,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 10000 **Optional parameters** @@ -2141,8 +2071,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `lock.name` @@ -2150,8 +2078,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `managedIdentities` @@ -2159,8 +2085,6 @@ The managed service identities assigned to this resource. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 10000 - Example: ```Bicep { @@ -2187,8 +2111,6 @@ Enables system assigned managed identity on the resource. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `managedIdentities.userAssignedResourceIds` @@ -2196,8 +2118,6 @@ The resource ID(s) to assign to the resource. Required if a user assigned identi - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `osProfile` @@ -2215,8 +2135,6 @@ The OS profile of the agents in the pool. } } ``` -- MinValue: 1 -- MaxValue: 10000 **Required parameters** @@ -2243,8 +2161,6 @@ The logon type of the machine. 'Service' ] ``` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `osProfile.secretsManagementSettings` @@ -2252,8 +2168,6 @@ The secret management settings of the machines in the pool. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 10000 **Required parameters** @@ -2274,8 +2188,6 @@ The secret management settings of the machines in the pool. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `osProfile.secretsManagementSettings.observedCertificates` @@ -2283,8 +2195,6 @@ The list of certificates to install on all machines in the pool. - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `osProfile.secretsManagementSettings.certificateStoreLocation` @@ -2292,8 +2202,6 @@ Where to store certificates on the machine. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `roleAssignments` @@ -2301,8 +2209,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10000 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -2334,8 +2240,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -2343,8 +2247,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `roleAssignments.condition` @@ -2352,8 +2254,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `roleAssignments.conditionVersion` @@ -2367,8 +2267,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -2376,8 +2274,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `roleAssignments.description` @@ -2385,8 +2281,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `roleAssignments.name` @@ -2394,8 +2288,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `roleAssignments.principalType` @@ -2413,8 +2305,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `storageProfile` @@ -2422,8 +2312,6 @@ The storage profile of the machines in the pool. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 10000 **Optional parameters** @@ -2438,8 +2326,6 @@ A list of empty data disks to attach. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 10000 **Optional parameters** @@ -2464,8 +2350,6 @@ The type of caching to be enabled for the data disks. The default value for cach 'ReadWrite' ] ``` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `storageProfile.dataDisks.diskSizeGiB` @@ -2473,8 +2357,6 @@ The initial disk size in gigabytes. - Required: No - Type: int -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `storageProfile.dataDisks.driveLetter` @@ -2482,8 +2364,6 @@ The drive letter for the empty data disk. If not specified, it will be the first - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `storageProfile.dataDisks.storageAccountType` @@ -2501,8 +2381,6 @@ The storage Account type to be used for the data disk. If omitted, the default i 'StandardSSD_ZRS' ] ``` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `storageProfile.osDiskStorageAccountType` @@ -2518,8 +2396,6 @@ The Azure SKU name of the machines in the pool. 'StandardSSD' ] ``` -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `subnetResourceId` @@ -2527,8 +2403,6 @@ The subnet id on which to put all machines created in the pool. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 10000 ### Parameter: `tags` @@ -2536,8 +2410,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 10000 ## Outputs diff --git a/avm/res/document-db/database-account/README.md b/avm/res/document-db/database-account/README.md index 0056dba9a8..29341a9610 100644 --- a/avm/res/document-db/database-account/README.md +++ b/avm/res/document-db/database-account/README.md @@ -3110,8 +3110,6 @@ Default to Continuous30Days. Configuration values for continuous mode backup. 'Continuous7Days' ] ``` -- MinValue: 60 -- MaxValue: 1440 ### Parameter: `backupPolicyType` @@ -3127,8 +3125,6 @@ Default to Continuous. Describes the mode of backups. Periodic backup must be us 'Periodic' ] ``` -- MinValue: 60 -- MaxValue: 1440 ### Parameter: `backupRetentionIntervalInHours` @@ -3155,8 +3151,6 @@ Default to Local. Enum to indicate type of backup residency. Only applies to per 'Zone' ] ``` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `capabilitiesToAdd` @@ -3180,8 +3174,6 @@ List of Cosmos DB capabilities for the account. THE DeleteAllItemsByPartitionKey 'EnableTable' ] ``` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `databaseAccountOfferType` @@ -3196,8 +3188,6 @@ Default to Standard. The offer type for the Azure Cosmos DB database account. 'Standard' ] ``` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `defaultConsistencyLevel` @@ -3216,8 +3206,6 @@ Default to Session. The default consistency level of the Cosmos DB account. 'Strong' ] ``` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings` @@ -3225,8 +3213,6 @@ The diagnostic settings of the service. - Required: No - Type: array -- MinValue: 2 -- MaxValue: 720 **Optional parameters** @@ -3248,8 +3234,6 @@ Resource ID of the diagnostic event hub authorization rule for the Event Hubs na - Required: No - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.eventHubName` @@ -3257,8 +3241,6 @@ Name of the diagnostic event hub within the namespace to which logs are streamed - Required: No - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.logAnalyticsDestinationType` @@ -3273,8 +3255,6 @@ A string indicating whether the export to Log Analytics should use the default d 'Dedicated' ] ``` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.logCategoriesAndGroups` @@ -3282,8 +3262,6 @@ The name of logs that will be streamed. "allLogs" includes all possible logs for - Required: No - Type: array -- MinValue: 2 -- MaxValue: 720 **Optional parameters** @@ -3299,8 +3277,6 @@ Name of a Diagnostic Log category for a resource type this setting is applied to - Required: No - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.categoryGroup` @@ -3308,8 +3284,6 @@ Name of a Diagnostic Log category group for a resource type this setting is appl - Required: No - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.enabled` @@ -3317,8 +3291,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.marketplacePartnerResourceId` @@ -3326,8 +3298,6 @@ The full ARM resource ID of the Marketplace resource to which you would like to - Required: No - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.metricCategories` @@ -3335,8 +3305,6 @@ The name of metrics that will be streamed. "allMetrics" includes all possible me - Required: No - Type: array -- MinValue: 2 -- MaxValue: 720 **Required parameters** @@ -3356,8 +3324,6 @@ Name of a Diagnostic Metric category for a resource type this setting is applied - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.metricCategories.enabled` @@ -3365,8 +3331,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.name` @@ -3374,8 +3338,6 @@ The name of diagnostic setting. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.storageAccountResourceId` @@ -3383,8 +3345,6 @@ Resource ID of the diagnostic storage account. For security reasons, it is recom - Required: No - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `diagnosticSettings.workspaceResourceId` @@ -3392,8 +3352,6 @@ Resource ID of the diagnostic log analytics workspace. For security reasons, it - Required: No - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `disableKeyBasedMetadataWriteAccess` @@ -3402,8 +3360,6 @@ Default to true. Disable write operations on metadata resources (databases, cont - Required: No - Type: bool - Default: `True` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `disableLocalAuth` @@ -3412,8 +3368,6 @@ Default to true. Opt-out of local authentication and ensure only MSI and AAD can - Required: No - Type: bool - Default: `True` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `enableAnalyticalStorage` @@ -3422,8 +3376,6 @@ Default to false. Flag to indicate whether to enable storage analytics. - Required: No - Type: bool - Default: `False` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `enableFreeTier` @@ -3432,8 +3384,6 @@ Default to false. Flag to indicate whether Free Tier is enabled. - Required: No - Type: bool - Default: `False` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `enableMultipleWriteLocations` @@ -3442,8 +3392,6 @@ Default to false. Enables the account to write in multiple locations. Periodic b - Required: No - Type: bool - Default: `False` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `enableTelemetry` @@ -3452,8 +3400,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `gremlinDatabases` @@ -3462,8 +3408,6 @@ Gremlin Databases configurations. - Required: No - Type: array - Default: `[]` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `location` @@ -3472,8 +3416,6 @@ Default to current resource group scope location. Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `locations` @@ -3482,8 +3424,6 @@ Default to the location where the account is deployed. Locations enabled for the - Required: No - Type: array - Default: `[]` -- MinValue: 2 -- MaxValue: 720 **Required parameters** @@ -3504,8 +3444,6 @@ The failover priority of the region. A failover priority of 0 indicates a write - Required: Yes - Type: int -- MinValue: 2 -- MaxValue: 720 ### Parameter: `locations.locationName` @@ -3513,8 +3451,6 @@ The name of the region. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `locations.isZoneRedundant` @@ -3522,8 +3458,6 @@ Default to true. Flag to indicate whether or not this region is an AvailabilityZ - Required: No - Type: bool -- MinValue: 2 -- MaxValue: 720 ### Parameter: `lock` @@ -3531,8 +3465,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 720 **Optional parameters** @@ -3555,8 +3487,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 2 -- MaxValue: 720 ### Parameter: `lock.name` @@ -3564,8 +3494,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 720 ### Parameter: `managedIdentities` @@ -3573,8 +3501,6 @@ The managed identity definition for this resource. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 720 **Optional parameters** @@ -3589,8 +3515,6 @@ Enables system assigned managed identity on the resource. - Required: No - Type: bool -- MinValue: 2 -- MaxValue: 720 ### Parameter: `managedIdentities.userAssignedResourceIds` @@ -3598,8 +3522,6 @@ The resource ID(s) to assign to the resource. - Required: No - Type: array -- MinValue: 2 -- MaxValue: 720 ### Parameter: `maxIntervalInSeconds` @@ -3634,8 +3556,6 @@ Default to TLS 1.2. Enum to indicate the minimum allowed TLS version. Azure Cosm 'Tls12' ] ``` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `mongodbDatabases` @@ -3644,8 +3564,6 @@ MongoDB Databases configurations. - Required: No - Type: array - Default: `[]` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `networkRestrictions` @@ -3661,8 +3579,6 @@ The network configuration of this module. Defaults to `{ ipRules: [], virtualNet virtualNetworkRules: [] } ``` -- MinValue: 1 -- MaxValue: 2147483647 **Optional parameters** @@ -3679,8 +3595,6 @@ A single IPv4 address or a single IPv4 address range in CIDR format. Provided IP - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `networkRestrictions.networkAclBypass` @@ -3695,8 +3609,6 @@ Default to None. Specifies the network ACL bypass for Azure services. 'None' ] ``` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `networkRestrictions.publicNetworkAccess` @@ -3711,8 +3623,6 @@ Default to Disabled. Whether requests from Public Network are allowed. 'Enabled' ] ``` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `networkRestrictions.virtualNetworkRules` @@ -3720,8 +3630,6 @@ List of Virtual Network ACL rules configured for the Cosmos DB account.. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -3735,8 +3643,6 @@ Resource ID of a subnet. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints` @@ -3744,8 +3650,6 @@ Configuration details for private endpoints. For security reasons, it is recomme - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -3780,8 +3684,6 @@ The subresource to deploy the private endpoint for. For example "blob", "table", - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.subnetResourceId` @@ -3789,8 +3691,6 @@ Resource ID of the subnet where the endpoint needs to be created. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.applicationSecurityGroupResourceIds` @@ -3798,8 +3698,6 @@ Application security groups in which the private endpoint IP configuration is in - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.customDnsConfigs` @@ -3807,8 +3705,6 @@ Custom DNS configurations. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -3828,8 +3724,6 @@ A list of private ip addresses of the private endpoint. - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.customDnsConfigs.fqdn` @@ -3837,8 +3731,6 @@ FQDN that resolves to private endpoint IP address. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.customNetworkInterfaceName` @@ -3846,8 +3738,6 @@ The custom name of the network interface attached to the private endpoint. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.enableTelemetry` @@ -3855,8 +3745,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.ipConfigurations` @@ -3864,8 +3752,6 @@ A list of IP configurations of the private endpoint. This will be used to map to - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -3880,8 +3766,6 @@ The name of the resource that is unique within a resource group. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.ipConfigurations.properties` @@ -3889,8 +3773,6 @@ Properties of private endpoint IP configurations. - Required: Yes - Type: object -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -3906,8 +3788,6 @@ The ID of a group obtained from the remote resource that this private endpoint s - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.ipConfigurations.properties.memberName` @@ -3915,8 +3795,6 @@ The member name of a group obtained from the remote resource that this private e - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.ipConfigurations.properties.privateIPAddress` @@ -3924,8 +3802,6 @@ A private ip address obtained from the private endpoint's subnet. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.isManualConnection` @@ -3933,8 +3809,6 @@ If Manual Private Link Connection is required. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.location` @@ -3942,8 +3816,6 @@ The location to deploy the private endpoint to. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.lock` @@ -3951,8 +3823,6 @@ Specify the type of lock. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2147483647 **Optional parameters** @@ -3975,8 +3845,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.lock.name` @@ -3984,8 +3852,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.manualConnectionRequestMessage` @@ -3993,8 +3859,6 @@ A message passed to the owner of the remote resource with the manual connection - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.name` @@ -4002,8 +3866,6 @@ The name of the private endpoint. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.privateDnsZoneGroup` @@ -4011,8 +3873,6 @@ The private DNS zone group to configure for the private endpoint. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -4032,8 +3892,6 @@ The private DNS zone groups to associate the private endpoint. A DNS zone group - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -4053,8 +3911,6 @@ The resource id of the private DNS zone. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name` @@ -4062,8 +3918,6 @@ The name of the private DNS zone group config. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.privateDnsZoneGroup.name` @@ -4071,8 +3925,6 @@ The name of the Private DNS Zone Group. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.privateLinkServiceConnectionName` @@ -4080,8 +3932,6 @@ The name of the private link connection to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.resourceGroupName` @@ -4089,8 +3939,6 @@ Specify if you want to deploy the Private Endpoint into a different resource gro - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.roleAssignments` @@ -4098,8 +3946,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 - Roles configurable by name: - `'Contributor'` - `'DNS Resolver Contributor'` @@ -4136,8 +3982,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.roleAssignments.roleDefinitionIdOrName` @@ -4145,8 +3989,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.roleAssignments.condition` @@ -4154,8 +3996,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.roleAssignments.conditionVersion` @@ -4169,8 +4009,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId` @@ -4178,8 +4016,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.roleAssignments.description` @@ -4187,8 +4023,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.roleAssignments.name` @@ -4196,8 +4030,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.roleAssignments.principalType` @@ -4215,8 +4047,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `privateEndpoints.tags` @@ -4224,8 +4054,6 @@ Tags to be applied on all resources/resource groups in this deployment. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `roleAssignments` @@ -4233,8 +4061,6 @@ Array of role assignment objects that contain the 'roleDefinitionIdOrName' and ' - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 - Roles configurable by name: - `'Contributor'` - `'Cosmos DB Account Reader Role'` @@ -4271,8 +4097,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -4280,8 +4104,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `roleAssignments.condition` @@ -4289,8 +4111,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `roleAssignments.conditionVersion` @@ -4304,8 +4124,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -4313,8 +4131,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `roleAssignments.description` @@ -4322,8 +4138,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `roleAssignments.name` @@ -4331,8 +4145,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `roleAssignments.principalType` @@ -4350,8 +4162,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `secretsExportConfiguration` @@ -4359,8 +4169,6 @@ Key vault reference and secret settings for the module's secrets export. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -4387,8 +4195,6 @@ The resource ID of the key vault where to store the secrets of this module. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `secretsExportConfiguration.primaryReadonlyConnectionStringSecretName` @@ -4396,8 +4202,6 @@ The primary readonly connection string secret name to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `secretsExportConfiguration.primaryReadOnlyKeySecretName` @@ -4405,8 +4209,6 @@ The primary readonly key secret name to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `secretsExportConfiguration.primaryWriteConnectionStringSecretName` @@ -4414,8 +4216,6 @@ The primary write connection string secret name to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `secretsExportConfiguration.primaryWriteKeySecretName` @@ -4423,8 +4223,6 @@ The primary write key secret name to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `secretsExportConfiguration.secondaryReadonlyConnectionStringSecretName` @@ -4432,8 +4230,6 @@ The primary readonly connection string secret name to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `secretsExportConfiguration.secondaryReadonlyKeySecretName` @@ -4441,8 +4237,6 @@ The primary readonly key secret name to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `secretsExportConfiguration.secondaryWriteConnectionStringSecretName` @@ -4450,8 +4244,6 @@ The primary write connection string secret name to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `secretsExportConfiguration.secondaryWriteKeySecretName` @@ -4459,8 +4251,6 @@ The primary write key secret name to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `serverVersion` @@ -4481,8 +4271,6 @@ Default to 4.2. Specifies the MongoDB server version to use. '7.0' ] ``` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases` @@ -4491,8 +4279,6 @@ SQL Databases configurations. - Required: No - Type: array - Default: `[]` -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -4514,8 +4300,6 @@ Name of the SQL database . - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases.autoscaleSettingsMaxThroughput` @@ -4523,8 +4307,6 @@ Specifies the Autoscale settings and represents maximum throughput, the resource - Required: No - Type: int -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases.containers` @@ -4532,8 +4314,6 @@ Array of containers to deploy in the SQL database. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -4562,8 +4342,6 @@ Name of the container. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases.containers.paths` @@ -4571,8 +4349,6 @@ List of paths using which data within the container can be partitioned. For kind - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases.containers.analyticalStorageTtl` @@ -4580,8 +4356,6 @@ Default to 0. Indicates how long data should be retained in the analytical store - Required: No - Type: int -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases.containers.autoscaleSettingsMaxThroughput` @@ -4589,7 +4363,6 @@ Specifies the Autoscale settings and represents maximum throughput, the resource - Required: No - Type: int -- MinValue: 1 - MaxValue: 1000000 ### Parameter: `sqlDatabases.containers.conflictResolutionPolicy` @@ -4598,8 +4371,6 @@ The conflict resolution policy for the container. Conflicts and conflict resolut - Required: No - Type: object -- MinValue: 1 -- MaxValue: 1000000 **Required parameters** @@ -4627,8 +4398,6 @@ Indicates the conflict resolution mode. 'LastWriterWins' ] ``` -- MinValue: 1 -- MaxValue: 1000000 ### Parameter: `sqlDatabases.containers.conflictResolutionPolicy.conflictResolutionPath` @@ -4636,8 +4405,6 @@ The conflict resolution path in the case of LastWriterWins mode. Required if `mo - Required: No - Type: string -- MinValue: 1 -- MaxValue: 1000000 ### Parameter: `sqlDatabases.containers.conflictResolutionPolicy.conflictResolutionProcedure` @@ -4645,8 +4412,6 @@ The procedure to resolve conflicts in the case of custom mode. Required if `mode - Required: No - Type: string -- MinValue: 1 -- MaxValue: 1000000 ### Parameter: `sqlDatabases.containers.defaultTtl` @@ -4663,8 +4428,6 @@ Indexing policy of the container. - Required: No - Type: object -- MinValue: -1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases.containers.kind` @@ -4679,8 +4442,6 @@ Default to Hash. Indicates the kind of algorithm used for partitioning. 'MultiHash' ] ``` -- MinValue: -1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases.containers.throughput` @@ -4688,8 +4449,6 @@ Default to 400. Request Units per second. Will be ignored if autoscaleSettingsMa - Required: No - Type: int -- MinValue: -1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases.containers.uniqueKeyPolicyKeys` @@ -4697,8 +4456,6 @@ The unique key policy configuration containing a list of unique keys that enforc - Required: No - Type: array -- MinValue: -1 -- MaxValue: 2147483647 **Required parameters** @@ -4712,8 +4469,6 @@ List of paths must be unique for each document in the Azure Cosmos DB service. - Required: Yes - Type: array -- MinValue: -1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases.containers.version` @@ -4728,8 +4483,6 @@ Default to 1 for Hash and 2 for MultiHash - 1 is not allowed for MultiHash. Vers 2 ] ``` -- MinValue: -1 -- MaxValue: 2147483647 ### Parameter: `sqlDatabases.throughput` @@ -4737,8 +4490,6 @@ Default to 400. Request units per second. Will be ignored if autoscaleSettingsMa - Required: No - Type: int -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlRoleAssignmentsPrincipalIds` @@ -4747,8 +4498,6 @@ SQL Role Definitions configurations. - Required: No - Type: array - Default: `[]` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlRoleDefinitions` @@ -4756,8 +4505,6 @@ SQL Role Definitions configurations. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 **Required parameters** @@ -4779,8 +4526,6 @@ Name of the SQL Role Definition. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlRoleDefinitions.dataAction` @@ -4788,8 +4533,6 @@ An array of data actions that are allowed. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlRoleDefinitions.roleName` @@ -4797,8 +4540,6 @@ A user-friendly name for the Role Definition. Must be unique for the database ac - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `sqlRoleDefinitions.roleType` @@ -4813,8 +4554,6 @@ Indicates whether the Role Definition was built-in or user created. 'CustomRole' ] ``` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `tables` @@ -4823,8 +4562,6 @@ Table configurations. - Required: No - Type: array - Default: `[]` -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `tags` @@ -4832,8 +4569,6 @@ Tags of the Database Account resource. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2147483647 ### Parameter: `totalThroughputLimit` @@ -4842,8 +4577,6 @@ Default to unlimited. The total throughput limit imposed on this Cosmos DB accou - Required: No - Type: int - Default: `-1` -- MinValue: 1 -- MaxValue: 2147483647 ## Outputs diff --git a/avm/res/document-db/database-account/sql-database/container/README.md b/avm/res/document-db/database-account/sql-database/container/README.md index 3056622777..380a0b84dd 100644 --- a/avm/res/document-db/database-account/sql-database/container/README.md +++ b/avm/res/document-db/database-account/sql-database/container/README.md @@ -97,7 +97,6 @@ The conflict resolution policy for the container. Conflicts and conflict resolut - Required: No - Type: object - Default: `{}` -- MaxValue: 1000000 ### Parameter: `defaultTtl` @@ -116,8 +115,6 @@ Indexing policy of the container. - Required: No - Type: object - Default: `{}` -- MinValue: -1 -- MaxValue: 2147483647 ### Parameter: `kind` @@ -133,8 +130,6 @@ Default to Hash. Indicates the kind of algorithm used for partitioning. 'MultiHash' ] ``` -- MinValue: -1 -- MaxValue: 2147483647 ### Parameter: `tags` @@ -142,8 +137,6 @@ Tags of the SQL Database resource. - Required: No - Type: object -- MinValue: -1 -- MaxValue: 2147483647 ### Parameter: `throughput` @@ -152,8 +145,6 @@ Default to 400. Request Units per second. Will be ignored if autoscaleSettingsMa - Required: No - Type: int - Default: `400` -- MinValue: -1 -- MaxValue: 2147483647 ### Parameter: `uniqueKeyPolicyKeys` @@ -162,8 +153,6 @@ The unique key policy configuration containing a list of unique keys that enforc - Required: No - Type: array - Default: `[]` -- MinValue: -1 -- MaxValue: 2147483647 ### Parameter: `version` @@ -179,8 +168,6 @@ Default to 1 for Hash and 2 for MultiHash - 1 is not allowed for MultiHash. Vers 2 ] ``` -- MinValue: -1 -- MaxValue: 2147483647 ## Outputs diff --git a/avm/res/elastic-san/elastic-san/README.md b/avm/res/elastic-san/elastic-san/README.md index 315968db1e..859c3acb22 100644 --- a/avm/res/elastic-san/elastic-san/README.md +++ b/avm/res/elastic-san/elastic-san/README.md @@ -1176,8 +1176,6 @@ The diagnostic settings of the service. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 400 **Optional parameters** @@ -1198,8 +1196,6 @@ Resource ID of the diagnostic event hub authorization rule for the Event Hubs na - Required: No - Type: string -- MinValue: 1 -- MaxValue: 400 ### Parameter: `diagnosticSettings.eventHubName` @@ -1207,8 +1203,6 @@ Name of the diagnostic event hub within the namespace to which logs are streamed - Required: No - Type: string -- MinValue: 1 -- MaxValue: 400 ### Parameter: `diagnosticSettings.logAnalyticsDestinationType` @@ -1223,8 +1217,6 @@ A string indicating whether the export to Log Analytics should use the default d 'Dedicated' ] ``` -- MinValue: 1 -- MaxValue: 400 ### Parameter: `diagnosticSettings.marketplacePartnerResourceId` @@ -1232,8 +1224,6 @@ The full ARM resource ID of the Marketplace resource to which you would like to - Required: No - Type: string -- MinValue: 1 -- MaxValue: 400 ### Parameter: `diagnosticSettings.metricCategories` @@ -1241,8 +1231,6 @@ The name of metrics that will be streamed. "allMetrics" includes all possible me - Required: No - Type: array -- MinValue: 1 -- MaxValue: 400 **Required parameters** @@ -1262,8 +1250,6 @@ Name of a Diagnostic Metric category for a resource type this setting is applied - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 400 ### Parameter: `diagnosticSettings.metricCategories.enabled` @@ -1271,8 +1257,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 400 ### Parameter: `diagnosticSettings.name` @@ -1280,8 +1264,6 @@ The name of diagnostic setting. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 400 ### Parameter: `diagnosticSettings.storageAccountResourceId` @@ -1289,8 +1271,6 @@ Resource ID of the diagnostic storage account. For security reasons, it is recom - Required: No - Type: string -- MinValue: 1 -- MaxValue: 400 ### Parameter: `diagnosticSettings.workspaceResourceId` @@ -1298,8 +1278,6 @@ Resource ID of the diagnostic log analytics workspace. For security reasons, it - Required: No - Type: string -- MinValue: 1 -- MaxValue: 400 ### Parameter: `enableTelemetry` @@ -1308,8 +1286,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 1 -- MaxValue: 400 ### Parameter: `extendedCapacitySizeTiB` @@ -1328,8 +1304,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 0 -- MaxValue: 600 ### Parameter: `lock` @@ -1337,8 +1311,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 600 **Optional parameters** @@ -1361,8 +1333,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 0 -- MaxValue: 600 ### Parameter: `lock.name` @@ -1370,8 +1340,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `publicNetworkAccess` @@ -1386,8 +1354,6 @@ Whether or not public network access is allowed for this resource. For security 'Enabled' ] ``` -- MinValue: 0 -- MaxValue: 600 ### Parameter: `roleAssignments` @@ -1395,8 +1361,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 600 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -1432,8 +1396,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -1441,8 +1403,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `roleAssignments.condition` @@ -1450,8 +1410,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `roleAssignments.conditionVersion` @@ -1465,8 +1423,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 0 -- MaxValue: 600 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -1474,8 +1430,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `roleAssignments.description` @@ -1483,8 +1437,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `roleAssignments.name` @@ -1492,8 +1444,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `roleAssignments.principalType` @@ -1511,8 +1461,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 0 -- MaxValue: 600 ### Parameter: `sku` @@ -1528,8 +1476,6 @@ Specifies the SKU for the Elastic SAN. 'Premium_ZRS' ] ``` -- MinValue: 0 -- MaxValue: 600 ### Parameter: `tags` @@ -1537,8 +1483,6 @@ Tags of the Elastic SAN resource. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups` @@ -1546,8 +1490,6 @@ List of Elastic SAN Volume Groups to be created in the Elastic SAN. An Elastic S - Required: No - Type: array -- MinValue: 0 -- MaxValue: 600 **Required parameters** @@ -1571,8 +1513,6 @@ The name of the Elastic SAN Volume Group. The name can only contain lowercase le - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.customerManagedKey` @@ -1580,8 +1520,6 @@ The customer managed key definition. This parameter enables the encryption of El - Required: No - Type: object -- MinValue: 0 -- MaxValue: 600 **Required parameters** @@ -1603,8 +1541,6 @@ The name of the customer managed key to use for encryption. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.customerManagedKey.keyVaultResourceId` @@ -1612,8 +1548,6 @@ The resource ID of a key vault to reference a customer managed key for encryptio - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.customerManagedKey.keyVersion` @@ -1621,8 +1555,6 @@ The version of the customer managed key to reference for encryption. If not prov - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.customerManagedKey.userAssignedIdentityResourceId` @@ -1630,8 +1562,6 @@ User assigned identity to use when fetching the customer managed key. Required i - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.managedIdentities` @@ -1639,8 +1569,6 @@ The managed identity definition for this resource. The Elastic SAN Volume Group - Required: No - Type: object -- MinValue: 0 -- MaxValue: 600 **Optional parameters** @@ -1655,8 +1583,6 @@ Enables system assigned managed identity on the resource. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.managedIdentities.userAssignedResourceIds` @@ -1664,8 +1590,6 @@ The resource ID(s) to assign to the resource. Required if a user assigned identi - Required: No - Type: array -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints` @@ -1673,8 +1597,6 @@ Configuration details for private endpoints. For security reasons, it is recomme - Required: No - Type: array -- MinValue: 0 -- MaxValue: 600 **Required parameters** @@ -1709,8 +1631,6 @@ Resource ID of the subnet where the endpoint needs to be created. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.applicationSecurityGroupResourceIds` @@ -1718,8 +1638,6 @@ Application security groups in which the Private Endpoint IP configuration is in - Required: No - Type: array -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.customDnsConfigs` @@ -1727,8 +1645,6 @@ Custom DNS configurations. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 600 **Required parameters** @@ -1748,8 +1664,6 @@ A list of private IP addresses of the private endpoint. - Required: Yes - Type: array -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.customDnsConfigs.fqdn` @@ -1757,8 +1671,6 @@ FQDN that resolves to private endpoint IP address. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.customNetworkInterfaceName` @@ -1766,8 +1678,6 @@ The custom name of the network interface attached to the Private Endpoint. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.enableTelemetry` @@ -1775,8 +1685,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.ipConfigurations` @@ -1784,8 +1692,6 @@ A list of IP configurations of the Private Endpoint. This will be used to map to - Required: No - Type: array -- MinValue: 0 -- MaxValue: 600 **Required parameters** @@ -1800,8 +1706,6 @@ The name of the resource that is unique within a resource group. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.ipConfigurations.properties` @@ -1809,8 +1713,6 @@ Properties of private endpoint IP configurations. - Required: Yes - Type: object -- MinValue: 0 -- MaxValue: 600 **Required parameters** @@ -1826,8 +1728,6 @@ The ID of a group obtained from the remote resource that this private endpoint s - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.ipConfigurations.properties.memberName` @@ -1835,8 +1735,6 @@ The member name of a group obtained from the remote resource that this private e - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.ipConfigurations.properties.privateIPAddress` @@ -1844,8 +1742,6 @@ A private IP address obtained from the private endpoint's subnet. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.isManualConnection` @@ -1853,8 +1749,6 @@ If Manual Private Link Connection is required. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.location` @@ -1862,8 +1756,6 @@ The location to deploy the Private Endpoint to. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.lock` @@ -1871,8 +1763,6 @@ Specify the type of lock. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 600 **Optional parameters** @@ -1895,8 +1785,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.lock.name` @@ -1904,8 +1792,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.manualConnectionRequestMessage` @@ -1913,8 +1799,6 @@ A message passed to the owner of the remote resource with the manual connection - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.name` @@ -1922,8 +1806,6 @@ The name of the Private Endpoint. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.privateDnsZoneGroup` @@ -1931,8 +1813,6 @@ The private DNS Zone Group to configure for the Private Endpoint. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 600 **Required parameters** @@ -1952,8 +1832,6 @@ The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group - Required: Yes - Type: array -- MinValue: 0 -- MaxValue: 600 **Required parameters** @@ -1973,8 +1851,6 @@ The resource id of the private DNS zone. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name` @@ -1982,8 +1858,6 @@ The name of the private DNS Zone Group config. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.privateDnsZoneGroup.name` @@ -1991,8 +1865,6 @@ The name of the Private DNS Zone Group. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.privateLinkServiceConnectionName` @@ -2000,8 +1872,6 @@ The name of the private link connection to create. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.resourceGroupResourceId` @@ -2009,8 +1879,6 @@ The resource ID of the Resource Group the Private Endpoint will be created in. I - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.roleAssignments` @@ -2018,8 +1886,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 600 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -2055,8 +1921,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.roleAssignments.roleDefinitionIdOrName` @@ -2064,8 +1928,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.roleAssignments.condition` @@ -2073,8 +1935,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.roleAssignments.conditionVersion` @@ -2088,8 +1948,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId` @@ -2097,8 +1955,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.roleAssignments.description` @@ -2106,8 +1962,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.roleAssignments.name` @@ -2115,8 +1969,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.roleAssignments.principalType` @@ -2134,8 +1986,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.service` @@ -2143,8 +1993,6 @@ The subresource to deploy the Private Endpoint for. For example "vault" for a Ke - Required: No - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.privateEndpoints.tags` @@ -2152,8 +2000,6 @@ Tags to be applied on all resources/Resource Groups in this deployment. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.virtualNetworkRules` @@ -2161,8 +2007,6 @@ List of Virtual Network Rules, permitting virtual network subnet to connect to t - Required: No - Type: array -- MinValue: 0 -- MaxValue: 600 **Required parameters** @@ -2176,8 +2020,6 @@ The resource ID of the subnet in the virtual network. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.volumes` @@ -2185,8 +2027,6 @@ List of Elastic SAN Volumes to be created in the Elastic SAN Volume Group. Elast - Required: No - Type: array -- MinValue: 0 -- MaxValue: 600 **Required parameters** @@ -2207,8 +2047,6 @@ The name of the Elastic SAN Volume. The name can only contain lowercase letters, - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 600 ### Parameter: `volumeGroups.volumes.sizeGiB` @@ -2225,8 +2063,6 @@ List of Elastic SAN Volume Snapshots to be created in the Elastic SAN Volume. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 65536 **Required parameters** @@ -2240,8 +2076,6 @@ The name of the Elastic SAN Volume Snapshot. The name can only contain lowercase - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 65536 ## Outputs diff --git a/avm/res/elastic-san/elastic-san/volume-group/README.md b/avm/res/elastic-san/elastic-san/volume-group/README.md index eac0eb4506..7e15f6004e 100644 --- a/avm/res/elastic-san/elastic-san/volume-group/README.md +++ b/avm/res/elastic-san/elastic-san/volume-group/README.md @@ -652,8 +652,6 @@ List of Elastic SAN Volume Snapshots to be created in the Elastic SAN Volume. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 65536 **Required parameters** @@ -667,8 +665,6 @@ The name of the Elastic SAN Volume Snapshot. The name can only contain lowercase - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 65536 ## Outputs diff --git a/avm/res/elastic-san/elastic-san/volume-group/volume/README.md b/avm/res/elastic-san/elastic-san/volume-group/volume/README.md index 7b3358a227..964ad80ff8 100644 --- a/avm/res/elastic-san/elastic-san/volume-group/volume/README.md +++ b/avm/res/elastic-san/elastic-san/volume-group/volume/README.md @@ -61,8 +61,6 @@ The name of the parent Elastic SAN. Required if the template is used in a standa - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 65536 ### Parameter: `volumeGroupName` @@ -70,8 +68,6 @@ The name of the parent Elastic SAN Volume Group. Required if the template is use - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 65536 ### Parameter: `location` @@ -80,8 +76,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 1 -- MaxValue: 65536 ### Parameter: `snapshots` @@ -89,8 +83,6 @@ List of Elastic SAN Volume Snapshots to be created in the Elastic SAN Volume. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 65536 **Required parameters** @@ -104,8 +96,6 @@ The name of the Elastic SAN Volume Snapshot. The name can only contain lowercase - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 65536 ## Outputs diff --git a/avm/res/event-grid/namespace/README.md b/avm/res/event-grid/namespace/README.md index 26566a7f4d..9960bc309c 100644 --- a/avm/res/event-grid/namespace/README.md +++ b/avm/res/event-grid/namespace/README.md @@ -2300,8 +2300,6 @@ All namespace Permission Bindings to create. Used only when MQTT broker is enabl - Required: No - Type: array -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints` @@ -2309,8 +2307,6 @@ Configuration details for private endpoints. For security reasons, it is recomme - Required: No - Type: array -- MinValue: 1 -- MaxValue: 8 **Required parameters** @@ -2345,8 +2341,6 @@ Resource ID of the subnet where the endpoint needs to be created. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.applicationSecurityGroupResourceIds` @@ -2354,8 +2348,6 @@ Application security groups in which the Private Endpoint IP configuration is in - Required: No - Type: array -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.customDnsConfigs` @@ -2363,8 +2355,6 @@ Custom DNS configurations. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 8 **Required parameters** @@ -2384,8 +2374,6 @@ A list of private IP addresses of the private endpoint. - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.customDnsConfigs.fqdn` @@ -2393,8 +2381,6 @@ FQDN that resolves to private endpoint IP address. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.customNetworkInterfaceName` @@ -2402,8 +2388,6 @@ The custom name of the network interface attached to the Private Endpoint. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.enableTelemetry` @@ -2411,8 +2395,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.ipConfigurations` @@ -2420,8 +2402,6 @@ A list of IP configurations of the Private Endpoint. This will be used to map to - Required: No - Type: array -- MinValue: 1 -- MaxValue: 8 **Required parameters** @@ -2436,8 +2416,6 @@ The name of the resource that is unique within a resource group. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.ipConfigurations.properties` @@ -2445,8 +2423,6 @@ Properties of private endpoint IP configurations. - Required: Yes - Type: object -- MinValue: 1 -- MaxValue: 8 **Required parameters** @@ -2462,8 +2438,6 @@ The ID of a group obtained from the remote resource that this private endpoint s - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.ipConfigurations.properties.memberName` @@ -2471,8 +2445,6 @@ The member name of a group obtained from the remote resource that this private e - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.ipConfigurations.properties.privateIPAddress` @@ -2480,8 +2452,6 @@ A private IP address obtained from the private endpoint's subnet. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.isManualConnection` @@ -2489,8 +2459,6 @@ If Manual Private Link Connection is required. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.location` @@ -2498,8 +2466,6 @@ The location to deploy the Private Endpoint to. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.lock` @@ -2507,8 +2473,6 @@ Specify the type of lock. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 8 **Optional parameters** @@ -2531,8 +2495,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.lock.name` @@ -2540,8 +2502,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.manualConnectionRequestMessage` @@ -2549,8 +2509,6 @@ A message passed to the owner of the remote resource with the manual connection - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.name` @@ -2558,8 +2516,6 @@ The name of the Private Endpoint. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.privateDnsZoneGroup` @@ -2567,8 +2523,6 @@ The private DNS Zone Group to configure for the Private Endpoint. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 8 **Required parameters** @@ -2588,8 +2542,6 @@ The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 8 **Required parameters** @@ -2609,8 +2561,6 @@ The resource id of the private DNS zone. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name` @@ -2618,8 +2568,6 @@ The name of the private DNS Zone Group config. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.privateDnsZoneGroup.name` @@ -2627,8 +2575,6 @@ The name of the Private DNS Zone Group. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.privateLinkServiceConnectionName` @@ -2636,8 +2582,6 @@ The name of the private link connection to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.resourceGroupResourceId` @@ -2645,8 +2589,6 @@ The resource ID of the Resource Group the Private Endpoint will be created in. I - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.roleAssignments` @@ -2654,8 +2596,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 8 - Roles configurable by name: - `'Contributor'` - `'DNS Resolver Contributor'` @@ -2692,8 +2632,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.roleAssignments.roleDefinitionIdOrName` @@ -2701,8 +2639,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.roleAssignments.condition` @@ -2710,8 +2646,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.roleAssignments.conditionVersion` @@ -2725,8 +2659,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId` @@ -2734,8 +2666,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.roleAssignments.description` @@ -2743,8 +2673,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.roleAssignments.name` @@ -2752,8 +2680,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.roleAssignments.principalType` @@ -2771,8 +2697,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.service` @@ -2780,8 +2704,6 @@ The subresource to deploy the Private Endpoint for. For example "vault" for a Ke - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `privateEndpoints.tags` @@ -2789,8 +2711,6 @@ Tags to be applied on all resources/Resource Groups in this deployment. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 8 ### Parameter: `publicNetworkAccess` @@ -2806,8 +2726,6 @@ This determines if traffic is allowed over public network. By default it is enab 'SecuredByPerimeter' ] ``` -- MinValue: 1 -- MaxValue: 8 ### Parameter: `roleAssignments` @@ -2815,8 +2733,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 8 - Roles configurable by name: - `'Azure Resource Notifications System Topics Subscriber'` - `'Contributor'` @@ -2856,8 +2772,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -2865,8 +2779,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `roleAssignments.condition` @@ -2874,8 +2786,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `roleAssignments.conditionVersion` @@ -2889,8 +2799,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 8 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -2898,8 +2806,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `roleAssignments.description` @@ -2907,8 +2813,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `roleAssignments.name` @@ -2916,8 +2820,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `roleAssignments.principalType` @@ -2935,8 +2837,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 8 ### Parameter: `routeTopicResourceId` @@ -2944,8 +2844,6 @@ Resource Id for the Event Grid Topic to which events will be routed to from Topi - Required: No - Type: string -- MinValue: 1 -- MaxValue: 8 ### Parameter: `routingEnrichments` @@ -2953,8 +2851,6 @@ Routing enrichments for topic spaces configuration. Used only when MQTT broker - Required: No - Type: object -- MinValue: 1 -- MaxValue: 8 ### Parameter: `tags` @@ -2962,8 +2858,6 @@ Resource tags. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 8 ### Parameter: `topics` @@ -2971,8 +2865,6 @@ All namespace Topics to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 8 ### Parameter: `topicSpaces` @@ -2980,8 +2872,6 @@ All namespace Topic Spaces to create. Used only when MQTT broker is enabled ('to - Required: No - Type: array -- MinValue: 1 -- MaxValue: 8 ### Parameter: `topicSpacesState` @@ -2997,8 +2887,6 @@ Indicates if Topic Spaces Configuration is enabled for the namespace. This enabl 'Enabled' ] ``` -- MinValue: 1 -- MaxValue: 8 ## Outputs diff --git a/avm/res/event-grid/namespace/topic/README.md b/avm/res/event-grid/namespace/topic/README.md index a8d8f52ac5..8b208b9055 100644 --- a/avm/res/event-grid/namespace/topic/README.md +++ b/avm/res/event-grid/namespace/topic/README.md @@ -73,8 +73,6 @@ All event subscriptions to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 7 ### Parameter: `inputSchema` @@ -83,8 +81,6 @@ This determines the format that is expected for incoming events published to the - Required: No - Type: string - Default: `'CloudEventSchemaV1_0'` -- MinValue: 1 -- MaxValue: 7 ### Parameter: `lock` @@ -92,8 +88,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 7 **Optional parameters** @@ -116,8 +110,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 1 -- MaxValue: 7 ### Parameter: `lock.name` @@ -125,8 +117,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 7 ### Parameter: `publisherType` @@ -135,8 +125,6 @@ Publisher type of the namespace topic. - Required: No - Type: string - Default: `'Custom'` -- MinValue: 1 -- MaxValue: 7 ### Parameter: `roleAssignments` @@ -144,8 +132,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 7 - Roles configurable by name: - `'Azure Resource Notifications System Topics Subscriber'` - `'Contributor'` @@ -185,8 +171,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 7 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -194,8 +178,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 7 ### Parameter: `roleAssignments.condition` @@ -203,8 +185,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 7 ### Parameter: `roleAssignments.conditionVersion` @@ -218,8 +198,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 7 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -227,8 +205,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 7 ### Parameter: `roleAssignments.description` @@ -236,8 +212,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 7 ### Parameter: `roleAssignments.name` @@ -245,8 +219,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 7 ### Parameter: `roleAssignments.principalType` @@ -264,8 +236,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 7 ## Outputs diff --git a/avm/res/event-hub/namespace/README.md b/avm/res/event-hub/namespace/README.md index 890de0fb2a..53199dcf36 100644 --- a/avm/res/event-hub/namespace/README.md +++ b/avm/res/event-hub/namespace/README.md @@ -1834,8 +1834,6 @@ The minimum TLS version for the cluster to support. '1.2' ] ``` -- MinValue: 0 -- MaxValue: 20 ### Parameter: `networkRuleSets` @@ -1844,8 +1842,6 @@ Configure networking options. This object contains IPs/Subnets to allow or restr - Required: No - Type: object - Default: `{}` -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints` @@ -1853,8 +1849,6 @@ Configuration details for private endpoints. For security reasons, it is recomme - Required: No - Type: array -- MinValue: 0 -- MaxValue: 20 **Required parameters** @@ -1889,8 +1883,6 @@ Resource ID of the subnet where the endpoint needs to be created. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.applicationSecurityGroupResourceIds` @@ -1898,8 +1890,6 @@ Application security groups in which the Private Endpoint IP configuration is in - Required: No - Type: array -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.customDnsConfigs` @@ -1907,8 +1897,6 @@ Custom DNS configurations. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 20 **Required parameters** @@ -1928,8 +1916,6 @@ A list of private IP addresses of the private endpoint. - Required: Yes - Type: array -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.customDnsConfigs.fqdn` @@ -1937,8 +1923,6 @@ FQDN that resolves to private endpoint IP address. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.customNetworkInterfaceName` @@ -1946,8 +1930,6 @@ The custom name of the network interface attached to the Private Endpoint. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.enableTelemetry` @@ -1955,8 +1937,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.ipConfigurations` @@ -1964,8 +1944,6 @@ A list of IP configurations of the Private Endpoint. This will be used to map to - Required: No - Type: array -- MinValue: 0 -- MaxValue: 20 **Required parameters** @@ -1980,8 +1958,6 @@ The name of the resource that is unique within a resource group. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.ipConfigurations.properties` @@ -1989,8 +1965,6 @@ Properties of private endpoint IP configurations. - Required: Yes - Type: object -- MinValue: 0 -- MaxValue: 20 **Required parameters** @@ -2006,8 +1980,6 @@ The ID of a group obtained from the remote resource that this private endpoint s - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.ipConfigurations.properties.memberName` @@ -2015,8 +1987,6 @@ The member name of a group obtained from the remote resource that this private e - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.ipConfigurations.properties.privateIPAddress` @@ -2024,8 +1994,6 @@ A private IP address obtained from the private endpoint's subnet. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.isManualConnection` @@ -2033,8 +2001,6 @@ If Manual Private Link Connection is required. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.location` @@ -2042,8 +2008,6 @@ The location to deploy the Private Endpoint to. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.lock` @@ -2051,8 +2015,6 @@ Specify the type of lock. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 20 **Optional parameters** @@ -2075,8 +2037,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.lock.name` @@ -2084,8 +2044,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.manualConnectionRequestMessage` @@ -2093,8 +2051,6 @@ A message passed to the owner of the remote resource with the manual connection - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.name` @@ -2102,8 +2058,6 @@ The name of the Private Endpoint. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.privateDnsZoneGroup` @@ -2111,8 +2065,6 @@ The private DNS Zone Group to configure for the Private Endpoint. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 20 **Required parameters** @@ -2132,8 +2084,6 @@ The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group - Required: Yes - Type: array -- MinValue: 0 -- MaxValue: 20 **Required parameters** @@ -2153,8 +2103,6 @@ The resource id of the private DNS zone. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name` @@ -2162,8 +2110,6 @@ The name of the private DNS Zone Group config. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.privateDnsZoneGroup.name` @@ -2171,8 +2117,6 @@ The name of the Private DNS Zone Group. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.privateLinkServiceConnectionName` @@ -2180,8 +2124,6 @@ The name of the private link connection to create. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.resourceGroupResourceId` @@ -2189,8 +2131,6 @@ The resource ID of the Resource Group the Private Endpoint will be created in. I - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.roleAssignments` @@ -2198,8 +2138,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 20 - Roles configurable by name: - `'Contributor'` - `'DNS Resolver Contributor'` @@ -2236,8 +2174,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.roleAssignments.roleDefinitionIdOrName` @@ -2245,8 +2181,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.roleAssignments.condition` @@ -2254,8 +2188,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.roleAssignments.conditionVersion` @@ -2269,8 +2201,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId` @@ -2278,8 +2208,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.roleAssignments.description` @@ -2287,8 +2215,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.roleAssignments.name` @@ -2296,8 +2222,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.roleAssignments.principalType` @@ -2315,8 +2239,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.service` @@ -2324,8 +2246,6 @@ The subresource to deploy the Private Endpoint for. For example "vault" for a Ke - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `privateEndpoints.tags` @@ -2333,8 +2253,6 @@ Tags to be applied on all resources/Resource Groups in this deployment. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 20 ### Parameter: `publicNetworkAccess` @@ -2352,8 +2270,6 @@ Whether or not public network access is allowed for this resource. For security 'SecuredByPerimeter' ] ``` -- MinValue: 0 -- MaxValue: 20 ### Parameter: `requireInfrastructureEncryption` @@ -2362,8 +2278,6 @@ Enable infrastructure encryption (double encryption). Note, this setting require - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 20 ### Parameter: `roleAssignments` @@ -2371,8 +2285,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 20 - Roles configurable by name: - `'Azure Event Hubs Data Owner'` - `'Azure Event Hubs Data Receiver'` @@ -2407,8 +2319,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -2416,8 +2326,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `roleAssignments.condition` @@ -2425,8 +2333,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `roleAssignments.conditionVersion` @@ -2440,8 +2346,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 0 -- MaxValue: 20 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -2449,8 +2353,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `roleAssignments.description` @@ -2458,8 +2360,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `roleAssignments.name` @@ -2467,8 +2367,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `roleAssignments.principalType` @@ -2486,8 +2384,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 0 -- MaxValue: 20 ### Parameter: `secretsExportConfiguration` @@ -2495,8 +2391,6 @@ Key vault reference and secret settings for the module's secrets export. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 20 **Required parameters** @@ -2519,8 +2413,6 @@ The resource ID of the key vault where to store the secrets of this module. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `secretsExportConfiguration.rootPrimaryConnectionStringName` @@ -2528,8 +2420,6 @@ The rootPrimaryConnectionStringName secret name to create. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `secretsExportConfiguration.rootPrimaryKeyName` @@ -2537,8 +2427,6 @@ The rootPrimaryKeyName secret name to create. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `secretsExportConfiguration.rootSecondaryConnectionStringName` @@ -2546,8 +2434,6 @@ The rootSecondaryConnectionStringName secret name to create. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `secretsExportConfiguration.rootSecondaryKeyName` @@ -2555,8 +2441,6 @@ The rootSecondaryKeyName secret name to create. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 20 ### Parameter: `skuCapacity` @@ -2583,8 +2467,6 @@ event hub plan SKU name. 'Standard' ] ``` -- MinValue: 1 -- MaxValue: 20 ### Parameter: `tags` @@ -2592,8 +2474,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 20 ### Parameter: `zoneRedundant` @@ -2602,8 +2482,6 @@ Switch to make the Event Hub Namespace zone redundant. - Required: No - Type: bool - Default: `True` -- MinValue: 1 -- MaxValue: 20 ## Outputs diff --git a/avm/res/event-hub/namespace/eventhub/README.md b/avm/res/event-hub/namespace/eventhub/README.md index 489217d6ee..a60118a677 100644 --- a/avm/res/event-hub/namespace/eventhub/README.md +++ b/avm/res/event-hub/namespace/eventhub/README.md @@ -173,8 +173,6 @@ A value that indicates whether to Skip Empty Archives. - Required: No - Type: bool - Default: `False` -- MinValue: 10485760 -- MaxValue: 524288000 ### Parameter: `consumergroups` @@ -190,8 +188,6 @@ The consumer groups to create in this event hub instance. } ] ``` -- MinValue: 10485760 -- MaxValue: 524288000 ### Parameter: `lock` @@ -199,8 +195,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 10485760 -- MaxValue: 524288000 **Optional parameters** @@ -223,8 +217,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 10485760 -- MaxValue: 524288000 ### Parameter: `lock.name` @@ -232,8 +224,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 10485760 -- MaxValue: 524288000 ### Parameter: `messageRetentionInDays` @@ -269,8 +259,6 @@ Retention cleanup policy. Enumerates the possible values for cleanup policy. 'Delete' ] ``` -- MinValue: 1 -- MaxValue: 32 ### Parameter: `retentionDescriptionRetentionTimeInHours` @@ -298,8 +286,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 168 - Roles configurable by name: - `'Azure Event Hubs Data Owner'` - `'Azure Event Hubs Data Receiver'` @@ -334,8 +320,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 168 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -343,8 +327,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 168 ### Parameter: `roleAssignments.condition` @@ -352,8 +334,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 168 ### Parameter: `roleAssignments.conditionVersion` @@ -367,8 +347,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 168 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -376,8 +354,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 168 ### Parameter: `roleAssignments.description` @@ -385,8 +361,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 168 ### Parameter: `roleAssignments.name` @@ -394,8 +368,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 168 ### Parameter: `roleAssignments.principalType` @@ -413,8 +385,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 168 ### Parameter: `status` @@ -437,8 +407,6 @@ Enumerates the possible values for the status of the Event Hub. 'Unknown' ] ``` -- MinValue: 1 -- MaxValue: 168 ## Outputs diff --git a/avm/res/hybrid-compute/license/README.md b/avm/res/hybrid-compute/license/README.md index b0bb755977..6f15a5e971 100644 --- a/avm/res/hybrid-compute/license/README.md +++ b/avm/res/hybrid-compute/license/README.md @@ -210,7 +210,6 @@ Describes the license state. Default is Deactivated. 'Deactivated' ] ``` -- MinValue: 8 ### Parameter: `licenseDetailTarget` @@ -226,7 +225,6 @@ Describes the license target server. Default is Windows Server 2012 R2. 'Windows Server 2012 R2' ] ``` -- MinValue: 8 ### Parameter: `licenseDetailType` @@ -242,7 +240,6 @@ Provide the core type (vCore or pCore) needed for this ESU licens. Default is vC 'vCore' ] ``` -- MinValue: 8 ### Parameter: `licenseType` @@ -257,7 +254,6 @@ The type of the license resource. The value is ESU. 'ESU' ] ``` -- MinValue: 8 ### Parameter: `licenseVolumeLicenseDetails` @@ -266,7 +262,6 @@ A list of volume license details. - Required: No - Type: array - Default: `[]` -- MinValue: 8 **Required parameters** @@ -281,7 +276,6 @@ The invoice id for the volume license. - Required: Yes - Type: string -- MinValue: 8 ### Parameter: `licenseVolumeLicenseDetails.programYear` @@ -297,7 +291,6 @@ Describes the program year the volume license is for. 'Year 3' ] ``` -- MinValue: 8 ### Parameter: `location` @@ -306,7 +299,6 @@ The location of the Azure Arc License to be created. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 8 ### Parameter: `tags` @@ -314,7 +306,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 8 ### Parameter: `tenantId` @@ -323,7 +314,6 @@ The tenant ID of the license resource. Default is the tenant ID of the current s - Required: No - Type: string - Default: `[tenant().tenantId]` -- MinValue: 8 ## Outputs diff --git a/avm/res/insights/component/README.md b/avm/res/insights/component/README.md index 438d8a2edd..2cae18c027 100644 --- a/avm/res/insights/component/README.md +++ b/avm/res/insights/component/README.md @@ -952,8 +952,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 100 ## Outputs diff --git a/avm/res/kusto/cluster/README.md b/avm/res/kusto/cluster/README.md index 83b98f070f..b40812a57d 100644 --- a/avm/res/kusto/cluster/README.md +++ b/avm/res/kusto/cluster/README.md @@ -1085,8 +1085,6 @@ The number of instances of the Kusto Cluster. - Required: No - Type: int - Default: `2` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `customerManagedKey` @@ -1094,8 +1092,6 @@ The customer managed key definition. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -1117,8 +1113,6 @@ The name of the customer managed key to use for encryption. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `customerManagedKey.keyVaultResourceId` @@ -1126,8 +1120,6 @@ The resource ID of a key vault to reference a customer managed key for encryptio - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `customerManagedKey.keyVersion` @@ -1135,8 +1127,6 @@ The version of the customer managed key to reference for encryption. If not prov - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `customerManagedKey.userAssignedIdentityResourceId` @@ -1144,8 +1134,6 @@ User assigned identity to use when fetching the customer managed key. Required i - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `databases` @@ -1153,8 +1141,6 @@ The Kusto Cluster databases. - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -1182,8 +1168,6 @@ The object type of the databse. 'ReadWrite' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `databases.name` @@ -1191,8 +1175,6 @@ The name of the Kusto Cluster database. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `databases.readWriteProperties` @@ -1200,8 +1182,6 @@ Required if the database kind is ReadWrite. Contains the properties of the datab - Required: No - Type: object -- MinValue: 2 -- MaxValue: 999 **Optional parameters** @@ -1217,8 +1197,6 @@ Te time the data should be kept in cache for fast queries in TimeSpan. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `databases.readWriteProperties.keyVaultProperties` @@ -1226,8 +1204,6 @@ The properties of the key vault. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 999 **Optional parameters** @@ -1244,8 +1220,6 @@ The name of the key. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `databases.readWriteProperties.keyVaultProperties.keyVaultUri` @@ -1253,8 +1227,6 @@ The Uri of the key vault. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `databases.readWriteProperties.keyVaultProperties.keyVersion` @@ -1262,8 +1234,6 @@ The version of the key. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `databases.readWriteProperties.keyVaultProperties.userIdentity` @@ -1271,8 +1241,6 @@ The user identity. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `databases.readWriteProperties.softDeletePeriod` @@ -1280,8 +1248,6 @@ The time the data should be kept before it stops being accessible to queries in - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings` @@ -1289,8 +1255,6 @@ The diagnostic settings of the service. - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 **Optional parameters** @@ -1312,8 +1276,6 @@ Resource ID of the diagnostic event hub authorization rule for the Event Hubs na - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.eventHubName` @@ -1321,8 +1283,6 @@ Name of the diagnostic event hub within the namespace to which logs are streamed - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.logAnalyticsDestinationType` @@ -1337,8 +1297,6 @@ A string indicating whether the export to Log Analytics should use the default d 'Dedicated' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.logCategoriesAndGroups` @@ -1346,8 +1304,6 @@ The name of logs that will be streamed. "allLogs" includes all possible logs for - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 **Optional parameters** @@ -1363,8 +1319,6 @@ Name of a Diagnostic Log category for a resource type this setting is applied to - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.categoryGroup` @@ -1372,8 +1326,6 @@ Name of a Diagnostic Log category group for a resource type this setting is appl - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.enabled` @@ -1381,8 +1333,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.marketplacePartnerResourceId` @@ -1390,8 +1340,6 @@ The full ARM resource ID of the Marketplace resource to which you would like to - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.metricCategories` @@ -1399,8 +1347,6 @@ The name of metrics that will be streamed. "allMetrics" includes all possible me - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -1420,8 +1366,6 @@ Name of a Diagnostic Metric category for a resource type this setting is applied - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.metricCategories.enabled` @@ -1429,8 +1373,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.name` @@ -1438,8 +1380,6 @@ The name of the diagnostic setting. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.storageAccountResourceId` @@ -1447,8 +1387,6 @@ Resource ID of the diagnostic storage account. For security reasons, it is recom - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `diagnosticSettings.workspaceResourceId` @@ -1456,8 +1394,6 @@ Resource ID of the diagnostic log analytics workspace. For security reasons, it - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `enableAutoScale` @@ -1466,8 +1402,6 @@ Enable/disable auto-scale. - Required: No - Type: bool - Default: `False` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `enableAutoStop` @@ -1476,8 +1410,6 @@ Enable/disable auto-stop. - Required: No - Type: bool - Default: `True` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `enableDiskEncryption` @@ -1486,8 +1418,6 @@ Enable/disable disk encryption. - Required: No - Type: bool - Default: `False` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `enableDoubleEncryption` @@ -1496,8 +1426,6 @@ Enable/disable double encryption. - Required: No - Type: bool - Default: `False` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `enablePublicNetworkAccess` @@ -1506,8 +1434,6 @@ Enable/disable public network access. If disabled, only private endpoint connect - Required: No - Type: bool - Default: `True` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `enablePurge` @@ -1516,8 +1442,6 @@ Enable/disable purge. - Required: No - Type: bool - Default: `False` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `enableRestrictOutboundNetworkAccess` @@ -1526,8 +1450,6 @@ Enable/disable restricting outbound network access. - Required: No - Type: bool - Default: `False` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `enableStreamingIngest` @@ -1536,8 +1458,6 @@ Enable/disable streaming ingest. - Required: No - Type: bool - Default: `False` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `enableTelemetry` @@ -1546,8 +1466,6 @@ Enable/disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `enableZoneRedundant` @@ -1556,8 +1474,6 @@ Enable/disable zone redundancy. - Required: No - Type: bool - Default: `False` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `engineType` @@ -1573,8 +1489,6 @@ The engine type of the Kusto Cluster. 'V3' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `languageExtensions` @@ -1583,8 +1497,6 @@ List of the language extensions of the Kusto Cluster. - Required: No - Type: array - Default: `[]` -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -1600,8 +1512,6 @@ The name of the language extension custom image. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `languageExtensions.languageExtensionImageName` @@ -1619,8 +1529,6 @@ The name of the language extension image. 'R' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `languageExtensions.languageExtensionName` @@ -1635,8 +1543,6 @@ The name of the language extension. 'R' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `location` @@ -1645,8 +1551,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `lock` @@ -1654,8 +1558,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 999 **Optional parameters** @@ -1678,8 +1580,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `lock.name` @@ -1687,8 +1587,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `managedIdentities` @@ -1696,8 +1594,6 @@ The managed identity definition for this resource. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 999 **Optional parameters** @@ -1712,8 +1608,6 @@ Enables system assigned managed identity on the resource. - Required: No - Type: bool -- MinValue: 2 -- MaxValue: 999 ### Parameter: `managedIdentities.userAssignedResourceIds` @@ -1721,8 +1615,6 @@ The resource ID(s) to assign to the resource. Required if a user assigned identi - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 ### Parameter: `principalAssignments` @@ -1730,8 +1622,6 @@ The Principal Assignments for the Kusto Cluster. - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -1753,8 +1643,6 @@ The principal id assigned to the Kusto Cluster principal. It can be a user email - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `principalAssignments.principalType` @@ -1770,8 +1658,6 @@ The principal type of the principal id. 'User' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `principalAssignments.role` @@ -1786,8 +1672,6 @@ The Kusto Cluster role to be assigned to the principal id. 'AllDatabasesViewer' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `principalAssignments.tenantId` @@ -1795,8 +1679,6 @@ The tenant id of the principal. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints` @@ -1804,8 +1686,6 @@ Configuration details for private endpoints. For security reasons, it is recomme - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -1840,8 +1720,6 @@ The subresource to deploy the private endpoint for. For example "blob", "table", - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.subnetResourceId` @@ -1849,8 +1727,6 @@ Resource ID of the subnet where the endpoint needs to be created. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.applicationSecurityGroupResourceIds` @@ -1858,8 +1734,6 @@ Application security groups in which the private endpoint IP configuration is in - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.customDnsConfigs` @@ -1867,8 +1741,6 @@ Custom DNS configurations. - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -1888,8 +1760,6 @@ A list of private IP addresses of the private endpoint. - Required: Yes - Type: array -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.customDnsConfigs.fqdn` @@ -1897,8 +1767,6 @@ FQDN that resolves to private endpoint IP address. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.customNetworkInterfaceName` @@ -1906,8 +1774,6 @@ The custom name of the network interface attached to the private endpoint. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.enableTelemetry` @@ -1915,8 +1781,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.ipConfigurations` @@ -1924,8 +1788,6 @@ A list of IP configurations of the private endpoint. This will be used to map to - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -1940,8 +1802,6 @@ The name of the resource that is unique within a resource group. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.ipConfigurations.properties` @@ -1949,8 +1809,6 @@ Properties of private endpoint IP configurations. - Required: Yes - Type: object -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -1966,8 +1824,6 @@ The ID of a group obtained from the remote resource that this private endpoint s - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.ipConfigurations.properties.memberName` @@ -1975,8 +1831,6 @@ The member name of a group obtained from the remote resource that this private e - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.ipConfigurations.properties.privateIPAddress` @@ -1984,8 +1838,6 @@ A private IP address obtained from the private endpoint's subnet. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.isManualConnection` @@ -1993,8 +1845,6 @@ If Manual Private Link Connection is required. - Required: No - Type: bool -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.location` @@ -2002,8 +1852,6 @@ The location to deploy the private endpoint to. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.lock` @@ -2011,8 +1859,6 @@ Specify the type of lock. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 999 **Optional parameters** @@ -2035,8 +1881,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.lock.name` @@ -2044,8 +1888,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.manualConnectionRequestMessage` @@ -2053,8 +1895,6 @@ A message passed to the owner of the remote resource with the manual connection - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.name` @@ -2062,8 +1902,6 @@ The name of the private endpoint. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.privateDnsZoneGroup` @@ -2071,8 +1909,6 @@ The private DNS zone group to configure for the private endpoint. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -2092,8 +1928,6 @@ The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group - Required: Yes - Type: array -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -2113,8 +1947,6 @@ The resource id of the private DNS zone. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name` @@ -2122,8 +1954,6 @@ The name of the private DNS Zone Group config. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.privateDnsZoneGroup.name` @@ -2131,8 +1961,6 @@ The name of the Private DNS Zone Group. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.privateLinkServiceConnectionName` @@ -2140,8 +1968,6 @@ The name of the private link connection to create. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.resourceGroupName` @@ -2149,8 +1975,6 @@ Specify if you want to deploy the Private Endpoint into a different resource gro - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.roleAssignments` @@ -2158,8 +1982,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 - Roles configurable by name: - `'Contributor'` - `'DNS Resolver Contributor'` @@ -2196,8 +2018,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.roleAssignments.roleDefinitionIdOrName` @@ -2205,8 +2025,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.roleAssignments.condition` @@ -2214,8 +2032,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.roleAssignments.conditionVersion` @@ -2229,8 +2045,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId` @@ -2238,8 +2052,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.roleAssignments.description` @@ -2247,8 +2059,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.roleAssignments.name` @@ -2256,8 +2066,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.roleAssignments.principalType` @@ -2275,8 +2083,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `privateEndpoints.tags` @@ -2284,8 +2090,6 @@ Tags to be applied on all resources/resource groups in this deployment. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 999 ### Parameter: `publicIPType` @@ -2302,8 +2106,6 @@ Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv 'IPv6' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `roleAssignments` @@ -2311,8 +2113,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 2 -- MaxValue: 999 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -2342,8 +2142,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -2351,8 +2149,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `roleAssignments.condition` @@ -2360,8 +2156,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `roleAssignments.conditionVersion` @@ -2375,8 +2169,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -2384,8 +2176,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `roleAssignments.description` @@ -2393,8 +2183,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `roleAssignments.name` @@ -2402,8 +2190,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `roleAssignments.principalType` @@ -2421,8 +2207,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `tags` @@ -2430,8 +2214,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 999 ### Parameter: `tier` @@ -2447,8 +2229,6 @@ The tier of the Kusto Cluster. 'Standard' ] ``` -- MinValue: 2 -- MaxValue: 999 ### Parameter: `trustedExternalTenants` @@ -2457,8 +2237,6 @@ The external tenants trusted by the Kusto Cluster. - Required: No - Type: array - Default: `[]` -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -2472,8 +2250,6 @@ GUID representing an external tenant. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `virtualClusterGraduationProperties` @@ -2481,8 +2257,6 @@ The virtual cluster graduation properties of the Kusto Cluster. - Required: No - Type: securestring -- MinValue: 2 -- MaxValue: 999 ### Parameter: `virtualNetworkConfiguration` @@ -2490,8 +2264,6 @@ The virtual network configuration of the Kusto Cluster. - Required: No - Type: object -- MinValue: 2 -- MaxValue: 999 **Required parameters** @@ -2507,8 +2279,6 @@ The public IP address resource id of the data management service.. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `virtualNetworkConfiguration.enginePublicIpResourceId` @@ -2516,8 +2286,6 @@ The public IP address resource id of the engine service. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ### Parameter: `virtualNetworkConfiguration.subnetResourceId` @@ -2525,8 +2293,6 @@ The resource ID of the subnet to which to deploy the Kusto Cluster. - Required: Yes - Type: string -- MinValue: 2 -- MaxValue: 999 ## Outputs diff --git a/avm/res/net-app/net-app-account/README.md b/avm/res/net-app/net-app-account/README.md index b2292b18e4..348600528f 100644 --- a/avm/res/net-app/net-app-account/README.md +++ b/avm/res/net-app/net-app-account/README.md @@ -1239,8 +1239,6 @@ Indicates whether the backup policy is enabled. - Required: No - Type: bool -- MinValue: 2 -- MaxValue: 1019 ### Parameter: `backupPolicies.location` @@ -1248,8 +1246,6 @@ The location of the backup policy. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 1019 ### Parameter: `backupPolicies.monthlyBackupsToKeep` @@ -1257,8 +1253,6 @@ The monthly backups to keep. - Required: No - Type: int -- MinValue: 2 -- MaxValue: 1019 ### Parameter: `backupPolicies.name` @@ -1266,8 +1260,6 @@ The name of the backup policy. - Required: No - Type: string -- MinValue: 2 -- MaxValue: 1019 ### Parameter: `backupPolicies.weeklyBackupsToKeep` @@ -1275,8 +1267,6 @@ The weekly backups to keep. - Required: No - Type: int -- MinValue: 2 -- MaxValue: 1019 ### Parameter: `backupVault` @@ -1413,8 +1403,6 @@ If enabled (true) the pool can contain cool Access enabled volumes. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.encryptionType` @@ -1429,8 +1417,6 @@ Encryption type of the capacity pool, set encryption type for data at rest for t 'Single' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.location` @@ -1438,8 +1424,6 @@ Location of the pool volume. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.qosType` @@ -1454,8 +1438,6 @@ The qos type of the pool. 'Manual' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.roleAssignments` @@ -1463,8 +1445,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2048 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -1496,8 +1476,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.roleAssignments.roleDefinitionIdOrName` @@ -1505,8 +1483,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.roleAssignments.condition` @@ -1514,8 +1490,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.roleAssignments.conditionVersion` @@ -1529,8 +1503,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.roleAssignments.delegatedManagedIdentityResourceId` @@ -1538,8 +1510,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.roleAssignments.description` @@ -1547,8 +1517,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.roleAssignments.name` @@ -1556,8 +1524,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.roleAssignments.principalType` @@ -1575,8 +1541,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.serviceLevel` @@ -1593,8 +1557,6 @@ The pool service level. 'Ultra' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.tags` @@ -1602,8 +1564,6 @@ Tags for the capcity pool. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes` @@ -1611,8 +1571,6 @@ List of volumes to create in the capacity pool. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -1652,8 +1610,6 @@ The name of the pool volume. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.subnetResourceId` @@ -1661,8 +1617,6 @@ The Azure Resource URI for a delegated subnet. Must have the delegation Microsof - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.usageThreshold` @@ -1670,8 +1624,6 @@ Maximum storage quota allowed for a file system in bytes. - Required: Yes - Type: int -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.zone` @@ -1679,8 +1631,6 @@ The Availability Zone to place the resource in. If set to 0, then Availability Z - Required: Yes - Type: int -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.coolAccess` @@ -1688,8 +1638,6 @@ If enabled (true) the pool can contain cool Access enabled volumes. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.coolAccessRetrievalPolicy` @@ -1697,8 +1645,6 @@ Determines the data retrieval behavior from the cool tier to standard storage ba - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.coolnessPeriod` @@ -1706,8 +1652,6 @@ Specifies the number of days after which data that is not accessed by clients wi - Required: No - Type: int -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.creationToken` @@ -1715,8 +1659,6 @@ A unique file path for the volume. This is the name of the volume export. A volu - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection` @@ -1724,8 +1666,6 @@ DataProtection type volumes include an object containing details of the replicat - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Optional parameters** @@ -1741,8 +1681,6 @@ Backup properties. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -1758,8 +1696,6 @@ The name of the backup policy to link. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection.backup.backupVaultName` @@ -1767,8 +1703,6 @@ The name of the Backup Vault. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection.backup.policyEnforced` @@ -1776,8 +1710,6 @@ Enable to enforce the policy. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection.replication` @@ -1785,8 +1717,6 @@ Replication properties. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -1816,8 +1746,6 @@ Indicates whether the local volume is the source or destination for the Volume R 'src' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection.replication.replicationSchedule` @@ -1833,8 +1761,6 @@ The replication schedule for the volume. 'hourly' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection.replication.remotePath` @@ -1842,8 +1768,6 @@ The full path to a volume that is to be migrated into ANF. Required for Migratio - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -1859,8 +1783,6 @@ The Path to a ONTAP Host. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection.replication.remotePath.serverName` @@ -1868,8 +1790,6 @@ The name of a server on the ONTAP Host. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection.replication.remotePath.volumeName` @@ -1877,8 +1797,6 @@ The name of a volume on the server. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection.replication.remoteVolumeRegion` @@ -1886,8 +1804,6 @@ The remote region for the other end of the Volume Replication.Required for Data - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection.replication.remoteVolumeResourceId` @@ -1895,8 +1811,6 @@ The resource ID of the remote volume. Required for Data Protection volumes. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.dataProtection.snapshot` @@ -1904,8 +1818,6 @@ Snapshot properties. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -1919,8 +1831,6 @@ The name of the snapshot policy to link. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.encryptionKeySource` @@ -1928,8 +1838,6 @@ The source of the encryption key. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy` @@ -1937,8 +1845,6 @@ Export policy rules. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -1952,8 +1858,6 @@ The Export policy rules. - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -1986,8 +1890,6 @@ Kerberos5i Read only access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.kerberos5iReadWrite` @@ -1995,8 +1897,6 @@ Kerberos5i Read and write access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.kerberos5pReadOnly` @@ -2004,8 +1904,6 @@ Kerberos5p Read only access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.kerberos5pReadWrite` @@ -2013,8 +1911,6 @@ Kerberos5p Read and write access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.kerberos5ReadOnly` @@ -2022,8 +1918,6 @@ Kerberos5 Read only access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.kerberos5ReadWrite` @@ -2031,8 +1925,6 @@ Kerberos5 Read and write access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.nfsv3` @@ -2040,8 +1932,6 @@ Allows NFSv3 protocol. Enable only for NFSv3 type volumes. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.nfsv41` @@ -2049,8 +1939,6 @@ Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.ruleIndex` @@ -2058,8 +1946,6 @@ Order index. - Required: Yes - Type: int -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.unixReadOnly` @@ -2067,8 +1953,6 @@ Read only access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.unixReadWrite` @@ -2076,8 +1960,6 @@ Read and write access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.allowedClients` @@ -2085,8 +1967,6 @@ Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 hos - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.chownMode` @@ -2101,8 +1981,6 @@ This parameter specifies who is authorized to change the ownership of a file. re 'Unrestricted' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.cifs` @@ -2110,8 +1988,6 @@ Allows CIFS protocol. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.exportPolicy.rules.hasRootAccess` @@ -2119,8 +1995,6 @@ Has root access to volume. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.kerberosEnabled` @@ -2128,8 +2002,6 @@ Define if a volume is KerberosEnabled. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.keyVaultPrivateEndpointResourceId` @@ -2137,8 +2009,6 @@ The resource ID of the key vault private endpoint. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.location` @@ -2146,8 +2016,6 @@ Location of the pool volume. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.networkFeatures` @@ -2164,8 +2032,6 @@ Network feature for the volume. 'Standard_Basic' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.protocolTypes` @@ -2181,8 +2047,6 @@ Set of protocol types. Default value is `['NFSv3']`. If you are creating a dual- 'NFSv4.1' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.roleAssignments` @@ -2190,8 +2054,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2048 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -2223,8 +2085,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.roleAssignments.roleDefinitionIdOrName` @@ -2232,8 +2092,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.roleAssignments.condition` @@ -2241,8 +2099,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.roleAssignments.conditionVersion` @@ -2256,8 +2112,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.roleAssignments.delegatedManagedIdentityResourceId` @@ -2265,8 +2119,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.roleAssignments.description` @@ -2274,8 +2126,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.roleAssignments.name` @@ -2283,8 +2133,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.roleAssignments.principalType` @@ -2302,8 +2150,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.serviceLevel` @@ -2320,8 +2166,6 @@ The pool service level. Must match the one of the parent capacity pool. 'Ultra' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.smbContinuouslyAvailable` @@ -2329,8 +2173,6 @@ Enables continuously available share property for SMB volume. Only applicable fo - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.smbEncryption` @@ -2338,8 +2180,6 @@ Enables SMB encryption. Only applicable for SMB/DualProtocol volume. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.smbNonBrowsable` @@ -2354,8 +2194,6 @@ Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProto 'Enabled' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `capacityPools.volumes.volumeType` @@ -2363,8 +2201,6 @@ The type of the volume. DataProtection volumes are used for replication. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `customerManagedKey` @@ -2762,8 +2598,6 @@ Resource size in bytes, current storage usage for the volume in bytes. - Required: No - Type: int -- MinValue: 1 -- MaxValue: 255 ### Parameter: `snapshotPolicies.hourlySchedule` @@ -2809,8 +2643,6 @@ Resource size in bytes, current storage usage for the volume in bytes. - Required: No - Type: int -- MinValue: 1 -- MaxValue: 255 ### Parameter: `snapshotPolicies.location` @@ -2881,8 +2713,6 @@ Resource size in bytes, current storage usage for the volume in bytes. - Required: No - Type: int -- MinValue: 1 -- MaxValue: 255 ### Parameter: `snapshotPolicies.weeklySchedule` @@ -2958,8 +2788,6 @@ Resource size in bytes, current storage usage for the volume in bytes. - Required: No - Type: int -- MinValue: 1 -- MaxValue: 255 ### Parameter: `tags` diff --git a/avm/res/net-app/net-app-account/backup-policies/README.md b/avm/res/net-app/net-app-account/backup-policies/README.md index a4a644ab10..bac2e39f0f 100644 --- a/avm/res/net-app/net-app-account/backup-policies/README.md +++ b/avm/res/net-app/net-app-account/backup-policies/README.md @@ -57,8 +57,6 @@ Indicates whether the backup policy is enabled. - Required: No - Type: bool - Default: `True` -- MinValue: 2 -- MaxValue: 1019 ### Parameter: `location` @@ -67,8 +65,6 @@ The location of the backup policy. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 2 -- MaxValue: 1019 ### Parameter: `monthlyBackupsToKeep` @@ -77,8 +73,6 @@ The monthly backups to keep. - Required: No - Type: int - Default: `0` -- MinValue: 2 -- MaxValue: 1019 ### Parameter: `name` @@ -87,8 +81,6 @@ The name of the backup policy. - Required: No - Type: string - Default: `'backupPolicy'` -- MinValue: 2 -- MaxValue: 1019 ### Parameter: `weeklyBackupsToKeep` @@ -97,8 +89,6 @@ The weekly backups to keep. - Required: No - Type: int - Default: `0` -- MinValue: 2 -- MaxValue: 1019 ## Outputs diff --git a/avm/res/net-app/net-app-account/capacity-pool/README.md b/avm/res/net-app/net-app-account/capacity-pool/README.md index 58beb2547c..a935cb01b6 100644 --- a/avm/res/net-app/net-app-account/capacity-pool/README.md +++ b/avm/res/net-app/net-app-account/capacity-pool/README.md @@ -67,8 +67,6 @@ The name of the parent NetApp account. Required if the template is used in a sta - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `coolAccess` @@ -77,8 +75,6 @@ If enabled (true) the pool can contain cool Access enabled volumes. - Required: No - Type: bool - Default: `False` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `encryptionType` @@ -94,8 +90,6 @@ Encryption type of the capacity pool, set encryption type for data at rest for t 'Single' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `location` @@ -104,8 +98,6 @@ Location of the pool volume. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `qosType` @@ -121,8 +113,6 @@ The qos type of the pool. 'Manual' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `roleAssignments` @@ -130,8 +120,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2048 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -163,8 +151,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -172,8 +158,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `roleAssignments.condition` @@ -181,8 +165,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `roleAssignments.conditionVersion` @@ -196,8 +178,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -205,8 +185,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `roleAssignments.description` @@ -214,8 +192,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `roleAssignments.name` @@ -223,8 +199,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `roleAssignments.principalType` @@ -242,8 +216,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `serviceLevel` @@ -261,8 +233,6 @@ The pool service level. 'Ultra' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `tags` @@ -270,8 +240,6 @@ Tags for all resources. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes` @@ -279,8 +247,6 @@ List of volumes to create in the capacity pool. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -320,8 +286,6 @@ The name of the pool volume. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.subnetResourceId` @@ -329,8 +293,6 @@ The Azure Resource URI for a delegated subnet. Must have the delegation Microsof - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.usageThreshold` @@ -338,8 +300,6 @@ Maximum storage quota allowed for a file system in bytes. - Required: Yes - Type: int -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.zone` @@ -347,8 +307,6 @@ The Availability Zone to place the resource in. If set to 0, then Availability Z - Required: Yes - Type: int -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.coolAccess` @@ -356,8 +314,6 @@ If enabled (true) the pool can contain cool Access enabled volumes. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.coolAccessRetrievalPolicy` @@ -365,8 +321,6 @@ Determines the data retrieval behavior from the cool tier to standard storage ba - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.coolnessPeriod` @@ -374,8 +328,6 @@ Specifies the number of days after which data that is not accessed by clients wi - Required: No - Type: int -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.creationToken` @@ -383,8 +335,6 @@ A unique file path for the volume. This is the name of the volume export. A volu - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection` @@ -392,8 +342,6 @@ DataProtection type volumes include an object containing details of the replicat - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Optional parameters** @@ -409,8 +357,6 @@ Backup properties. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -426,8 +372,6 @@ The name of the backup policy to link. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection.backup.backupVaultName` @@ -435,8 +379,6 @@ The name of the Backup Vault. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection.backup.policyEnforced` @@ -444,8 +386,6 @@ Enable to enforce the policy. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection.replication` @@ -453,8 +393,6 @@ Replication properties. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -484,8 +422,6 @@ Indicates whether the local volume is the source or destination for the Volume R 'src' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection.replication.replicationSchedule` @@ -501,8 +437,6 @@ The replication schedule for the volume. 'hourly' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection.replication.remotePath` @@ -510,8 +444,6 @@ The full path to a volume that is to be migrated into ANF. Required for Migratio - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -527,8 +459,6 @@ The Path to a ONTAP Host. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection.replication.remotePath.serverName` @@ -536,8 +466,6 @@ The name of a server on the ONTAP Host. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection.replication.remotePath.volumeName` @@ -545,8 +473,6 @@ The name of a volume on the server. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection.replication.remoteVolumeRegion` @@ -554,8 +480,6 @@ The remote region for the other end of the Volume Replication.Required for Data - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection.replication.remoteVolumeResourceId` @@ -563,8 +487,6 @@ The resource ID of the remote volume. Required for Data Protection volumes. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.dataProtection.snapshot` @@ -572,8 +494,6 @@ Snapshot properties. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -587,8 +507,6 @@ The name of the snapshot policy to link. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.encryptionKeySource` @@ -596,8 +514,6 @@ The source of the encryption key. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy` @@ -605,8 +521,6 @@ Export policy rules. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -620,8 +534,6 @@ The Export policy rules. - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 2048 **Required parameters** @@ -654,8 +566,6 @@ Kerberos5i Read only access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.kerberos5iReadWrite` @@ -663,8 +573,6 @@ Kerberos5i Read and write access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.kerberos5pReadOnly` @@ -672,8 +580,6 @@ Kerberos5p Read only access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.kerberos5pReadWrite` @@ -681,8 +587,6 @@ Kerberos5p Read and write access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.kerberos5ReadOnly` @@ -690,8 +594,6 @@ Kerberos5 Read only access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.kerberos5ReadWrite` @@ -699,8 +601,6 @@ Kerberos5 Read and write access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.nfsv3` @@ -708,8 +608,6 @@ Allows NFSv3 protocol. Enable only for NFSv3 type volumes. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.nfsv41` @@ -717,8 +615,6 @@ Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.ruleIndex` @@ -726,8 +622,6 @@ Order index. - Required: Yes - Type: int -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.unixReadOnly` @@ -735,8 +629,6 @@ Read only access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.unixReadWrite` @@ -744,8 +636,6 @@ Read and write access. - Required: Yes - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.allowedClients` @@ -753,8 +643,6 @@ Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 hos - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.chownMode` @@ -769,8 +657,6 @@ This parameter specifies who is authorized to change the ownership of a file. re 'Unrestricted' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.cifs` @@ -778,8 +664,6 @@ Allows CIFS protocol. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.exportPolicy.rules.hasRootAccess` @@ -787,8 +671,6 @@ Has root access to volume. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.kerberosEnabled` @@ -796,8 +678,6 @@ Define if a volume is KerberosEnabled. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.keyVaultPrivateEndpointResourceId` @@ -805,8 +685,6 @@ The resource ID of the key vault private endpoint. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.location` @@ -814,8 +692,6 @@ Location of the pool volume. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.networkFeatures` @@ -832,8 +708,6 @@ Network feature for the volume. 'Standard_Basic' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.protocolTypes` @@ -849,8 +723,6 @@ Set of protocol types. Default value is `['NFSv3']`. If you are creating a dual- 'NFSv4.1' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.roleAssignments` @@ -858,8 +730,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 2048 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -891,8 +761,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.roleAssignments.roleDefinitionIdOrName` @@ -900,8 +768,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.roleAssignments.condition` @@ -909,8 +775,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.roleAssignments.conditionVersion` @@ -924,8 +788,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.roleAssignments.delegatedManagedIdentityResourceId` @@ -933,8 +795,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.roleAssignments.description` @@ -942,8 +802,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.roleAssignments.name` @@ -951,8 +809,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.roleAssignments.principalType` @@ -970,8 +826,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.serviceLevel` @@ -988,8 +842,6 @@ The pool service level. Must match the one of the parent capacity pool. 'Ultra' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.smbContinuouslyAvailable` @@ -997,8 +849,6 @@ Enables continuously available share property for SMB volume. Only applicable fo - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.smbEncryption` @@ -1006,8 +856,6 @@ Enables SMB encryption. Only applicable for SMB/DualProtocol volume. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.smbNonBrowsable` @@ -1022,8 +870,6 @@ Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProto 'Enabled' ] ``` -- MinValue: 1 -- MaxValue: 2048 ### Parameter: `volumes.volumeType` @@ -1031,8 +877,6 @@ The type of the volume. DataProtection volumes are used for replication. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 2048 ## Outputs diff --git a/avm/res/net-app/net-app-account/snapshot-policies/README.md b/avm/res/net-app/net-app-account/snapshot-policies/README.md index ca1f6c285a..8e6f9df05e 100644 --- a/avm/res/net-app/net-app-account/snapshot-policies/README.md +++ b/avm/res/net-app/net-app-account/snapshot-policies/README.md @@ -95,8 +95,6 @@ Resource size in bytes, current storage usage for the volume in bytes. - Required: No - Type: int -- MinValue: 1 -- MaxValue: 255 ### Parameter: `hourlySchedule` @@ -142,8 +140,6 @@ Resource size in bytes, current storage usage for the volume in bytes. - Required: No - Type: int -- MinValue: 1 -- MaxValue: 255 ### Parameter: `location` @@ -215,8 +211,6 @@ Resource size in bytes, current storage usage for the volume in bytes. - Required: No - Type: int -- MinValue: 1 -- MaxValue: 255 ### Parameter: `name` @@ -308,8 +302,6 @@ Resource size in bytes, current storage usage for the volume in bytes. - Required: No - Type: int -- MinValue: 1 -- MaxValue: 255 ## Outputs diff --git a/avm/res/network/application-gateway/README.md b/avm/res/network/application-gateway/README.md index 09941011da..7d860f85ed 100644 --- a/avm/res/network/application-gateway/README.md +++ b/avm/res/network/application-gateway/README.md @@ -3200,8 +3200,6 @@ Custom error configurations of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings` @@ -3209,8 +3207,6 @@ The diagnostic settings of the service. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 10 **Optional parameters** @@ -3232,8 +3228,6 @@ Resource ID of the diagnostic event hub authorization rule for the Event Hubs na - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.eventHubName` @@ -3241,8 +3235,6 @@ Name of the diagnostic event hub within the namespace to which logs are streamed - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.logAnalyticsDestinationType` @@ -3257,8 +3249,6 @@ A string indicating whether the export to Log Analytics should use the default d 'Dedicated' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.logCategoriesAndGroups` @@ -3266,8 +3256,6 @@ The name of logs that will be streamed. "allLogs" includes all possible logs for - Required: No - Type: array -- MinValue: 0 -- MaxValue: 10 **Optional parameters** @@ -3283,8 +3271,6 @@ Name of a Diagnostic Log category for a resource type this setting is applied to - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.categoryGroup` @@ -3292,8 +3278,6 @@ Name of a Diagnostic Log category group for a resource type this setting is appl - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.enabled` @@ -3301,8 +3285,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.marketplacePartnerResourceId` @@ -3310,8 +3292,6 @@ The full ARM resource ID of the Marketplace resource to which you would like to - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.metricCategories` @@ -3319,8 +3299,6 @@ The name of metrics that will be streamed. "allMetrics" includes all possible me - Required: No - Type: array -- MinValue: 0 -- MaxValue: 10 **Required parameters** @@ -3340,8 +3318,6 @@ Name of a Diagnostic Metric category for a resource type this setting is applied - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.metricCategories.enabled` @@ -3349,8 +3325,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.name` @@ -3358,8 +3332,6 @@ The name of diagnostic setting. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.storageAccountResourceId` @@ -3367,8 +3339,6 @@ Resource ID of the diagnostic storage account. For security reasons, it is recom - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `diagnosticSettings.workspaceResourceId` @@ -3376,8 +3346,6 @@ Resource ID of the diagnostic log analytics workspace. For security reasons, it - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `enableFips` @@ -3386,8 +3354,6 @@ Whether FIPS is enabled on the application gateway resource. - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `enableHttp2` @@ -3396,8 +3362,6 @@ Whether HTTP2 is enabled on the application gateway resource. - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `enableRequestBuffering` @@ -3406,8 +3370,6 @@ Enable request buffering. - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `enableResponseBuffering` @@ -3416,8 +3378,6 @@ Enable response buffering. - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `enableTelemetry` @@ -3426,8 +3386,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `firewallPolicyResourceId` @@ -3436,8 +3394,6 @@ The resource ID of an associated firewall policy. Should be configured for secur - Required: No - Type: string - Default: `''` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `frontendIPConfigurations` @@ -3446,8 +3402,6 @@ Frontend IP addresses of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `frontendPorts` @@ -3456,8 +3410,6 @@ Frontend ports of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `gatewayIPConfigurations` @@ -3466,8 +3418,6 @@ Subnets of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `httpListeners` @@ -3476,8 +3426,6 @@ Http listeners of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `listeners` @@ -3486,8 +3434,6 @@ Listeners of the application gateway resource. For default limits, see [Applicat - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `loadDistributionPolicies` @@ -3496,8 +3442,6 @@ Load distribution policies of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `location` @@ -3506,8 +3450,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `lock` @@ -3515,8 +3457,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 10 **Optional parameters** @@ -3539,8 +3479,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `lock.name` @@ -3548,8 +3486,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `managedIdentities` @@ -3557,8 +3493,6 @@ The managed identity definition for this resource. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 10 **Optional parameters** @@ -3572,8 +3506,6 @@ The resource ID(s) to assign to the resource. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints` @@ -3581,8 +3513,6 @@ Configuration details for private endpoints. For security reasons, it is recomme - Required: No - Type: array -- MinValue: 0 -- MaxValue: 10 **Required parameters** @@ -3617,8 +3547,6 @@ The subresource to deploy the private endpoint for. For example "blob", "table", - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.subnetResourceId` @@ -3626,8 +3554,6 @@ Resource ID of the subnet where the endpoint needs to be created. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.applicationSecurityGroupResourceIds` @@ -3635,8 +3561,6 @@ Application security groups in which the private endpoint IP configuration is in - Required: No - Type: array -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.customDnsConfigs` @@ -3644,8 +3568,6 @@ Custom DNS configurations. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 10 **Required parameters** @@ -3665,8 +3587,6 @@ A list of private IP addresses of the private endpoint. - Required: Yes - Type: array -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.customDnsConfigs.fqdn` @@ -3674,8 +3594,6 @@ FQDN that resolves to private endpoint IP address. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.customNetworkInterfaceName` @@ -3683,8 +3601,6 @@ The custom name of the network interface attached to the private endpoint. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.enableTelemetry` @@ -3692,8 +3608,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.ipConfigurations` @@ -3701,8 +3615,6 @@ A list of IP configurations of the private endpoint. This will be used to map to - Required: No - Type: array -- MinValue: 0 -- MaxValue: 10 **Required parameters** @@ -3717,8 +3629,6 @@ The name of the resource that is unique within a resource group. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.ipConfigurations.properties` @@ -3726,8 +3636,6 @@ Properties of private endpoint IP configurations. - Required: Yes - Type: object -- MinValue: 0 -- MaxValue: 10 **Required parameters** @@ -3743,8 +3651,6 @@ The ID of a group obtained from the remote resource that this private endpoint s - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.ipConfigurations.properties.memberName` @@ -3752,8 +3658,6 @@ The member name of a group obtained from the remote resource that this private e - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.ipConfigurations.properties.privateIPAddress` @@ -3761,8 +3665,6 @@ A private IP address obtained from the private endpoint's subnet. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.isManualConnection` @@ -3770,8 +3672,6 @@ If Manual Private Link Connection is required. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.location` @@ -3779,8 +3679,6 @@ The location to deploy the private endpoint to. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.lock` @@ -3788,8 +3686,6 @@ Specify the type of lock. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 10 **Optional parameters** @@ -3812,8 +3708,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.lock.name` @@ -3821,8 +3715,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.manualConnectionRequestMessage` @@ -3830,8 +3722,6 @@ A message passed to the owner of the remote resource with the manual connection - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.name` @@ -3839,8 +3729,6 @@ The name of the private endpoint. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.privateDnsZoneGroup` @@ -3848,8 +3736,6 @@ The private DNS zone group to configure for the private endpoint. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 10 **Required parameters** @@ -3869,8 +3755,6 @@ The private DNS zone groups to associate the private endpoint. A DNS zone group - Required: Yes - Type: array -- MinValue: 0 -- MaxValue: 10 **Required parameters** @@ -3890,8 +3774,6 @@ The resource id of the private DNS zone. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name` @@ -3899,8 +3781,6 @@ The name of the private DNS zone group config. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.privateDnsZoneGroup.name` @@ -3908,8 +3788,6 @@ The name of the Private DNS Zone Group. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.privateLinkServiceConnectionName` @@ -3917,8 +3795,6 @@ The name of the private link connection to create. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.resourceGroupName` @@ -3926,8 +3802,6 @@ Specify if you want to deploy the Private Endpoint into a different resource gro - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.roleAssignments` @@ -3935,8 +3809,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 10 - Roles configurable by name: - `'Contributor'` - `'DNS Resolver Contributor'` @@ -3973,8 +3845,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.roleAssignments.roleDefinitionIdOrName` @@ -3982,8 +3852,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.roleAssignments.condition` @@ -3991,8 +3859,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.roleAssignments.conditionVersion` @@ -4006,8 +3872,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId` @@ -4015,8 +3879,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.roleAssignments.description` @@ -4024,8 +3886,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.roleAssignments.name` @@ -4033,8 +3893,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.roleAssignments.principalType` @@ -4052,8 +3910,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateEndpoints.tags` @@ -4061,8 +3917,6 @@ Tags to be applied on all resources/resource groups in this deployment. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 10 ### Parameter: `privateLinkConfigurations` @@ -4071,8 +3925,6 @@ PrivateLink configurations on application gateway. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `probes` @@ -4081,8 +3933,6 @@ Probes of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `redirectConfigurations` @@ -4091,8 +3941,6 @@ Redirect configurations of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `requestRoutingRules` @@ -4101,8 +3949,6 @@ Request routing rules of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `rewriteRuleSets` @@ -4111,8 +3957,6 @@ Rewrite rules for the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `roleAssignments` @@ -4120,8 +3964,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 10 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -4153,8 +3995,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -4162,8 +4002,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `roleAssignments.condition` @@ -4171,8 +4009,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `roleAssignments.conditionVersion` @@ -4186,8 +4022,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -4195,8 +4029,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `roleAssignments.description` @@ -4204,8 +4036,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `roleAssignments.name` @@ -4213,8 +4043,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 0 -- MaxValue: 10 ### Parameter: `roleAssignments.principalType` @@ -4232,8 +4060,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `routingRules` @@ -4242,8 +4068,6 @@ Routing rules of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `sku` @@ -4264,8 +4088,6 @@ The name of the SKU for the Application Gateway. 'WAF_v2' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `sslCertificates` @@ -4274,8 +4096,6 @@ SSL certificates of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `sslPolicyCipherSuites` @@ -4323,8 +4143,6 @@ Ssl cipher suites to be enabled in the specified order to application gateway. 'TLS_RSA_WITH_AES_256_GCM_SHA384' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `sslPolicyMinProtocolVersion` @@ -4342,8 +4160,6 @@ Ssl protocol enums. 'TLSv1_3' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `sslPolicyName` @@ -4363,8 +4179,6 @@ Ssl predefined policy name enums. 'AppGwSslPolicy20220101S' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `sslPolicyType` @@ -4381,8 +4195,6 @@ Type of Ssl Policy. 'Predefined' ] ``` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `sslProfiles` @@ -4391,8 +4203,6 @@ SSL profiles of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `tags` @@ -4400,8 +4210,6 @@ Resource tags. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 10 ### Parameter: `trustedClientCertificates` @@ -4410,8 +4218,6 @@ Trusted client certificates of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `trustedRootCertificates` @@ -4420,8 +4226,6 @@ Trusted Root certificates of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `urlPathMaps` @@ -4430,8 +4234,6 @@ URL path map of the application gateway resource. - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `webApplicationFirewallConfiguration` @@ -4440,8 +4242,6 @@ Application gateway web application firewall configuration. Should be configured - Required: No - Type: object - Default: `{}` -- MinValue: 0 -- MaxValue: 10 ### Parameter: `zones` @@ -4457,8 +4257,6 @@ A list of availability zones denoting where the resource needs to come from. 3 ] ``` -- MinValue: 0 -- MaxValue: 10 ## Outputs diff --git a/avm/res/network/azure-firewall/README.md b/avm/res/network/azure-firewall/README.md index 4dca2f609d..2384bbe363 100644 --- a/avm/res/network/azure-firewall/README.md +++ b/avm/res/network/azure-firewall/README.md @@ -2003,8 +2003,6 @@ Collection of rules used by a application rule collection. - Required: Yes - Type: array -- MinValue: 100 -- MaxValue: 65000 **Required parameters** @@ -2029,8 +2027,6 @@ Name of the application rule. - Required: Yes - Type: string -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `applicationRuleCollections.properties.rules.protocols` @@ -2038,8 +2034,6 @@ Array of ApplicationRuleProtocols. - Required: Yes - Type: array -- MinValue: 100 -- MaxValue: 65000 **Required parameters** @@ -2067,8 +2061,6 @@ Protocol type. 'Mssql' ] ``` -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `applicationRuleCollections.properties.rules.protocols.port` @@ -2076,7 +2068,6 @@ Port number for the protocol. - Required: No - Type: int -- MinValue: 100 - MaxValue: 64000 ### Parameter: `applicationRuleCollections.properties.rules.description` @@ -2085,8 +2076,6 @@ Description of the rule. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `applicationRuleCollections.properties.rules.fqdnTags` @@ -2094,8 +2083,6 @@ List of FQDN Tags for this rule. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `applicationRuleCollections.properties.rules.sourceAddresses` @@ -2103,8 +2090,6 @@ List of source IP addresses for this rule. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `applicationRuleCollections.properties.rules.sourceIpGroups` @@ -2112,8 +2097,6 @@ List of source IpGroups for this rule. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `applicationRuleCollections.properties.rules.targetFqdns` @@ -2121,8 +2104,6 @@ List of FQDNs for this rule. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `azureSkuTier` @@ -2448,8 +2429,6 @@ Collection of rules used by a NAT rule collection. - Required: Yes - Type: array -- MinValue: 100 -- MaxValue: 65000 **Required parameters** @@ -2477,8 +2456,6 @@ Name of the NAT rule. - Required: Yes - Type: string -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `natRuleCollections.properties.rules.protocols` @@ -2495,8 +2472,6 @@ Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. 'UDP' ] ``` -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `natRuleCollections.properties.rules.description` @@ -2504,8 +2479,6 @@ Description of the rule. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `natRuleCollections.properties.rules.destinationAddresses` @@ -2513,8 +2486,6 @@ List of destination IP addresses for this rule. Supports IP ranges, prefixes, an - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `natRuleCollections.properties.rules.destinationPorts` @@ -2522,8 +2493,6 @@ List of destination ports. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `natRuleCollections.properties.rules.sourceAddresses` @@ -2531,8 +2500,6 @@ List of source IP addresses for this rule. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `natRuleCollections.properties.rules.sourceIpGroups` @@ -2540,8 +2507,6 @@ List of source IpGroups for this rule. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `natRuleCollections.properties.rules.translatedAddress` @@ -2549,8 +2514,6 @@ The translated address for this NAT rule. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `natRuleCollections.properties.rules.translatedFqdn` @@ -2558,8 +2521,6 @@ The translated FQDN for this NAT rule. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `natRuleCollections.properties.rules.translatedPort` @@ -2567,8 +2528,6 @@ The translated port for this NAT rule. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `networkRuleCollections` @@ -2648,8 +2607,6 @@ Collection of rules used by a network rule collection. - Required: Yes - Type: array -- MinValue: 100 -- MaxValue: 65000 **Required parameters** @@ -2676,8 +2633,6 @@ Name of the network rule. - Required: Yes - Type: string -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `networkRuleCollections.properties.rules.protocols` @@ -2694,8 +2649,6 @@ Array of AzureFirewallNetworkRuleProtocols. 'UDP' ] ``` -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `networkRuleCollections.properties.rules.description` @@ -2703,8 +2656,6 @@ Description of the rule. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `networkRuleCollections.properties.rules.destinationAddresses` @@ -2712,8 +2663,6 @@ List of destination IP addresses. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `networkRuleCollections.properties.rules.destinationFqdns` @@ -2721,8 +2670,6 @@ List of destination FQDNs. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `networkRuleCollections.properties.rules.destinationIpGroups` @@ -2730,8 +2677,6 @@ List of destination IP groups for this rule. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `networkRuleCollections.properties.rules.destinationPorts` @@ -2739,8 +2684,6 @@ List of destination ports. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `networkRuleCollections.properties.rules.sourceAddresses` @@ -2748,8 +2691,6 @@ List of source IP addresses for this rule. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `networkRuleCollections.properties.rules.sourceIpGroups` @@ -2757,8 +2698,6 @@ List of source IpGroups for this rule. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 65000 ### Parameter: `publicIPAddressObject` diff --git a/avm/res/network/connection/README.md b/avm/res/network/connection/README.md index 68255dbeb1..85bc6240ea 100644 --- a/avm/res/network/connection/README.md +++ b/avm/res/network/connection/README.md @@ -537,8 +537,6 @@ Value to specify if BGP is enabled or not. - Required: No - Type: bool - Default: `False` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `enablePrivateLinkFastPath` @@ -547,8 +545,6 @@ Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastP - Required: No - Type: bool - Default: `False` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `enableTelemetry` @@ -557,8 +553,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `expressRouteGatewayBypass` @@ -567,8 +561,6 @@ Bypass ExpressRoute Gateway for data forwarding. Only available when connection - Required: No - Type: bool - Default: `False` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `localNetworkGateway2` @@ -577,8 +569,6 @@ The local network gateway. Used for connection type [IPsec]. - Required: No - Type: object - Default: `{}` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `location` @@ -587,8 +577,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `lock` @@ -596,8 +584,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 9 -- MaxValue: 3600 **Optional parameters** @@ -620,8 +606,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `lock.name` @@ -629,8 +613,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `peer` @@ -639,8 +621,6 @@ The remote peer. Used for connection connectionType [ExpressRoute]. - Required: No - Type: object - Default: `{}` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `routingWeight` @@ -648,8 +628,6 @@ The weight added to routes learned from this BGP speaker. - Required: No - Type: int -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `tags` @@ -657,8 +635,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `trafficSelectorPolicies` @@ -667,8 +643,6 @@ The traffic selector policies to be considered by this connection. - Required: No - Type: array - Default: `[]` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `useLocalAzureIpAddress` @@ -677,8 +651,6 @@ Use private local Azure IP for the connection. Only available for IPSec Virtual - Required: No - Type: bool - Default: `False` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `usePolicyBasedTrafficSelectors` @@ -687,8 +659,6 @@ Enable policy-based traffic selectors. - Required: No - Type: bool - Default: `False` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `virtualNetworkGateway2` @@ -697,8 +667,6 @@ The remote Virtual Network Gateway. Used for connection connectionType [Vnet2Vne - Required: No - Type: object - Default: `{}` -- MinValue: 9 -- MaxValue: 3600 ### Parameter: `vpnSharedKey` @@ -707,8 +675,6 @@ Specifies a VPN shared key. The same value has to be specified on both Virtual N - Required: No - Type: securestring - Default: `''` -- MinValue: 9 -- MaxValue: 3600 ## Outputs diff --git a/avm/res/network/dns-zone/README.md b/avm/res/network/dns-zone/README.md index b3df572f8d..ca4136d6d4 100644 --- a/avm/res/network/dns-zone/README.md +++ b/avm/res/network/dns-zone/README.md @@ -1658,8 +1658,6 @@ The tag for this CAA record.. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 255 ### Parameter: `caa.caaRecords.value` @@ -1667,8 +1665,6 @@ The value for this CAA record. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 255 ### Parameter: `caa.metadata` diff --git a/avm/res/network/front-door/README.md b/avm/res/network/front-door/README.md index 443abc8459..ce21606726 100644 --- a/avm/res/network/front-door/README.md +++ b/avm/res/network/front-door/README.md @@ -1628,7 +1628,6 @@ Resource tags. - Required: No - Type: object -- MaxValue: 240 ## Outputs diff --git a/avm/res/network/load-balancer/inbound-nat-rule/README.md b/avm/res/network/load-balancer/inbound-nat-rule/README.md index dc017f754e..f329260585 100644 --- a/avm/res/network/load-balancer/inbound-nat-rule/README.md +++ b/avm/res/network/load-balancer/inbound-nat-rule/README.md @@ -63,8 +63,6 @@ The name of the frontend IP address to set for the inbound NAT rule. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 65535 ### Parameter: `name` @@ -72,8 +70,6 @@ The name of the inbound NAT rule. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 65535 ### Parameter: `frontendPort` @@ -99,8 +95,6 @@ The name of the parent load balancer. Required if the template is used in a stan - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 65534 ### Parameter: `backendAddressPoolName` @@ -109,8 +103,6 @@ Name of the backend address pool. - Required: No - Type: string - Default: `''` -- MinValue: 0 -- MaxValue: 65534 ### Parameter: `enableFloatingIP` @@ -119,8 +111,6 @@ Configures a virtual machine's endpoint for the floating IP capability required - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 65534 ### Parameter: `enableTcpReset` @@ -129,8 +119,6 @@ Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connectio - Required: No - Type: bool - Default: `False` -- MinValue: 0 -- MaxValue: 65534 ### Parameter: `idleTimeoutInMinutes` @@ -139,8 +127,6 @@ The timeout for the TCP idle connection. The value can be set between 4 and 30 m - Required: No - Type: int - Default: `4` -- MinValue: 0 -- MaxValue: 65534 ### Parameter: `protocol` @@ -157,8 +143,6 @@ The transport protocol for the endpoint. 'Udp' ] ``` -- MinValue: 0 -- MaxValue: 65534 ### Parameter: `frontendPortRangeEnd` diff --git a/avm/res/network/network-manager/README.md b/avm/res/network/network-manager/README.md index 1a82404612..be39206d24 100644 --- a/avm/res/network/network-manager/README.md +++ b/avm/res/network/network-manager/README.md @@ -2162,8 +2162,6 @@ Network protocol this rule applies to. 'Udp' ] ``` -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `securityAdminConfigurations.ruleCollections.rules.description` @@ -2171,8 +2169,6 @@ A description of the rule. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `securityAdminConfigurations.ruleCollections.rules.destinationPortRanges` @@ -2180,8 +2176,6 @@ List of destination port ranges. This specifies on which ports traffic will be a - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `securityAdminConfigurations.ruleCollections.rules.destinations` @@ -2189,8 +2183,6 @@ The destnations filter can be an IP Address or a service tag. Each filter contai - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 **Required parameters** @@ -2205,8 +2197,6 @@ Address prefix. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `securityAdminConfigurations.ruleCollections.rules.destinations.addressPrefixType` @@ -2221,8 +2211,6 @@ Address prefix type. 'ServiceTag' ] ``` -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `securityAdminConfigurations.ruleCollections.rules.sourcePortRanges` @@ -2230,8 +2218,6 @@ List of destination port ranges. This specifies on which ports traffic will be a - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `securityAdminConfigurations.ruleCollections.rules.sources` @@ -2239,8 +2225,6 @@ The source filter can be an IP Address or a service tag. Each filter contains th - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 **Required parameters** @@ -2255,8 +2239,6 @@ Address prefix. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `securityAdminConfigurations.ruleCollections.rules.sources.addressPrefixType` @@ -2271,8 +2253,6 @@ Address prefix type. 'ServiceTag' ] ``` -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `tags` diff --git a/avm/res/network/network-manager/security-admin-configuration/README.md b/avm/res/network/network-manager/security-admin-configuration/README.md index 2706a67429..d1a569b85f 100644 --- a/avm/res/network/network-manager/security-admin-configuration/README.md +++ b/avm/res/network/network-manager/security-admin-configuration/README.md @@ -236,8 +236,6 @@ Network protocol this rule applies to. 'Udp' ] ``` -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `ruleCollections.rules.description` @@ -245,8 +243,6 @@ A description of the rule. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `ruleCollections.rules.destinationPortRanges` @@ -254,8 +250,6 @@ List of destination port ranges. This specifies on which ports traffic will be a - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `ruleCollections.rules.destinations` @@ -263,8 +257,6 @@ The destnations filter can be an IP Address or a service tag. Each filter contai - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 **Required parameters** @@ -279,8 +271,6 @@ Address prefix. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `ruleCollections.rules.destinations.addressPrefixType` @@ -295,8 +285,6 @@ Address prefix type. 'ServiceTag' ] ``` -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `ruleCollections.rules.sourcePortRanges` @@ -304,8 +292,6 @@ List of destination port ranges. This specifies on which ports traffic will be a - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `ruleCollections.rules.sources` @@ -313,8 +299,6 @@ The source filter can be an IP Address or a service tag. Each filter contains th - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 **Required parameters** @@ -329,8 +313,6 @@ Address prefix. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `ruleCollections.rules.sources.addressPrefixType` @@ -345,8 +327,6 @@ Address prefix type. 'ServiceTag' ] ``` -- MinValue: 1 -- MaxValue: 4096 ## Outputs diff --git a/avm/res/network/network-manager/security-admin-configuration/rule-collection/README.md b/avm/res/network/network-manager/security-admin-configuration/rule-collection/README.md index 695ecbbf57..1f1516af04 100644 --- a/avm/res/network/network-manager/security-admin-configuration/rule-collection/README.md +++ b/avm/res/network/network-manager/security-admin-configuration/rule-collection/README.md @@ -177,8 +177,6 @@ Network protocol this rule applies to. 'Udp' ] ``` -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `rules.description` @@ -186,8 +184,6 @@ A description of the rule. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `rules.destinationPortRanges` @@ -195,8 +191,6 @@ List of destination port ranges. This specifies on which ports traffic will be a - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `rules.destinations` @@ -204,8 +198,6 @@ The destnations filter can be an IP Address or a service tag. Each filter contai - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 **Required parameters** @@ -220,8 +212,6 @@ Address prefix. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `rules.destinations.addressPrefixType` @@ -236,8 +226,6 @@ Address prefix type. 'ServiceTag' ] ``` -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `rules.sourcePortRanges` @@ -245,8 +233,6 @@ List of destination port ranges. This specifies on which ports traffic will be a - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `rules.sources` @@ -254,8 +240,6 @@ The source filter can be an IP Address or a service tag. Each filter contains th - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 **Required parameters** @@ -270,8 +254,6 @@ Address prefix. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `rules.sources.addressPrefixType` @@ -286,8 +268,6 @@ Address prefix type. 'ServiceTag' ] ``` -- MinValue: 1 -- MaxValue: 4096 ## Outputs diff --git a/avm/res/network/network-manager/security-admin-configuration/rule-collection/rule/README.md b/avm/res/network/network-manager/security-admin-configuration/rule-collection/rule/README.md index 280bf5c7dc..8abf9421c3 100644 --- a/avm/res/network/network-manager/security-admin-configuration/rule-collection/rule/README.md +++ b/avm/res/network/network-manager/security-admin-configuration/rule-collection/rule/README.md @@ -107,8 +107,6 @@ Network protocol this rule applies to. 'Udp' ] ``` -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `networkManagerName` @@ -116,8 +114,6 @@ The name of the parent network manager. Required if the template is used in a st - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `ruleCollectionName` @@ -125,8 +121,6 @@ The name of the parent rule collection. Required if the template is used in a st - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `securityAdminConfigurationName` @@ -134,8 +128,6 @@ The name of the parent security admin configuration. Required if the template is - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `description` @@ -144,8 +136,6 @@ A description of the rule. - Required: No - Type: string - Default: `''` -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `destinationPortRanges` @@ -153,8 +143,6 @@ List of destination port ranges. This specifies on which ports traffic will be a - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `destinations` @@ -162,8 +150,6 @@ The destnations filter can be an IP Address or a service tag. Each filter contai - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 **Required parameters** @@ -178,8 +164,6 @@ Address prefix. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `destinations.addressPrefixType` @@ -194,8 +178,6 @@ Address prefix type. 'ServiceTag' ] ``` -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `sourcePortRanges` @@ -203,8 +185,6 @@ List of destination port ranges. This specifies on which ports traffic will be a - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `sources` @@ -212,8 +192,6 @@ The source filter can be an IP Address or a service tag. Each filter contains th - Required: No - Type: array -- MinValue: 1 -- MaxValue: 4096 **Required parameters** @@ -228,8 +206,6 @@ Address prefix. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 4096 ### Parameter: `sources.addressPrefixType` @@ -244,8 +220,6 @@ Address prefix type. 'ServiceTag' ] ``` -- MinValue: 1 -- MaxValue: 4096 ## Outputs diff --git a/avm/res/network/network-security-group/README.md b/avm/res/network/network-security-group/README.md index cf086b177c..fd66a6fc5d 100644 --- a/avm/res/network/network-security-group/README.md +++ b/avm/res/network/network-security-group/README.md @@ -1095,8 +1095,6 @@ Network protocol this rule applies to. 'Udp' ] ``` -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.description` @@ -1104,8 +1102,6 @@ The description of the security rule. - Required: No - Type: string -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.destinationAddressPrefix` @@ -1113,8 +1109,6 @@ Optional. The destination address prefix. CIDR or destination IP range. Asterisk - Required: No - Type: string -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.destinationAddressPrefixes` @@ -1122,8 +1116,6 @@ The destination address prefixes. CIDR or destination IP ranges. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.destinationApplicationSecurityGroupResourceIds` @@ -1131,8 +1123,6 @@ The resource IDs of the application security groups specified as destination. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.destinationPortRange` @@ -1140,8 +1130,6 @@ The destination port or range. Integer or range between 0 and 65535. Asterisk "* - Required: No - Type: string -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.destinationPortRanges` @@ -1149,8 +1137,6 @@ The destination port ranges. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.sourceAddressPrefix` @@ -1158,8 +1144,6 @@ The CIDR or source IP range. Asterisk "*" can also be used to match all source I - Required: No - Type: string -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.sourceAddressPrefixes` @@ -1167,8 +1151,6 @@ The CIDR or source IP ranges. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.sourceApplicationSecurityGroupResourceIds` @@ -1176,8 +1158,6 @@ The resource IDs of the application security groups specified as source. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.sourcePortRange` @@ -1185,8 +1165,6 @@ The source port or range. Integer or range between 0 and 65535. Asterisk "*" can - Required: No - Type: string -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `securityRules.properties.sourcePortRanges` @@ -1194,8 +1172,6 @@ The source port ranges. - Required: No - Type: array -- MinValue: 100 -- MaxValue: 4096 ### Parameter: `tags` diff --git a/avm/res/network/network-watcher/flow-log/README.md b/avm/res/network/network-watcher/flow-log/README.md index 47bb0ca86d..9878b6c3c2 100644 --- a/avm/res/network/network-watcher/flow-log/README.md +++ b/avm/res/network/network-watcher/flow-log/README.md @@ -115,8 +115,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 365 ### Parameter: `trafficAnalyticsInterval` @@ -132,8 +130,6 @@ The interval in minutes which would decide how frequently TA service should do f 60 ] ``` -- MinValue: 0 -- MaxValue: 365 ### Parameter: `workspaceResourceId` @@ -142,8 +138,6 @@ Specify the Log Analytics Workspace Resource ID. - Required: No - Type: string - Default: `''` -- MinValue: 0 -- MaxValue: 365 ## Outputs diff --git a/avm/res/network/public-ip-prefix/README.md b/avm/res/network/public-ip-prefix/README.md index 91fb9f6841..06c70de650 100644 --- a/avm/res/network/public-ip-prefix/README.md +++ b/avm/res/network/public-ip-prefix/README.md @@ -501,8 +501,6 @@ The custom IP address prefix that this prefix is associated with. A custom IP ad - Required: No - Type: object - Default: `{}` -- MinValue: 21 -- MaxValue: 127 ### Parameter: `enableTelemetry` @@ -511,8 +509,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 21 -- MaxValue: 127 ### Parameter: `ipTags` @@ -520,8 +516,6 @@ The list of tags associated with the public IP prefix. - Required: No - Type: array -- MinValue: 21 -- MaxValue: 127 **Required parameters** @@ -536,8 +530,6 @@ The IP tag type. - Required: Yes - Type: string -- MinValue: 21 -- MaxValue: 127 ### Parameter: `ipTags.tag` @@ -545,8 +537,6 @@ The IP tag. - Required: Yes - Type: string -- MinValue: 21 -- MaxValue: 127 ### Parameter: `location` @@ -555,8 +545,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 21 -- MaxValue: 127 ### Parameter: `lock` @@ -564,8 +552,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 21 -- MaxValue: 127 **Optional parameters** @@ -588,8 +574,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 21 -- MaxValue: 127 ### Parameter: `lock.name` @@ -597,8 +581,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 21 -- MaxValue: 127 ### Parameter: `publicIPAddressVersion` @@ -614,8 +596,6 @@ The public IP address version. 'IPv6' ] ``` -- MinValue: 21 -- MaxValue: 127 ### Parameter: `roleAssignments` @@ -623,8 +603,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 21 -- MaxValue: 127 - Roles configurable by name: - `'Contributor'` - `'Network Contributor'` @@ -657,8 +635,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 21 -- MaxValue: 127 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -666,8 +642,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 21 -- MaxValue: 127 ### Parameter: `roleAssignments.condition` @@ -675,8 +649,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 21 -- MaxValue: 127 ### Parameter: `roleAssignments.conditionVersion` @@ -690,8 +662,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 21 -- MaxValue: 127 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -699,8 +669,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 21 -- MaxValue: 127 ### Parameter: `roleAssignments.description` @@ -708,8 +676,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 21 -- MaxValue: 127 ### Parameter: `roleAssignments.name` @@ -717,8 +683,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 21 -- MaxValue: 127 ### Parameter: `roleAssignments.principalType` @@ -736,8 +700,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 21 -- MaxValue: 127 ### Parameter: `tags` @@ -745,8 +707,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 21 -- MaxValue: 127 ### Parameter: `tier` @@ -762,8 +722,6 @@ Tier of a public IP prefix SKU. If set to `Global`, the `zones` property must be 'Regional' ] ``` -- MinValue: 21 -- MaxValue: 127 ### Parameter: `zones` @@ -787,8 +745,6 @@ A list of availability zones denoting the IP allocated for the resource needs to 3 ] ``` -- MinValue: 21 -- MaxValue: 127 ## Outputs diff --git a/avm/res/network/virtual-network-gateway/README.md b/avm/res/network/virtual-network-gateway/README.md index c373dd5d2c..fa43639ad4 100644 --- a/avm/res/network/virtual-network-gateway/README.md +++ b/avm/res/network/virtual-network-gateway/README.md @@ -2492,8 +2492,6 @@ The list of custom BGP IP Address (APIPA) peering addresses which belong to IP c - Required: No - Type: array -- MinValue: 0 -- MaxValue: 4294967295 ### Parameter: `clusterSettings.clusterMode-activeActiveBgp.existingSecondPipResourceId` @@ -2501,8 +2499,6 @@ The secondary Public IP resource ID to associate to the Virtual Network Gateway - Required: No - Type: string -- MinValue: 0 -- MaxValue: 4294967295 ### Parameter: `clusterSettings.clusterMode-activeActiveBgp.secondCustomBgpIpAddresses` @@ -2510,8 +2506,6 @@ The list of the second custom BGP IP Address (APIPA) peering addresses which bel - Required: No - Type: array -- MinValue: 0 -- MaxValue: 4294967295 ### Parameter: `clusterSettings.clusterMode-activeActiveBgp.secondPipName` @@ -2519,8 +2513,6 @@ Specifies the name of the secondary Public IP to be created for the Virtual Netw - Required: No - Type: string -- MinValue: 0 -- MaxValue: 4294967295 ### Variant: `clusterSettings.clusterMode-activePassiveBgp` The type for an active-passive BGP configuration. @@ -2568,8 +2560,6 @@ The list of custom BGP IP Address (APIPA) peering addresses which belong to IP c - Required: No - Type: array -- MinValue: 0 -- MaxValue: 4294967295 ### Variant: `clusterSettings.clusterMode-activePassiveNoBgp` The type for an active-passive no BGP configuration. diff --git a/avm/res/network/virtual-network/README.md b/avm/res/network/virtual-network/README.md index 8554fbed10..93b9498d50 100644 --- a/avm/res/network/virtual-network/README.md +++ b/avm/res/network/virtual-network/README.md @@ -1341,7 +1341,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MaxValue: 30 ### Parameter: `lock` @@ -1349,7 +1348,6 @@ The lock settings of the service. - Required: No - Type: object -- MaxValue: 30 **Optional parameters** @@ -1372,7 +1370,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MaxValue: 30 ### Parameter: `lock.name` @@ -1380,7 +1377,6 @@ Specify the name of lock. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `peerings` @@ -1388,7 +1384,6 @@ Virtual Network Peering configurations. - Required: No - Type: array -- MaxValue: 30 **Required parameters** @@ -1420,7 +1415,6 @@ The Resource ID of the VNet that is this Local VNet is being peered to. Should b - Required: Yes - Type: string -- MaxValue: 30 ### Parameter: `peerings.allowForwardedTraffic` @@ -1428,7 +1422,6 @@ Whether the forwarded traffic from the VMs in the local virtual network will be - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `peerings.allowGatewayTransit` @@ -1436,7 +1429,6 @@ If gateway links can be used in remote virtual networking to link to this virtua - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `peerings.allowVirtualNetworkAccess` @@ -1444,7 +1436,6 @@ Whether the VMs in the local virtual network space would be able to access the V - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `peerings.doNotVerifyRemoteGateways` @@ -1452,7 +1443,6 @@ Do not verify the provisioning state of the remote gateway. Default is true. - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `peerings.name` @@ -1460,7 +1450,6 @@ The Name of VNET Peering resource. If not provided, default value will be peer-l - Required: No - Type: string -- MaxValue: 30 ### Parameter: `peerings.remotePeeringAllowForwardedTraffic` @@ -1468,7 +1457,6 @@ Whether the forwarded traffic from the VMs in the local virtual network will be - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `peerings.remotePeeringAllowGatewayTransit` @@ -1476,7 +1464,6 @@ If gateway links can be used in remote virtual networking to link to this virtua - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `peerings.remotePeeringAllowVirtualNetworkAccess` @@ -1484,7 +1471,6 @@ Whether the VMs in the local virtual network space would be able to access the V - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `peerings.remotePeeringDoNotVerifyRemoteGateways` @@ -1492,7 +1478,6 @@ Do not verify the provisioning state of the remote gateway. Default is true. - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `peerings.remotePeeringEnabled` @@ -1500,7 +1485,6 @@ Deploy the outbound and the inbound peering. - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `peerings.remotePeeringName` @@ -1508,7 +1492,6 @@ The name of the VNET Peering resource in the remove Virtual Network. If not prov - Required: No - Type: string -- MaxValue: 30 ### Parameter: `peerings.remotePeeringUseRemoteGateways` @@ -1516,7 +1499,6 @@ If remote gateways can be used on this virtual network. If the flag is set to tr - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `peerings.useRemoteGateways` @@ -1524,7 +1506,6 @@ If remote gateways can be used on this virtual network. If the flag is set to tr - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `roleAssignments` @@ -1532,7 +1513,6 @@ Array of role assignments to create. - Required: No - Type: array -- MaxValue: 30 - Roles configurable by name: - `'Contributor'` - `'Network Contributor'` @@ -1565,7 +1545,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MaxValue: 30 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -1573,7 +1552,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MaxValue: 30 ### Parameter: `roleAssignments.condition` @@ -1581,7 +1559,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MaxValue: 30 ### Parameter: `roleAssignments.conditionVersion` @@ -1595,7 +1572,6 @@ Version of the condition. '2.0' ] ``` -- MaxValue: 30 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -1603,7 +1579,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `roleAssignments.description` @@ -1611,7 +1586,6 @@ The description of the role assignment. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `roleAssignments.name` @@ -1619,7 +1593,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MaxValue: 30 ### Parameter: `roleAssignments.principalType` @@ -1637,7 +1610,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MaxValue: 30 ### Parameter: `subnets` @@ -1645,7 +1617,6 @@ An Array of subnets to deploy to the Virtual Network. - Required: No - Type: array -- MaxValue: 30 **Required parameters** @@ -1683,7 +1654,6 @@ The Name of the subnet resource. - Required: Yes - Type: string -- MaxValue: 30 ### Parameter: `subnets.addressPrefix` @@ -1691,7 +1661,6 @@ The address prefix for the subnet. Required if `addressPrefixes` is empty. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `subnets.addressPrefixes` @@ -1699,7 +1668,6 @@ List of address prefixes for the subnet. Required if `addressPrefix` is empty. - Required: No - Type: array -- MaxValue: 30 ### Parameter: `subnets.applicationGatewayIPConfigurations` @@ -1707,7 +1675,6 @@ Application gateway IP configurations of virtual network resource. - Required: No - Type: array -- MaxValue: 30 ### Parameter: `subnets.defaultOutboundAccess` @@ -1715,7 +1682,6 @@ Set this property to false to disable default outbound connectivity for all VMs - Required: No - Type: bool -- MaxValue: 30 ### Parameter: `subnets.delegation` @@ -1723,7 +1689,6 @@ The delegation to enable on the subnet. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `subnets.natGatewayResourceId` @@ -1731,7 +1696,6 @@ The resource ID of the NAT Gateway to use for the subnet. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `subnets.networkSecurityGroupResourceId` @@ -1739,7 +1703,6 @@ The resource ID of the network security group to assign to the subnet. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `subnets.privateEndpointNetworkPolicies` @@ -1756,7 +1719,6 @@ enable or disable apply network policies on private endpoint in the subnet. 'RouteTableEnabled' ] ``` -- MaxValue: 30 ### Parameter: `subnets.privateLinkServiceNetworkPolicies` @@ -1771,7 +1733,6 @@ enable or disable apply network policies on private link service in the subnet. 'Enabled' ] ``` -- MaxValue: 30 ### Parameter: `subnets.roleAssignments` @@ -1779,7 +1740,6 @@ Array of role assignments to create. - Required: No - Type: array -- MaxValue: 30 - Roles configurable by name: - `'Contributor'` - `'Network Contributor'` @@ -1812,7 +1772,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MaxValue: 30 ### Parameter: `subnets.roleAssignments.roleDefinitionIdOrName` @@ -1820,7 +1779,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MaxValue: 30 ### Parameter: `subnets.roleAssignments.condition` @@ -1828,7 +1786,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MaxValue: 30 ### Parameter: `subnets.roleAssignments.conditionVersion` @@ -1842,7 +1799,6 @@ Version of the condition. '2.0' ] ``` -- MaxValue: 30 ### Parameter: `subnets.roleAssignments.delegatedManagedIdentityResourceId` @@ -1850,7 +1806,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `subnets.roleAssignments.description` @@ -1858,7 +1813,6 @@ The description of the role assignment. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `subnets.roleAssignments.name` @@ -1866,7 +1820,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MaxValue: 30 ### Parameter: `subnets.roleAssignments.principalType` @@ -1884,7 +1837,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MaxValue: 30 ### Parameter: `subnets.routeTableResourceId` @@ -1892,7 +1844,6 @@ The resource ID of the route table to assign to the subnet. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `subnets.serviceEndpointPolicies` @@ -1900,7 +1851,6 @@ An array of service endpoint policies. - Required: No - Type: array -- MaxValue: 30 ### Parameter: `subnets.serviceEndpoints` @@ -1908,7 +1858,6 @@ The service endpoints to enable on the subnet. - Required: No - Type: array -- MaxValue: 30 ### Parameter: `subnets.sharingScope` @@ -1923,7 +1872,6 @@ Set this property to Tenant to allow sharing subnet with other subscriptions in 'Tenant' ] ``` -- MaxValue: 30 ### Parameter: `tags` @@ -1931,7 +1879,6 @@ Tags of the resource. - Required: No - Type: object -- MaxValue: 30 ### Parameter: `virtualNetworkBgpCommunity` @@ -1939,7 +1886,6 @@ The BGP community associated with the virtual network. - Required: No - Type: string -- MaxValue: 30 ### Parameter: `vnetEncryption` @@ -1948,7 +1894,6 @@ Indicates if encryption is enabled on virtual network and if VM without encrypti - Required: No - Type: bool - Default: `False` -- MaxValue: 30 ### Parameter: `vnetEncryptionEnforcement` @@ -1964,7 +1909,6 @@ If the encrypted VNet allows VM that does not support encryption. Can only be us 'DropUnencrypted' ] ``` -- MaxValue: 30 ## Outputs diff --git a/avm/res/operational-insights/workspace/table/README.md b/avm/res/operational-insights/workspace/table/README.md index 32a0f782c8..31cf3685b3 100644 --- a/avm/res/operational-insights/workspace/table/README.md +++ b/avm/res/operational-insights/workspace/table/README.md @@ -123,8 +123,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: -1 -- MaxValue: 730 - Roles configurable by name: - `'Contributor'` - `'Log Analytics Contributor'` @@ -160,8 +158,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -169,8 +165,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `roleAssignments.condition` @@ -178,8 +172,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `roleAssignments.conditionVersion` @@ -193,8 +185,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: -1 -- MaxValue: 730 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -202,8 +192,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `roleAssignments.description` @@ -211,8 +199,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `roleAssignments.name` @@ -220,8 +206,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `roleAssignments.principalType` @@ -239,8 +223,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: -1 -- MaxValue: 730 ### Parameter: `schema` @@ -248,8 +230,6 @@ Table's schema. - Required: No - Type: object -- MinValue: -1 -- MaxValue: 730 **Required parameters** @@ -271,8 +251,6 @@ A list of table custom columns. - Required: Yes - Type: array -- MinValue: -1 -- MaxValue: 730 **Required parameters** @@ -295,8 +273,6 @@ The column name. - Required: Yes - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `schema.columns.type` @@ -317,8 +293,6 @@ The column type. 'string' ] ``` -- MinValue: -1 -- MaxValue: 730 ### Parameter: `schema.columns.dataTypeHint` @@ -335,8 +309,6 @@ The column data type logical hint. 'uri' ] ``` -- MinValue: -1 -- MaxValue: 730 ### Parameter: `schema.columns.description` @@ -344,8 +316,6 @@ The column description. - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `schema.columns.displayName` @@ -353,8 +323,6 @@ Column display name. - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `schema.name` @@ -362,8 +330,6 @@ The table name. - Required: Yes - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `schema.description` @@ -371,8 +337,6 @@ The table description. - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `schema.displayName` @@ -380,8 +344,6 @@ The table display name. - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `searchResults` @@ -389,8 +351,6 @@ Parameters of the search job that initiated this table. - Required: No - Type: object -- MinValue: -1 -- MaxValue: 730 **Required parameters** @@ -413,8 +373,6 @@ The search job query. - Required: Yes - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `searchResults.description` @@ -422,8 +380,6 @@ The search description. - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `searchResults.endSearchTime` @@ -431,8 +387,6 @@ The timestamp to end the search by (UTC). - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `searchResults.limit` @@ -440,8 +394,6 @@ Limit the search job to return up to specified number of rows. - Required: No - Type: int -- MinValue: -1 -- MaxValue: 730 ### Parameter: `searchResults.startSearchTime` @@ -449,8 +401,6 @@ The timestamp to start the search from (UTC). - Required: No - Type: string -- MinValue: -1 -- MaxValue: 730 ### Parameter: `totalRetentionInDays` diff --git a/avm/res/search/search-service/README.md b/avm/res/search/search-service/README.md index 152d7bd1b0..6c8c2fec06 100644 --- a/avm/res/search/search-service/README.md +++ b/avm/res/search/search-service/README.md @@ -1372,8 +1372,6 @@ Configuration details for private endpoints. For security reasons, it is recomme - Required: No - Type: array -- MinValue: 1 -- MaxValue: 12 **Required parameters** @@ -1408,8 +1406,6 @@ Resource ID of the subnet where the endpoint needs to be created. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.applicationSecurityGroupResourceIds` @@ -1417,8 +1413,6 @@ Application security groups in which the Private Endpoint IP configuration is in - Required: No - Type: array -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.customDnsConfigs` @@ -1426,8 +1420,6 @@ Custom DNS configurations. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 12 **Required parameters** @@ -1447,8 +1439,6 @@ A list of private IP addresses of the private endpoint. - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.customDnsConfigs.fqdn` @@ -1456,8 +1446,6 @@ FQDN that resolves to private endpoint IP address. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.customNetworkInterfaceName` @@ -1465,8 +1453,6 @@ The custom name of the network interface attached to the Private Endpoint. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.enableTelemetry` @@ -1474,8 +1460,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.ipConfigurations` @@ -1483,8 +1467,6 @@ A list of IP configurations of the Private Endpoint. This will be used to map to - Required: No - Type: array -- MinValue: 1 -- MaxValue: 12 **Required parameters** @@ -1499,8 +1481,6 @@ The name of the resource that is unique within a resource group. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.ipConfigurations.properties` @@ -1508,8 +1488,6 @@ Properties of private endpoint IP configurations. - Required: Yes - Type: object -- MinValue: 1 -- MaxValue: 12 **Required parameters** @@ -1525,8 +1503,6 @@ The ID of a group obtained from the remote resource that this private endpoint s - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.ipConfigurations.properties.memberName` @@ -1534,8 +1510,6 @@ The member name of a group obtained from the remote resource that this private e - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.ipConfigurations.properties.privateIPAddress` @@ -1543,8 +1517,6 @@ A private IP address obtained from the private endpoint's subnet. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.isManualConnection` @@ -1552,8 +1524,6 @@ If Manual Private Link Connection is required. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.location` @@ -1561,8 +1531,6 @@ The location to deploy the Private Endpoint to. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.lock` @@ -1570,8 +1538,6 @@ Specify the type of lock. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 12 **Optional parameters** @@ -1594,8 +1560,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.lock.name` @@ -1603,8 +1567,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.manualConnectionRequestMessage` @@ -1612,8 +1574,6 @@ A message passed to the owner of the remote resource with the manual connection - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.name` @@ -1621,8 +1581,6 @@ The name of the Private Endpoint. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.privateDnsZoneGroup` @@ -1630,8 +1588,6 @@ The private DNS Zone Group to configure for the Private Endpoint. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 12 **Required parameters** @@ -1651,8 +1607,6 @@ The private DNS Zone Groups to associate the Private Endpoint. A DNS Zone Group - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 12 **Required parameters** @@ -1672,8 +1626,6 @@ The resource id of the private DNS zone. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.privateDnsZoneGroup.privateDnsZoneGroupConfigs.name` @@ -1681,8 +1633,6 @@ The name of the private DNS Zone Group config. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.privateDnsZoneGroup.name` @@ -1690,8 +1640,6 @@ The name of the Private DNS Zone Group. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.privateLinkServiceConnectionName` @@ -1699,8 +1647,6 @@ The name of the private link connection to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.resourceGroupName` @@ -1708,8 +1654,6 @@ Specify if you want to deploy the Private Endpoint into a different Resource Gro - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.roleAssignments` @@ -1717,8 +1661,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 12 - Roles configurable by name: - `'Contributor'` - `'DNS Resolver Contributor'` @@ -1755,8 +1697,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.roleAssignments.roleDefinitionIdOrName` @@ -1764,8 +1704,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.roleAssignments.condition` @@ -1773,8 +1711,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.roleAssignments.conditionVersion` @@ -1788,8 +1724,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.roleAssignments.delegatedManagedIdentityResourceId` @@ -1797,8 +1731,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.roleAssignments.description` @@ -1806,8 +1738,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.roleAssignments.name` @@ -1815,8 +1745,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.roleAssignments.principalType` @@ -1834,8 +1762,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.service` @@ -1843,8 +1769,6 @@ The subresource to deploy the Private Endpoint for. For example "vault" for a Ke - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `privateEndpoints.tags` @@ -1852,8 +1776,6 @@ Tags to be applied on all resources/Resource Groups in this deployment. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 12 ### Parameter: `publicNetworkAccess` @@ -1869,8 +1791,6 @@ This value can be set to 'Enabled' to avoid breaking changes on existing custome 'Enabled' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `replicaCount` @@ -1888,8 +1808,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 12 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -1924,8 +1842,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -1933,8 +1849,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `roleAssignments.condition` @@ -1942,8 +1856,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `roleAssignments.conditionVersion` @@ -1957,8 +1869,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -1966,8 +1876,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `roleAssignments.description` @@ -1975,8 +1883,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `roleAssignments.name` @@ -1984,8 +1890,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `roleAssignments.principalType` @@ -2003,8 +1907,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `secretsExportConfiguration` @@ -2012,8 +1914,6 @@ Key vault reference and secret settings for the module's secrets export. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 12 **Required parameters** @@ -2034,8 +1934,6 @@ The key vault name where to store the API Admin keys generated by the modules. - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `secretsExportConfiguration.primaryAdminKeyName` @@ -2043,8 +1941,6 @@ The primaryAdminKey secret name to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `secretsExportConfiguration.secondaryAdminKeyName` @@ -2052,8 +1948,6 @@ The secondaryAdminKey secret name to create. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 12 ### Parameter: `semanticSearch` @@ -2069,8 +1963,6 @@ Sets options that control the availability of semantic search. This configuratio 'standard' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `sharedPrivateLinkResources` @@ -2079,8 +1971,6 @@ The sharedPrivateLinkResources to create as part of the search Service. - Required: No - Type: array - Default: `[]` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `sku` @@ -2101,8 +1991,6 @@ Defines the SKU of an Azure Cognitive Search Service, which determines price tie 'storage_optimized_l2' ] ``` -- MinValue: 1 -- MaxValue: 12 ### Parameter: `tags` @@ -2110,8 +1998,6 @@ Tags to help categorize the resource in the Azure portal. - Required: No - Type: object -- MinValue: 1 -- MaxValue: 12 ## Outputs diff --git a/avm/res/storage/storage-account/blob-service/README.md b/avm/res/storage/storage-account/blob-service/README.md index 831df721ec..ec23310a3f 100644 --- a/avm/res/storage/storage-account/blob-service/README.md +++ b/avm/res/storage/storage-account/blob-service/README.md @@ -88,8 +88,6 @@ This property when set to true allows deletion of the soft deleted blob versions - Required: No - Type: bool - Default: `False` -- MinValue: 1 -- MaxValue: 146000 ### Parameter: `containerDeleteRetentionPolicyDays` @@ -107,8 +105,6 @@ The blob service properties for container soft delete. Indicates whether DeleteR - Required: No - Type: bool - Default: `True` -- MinValue: 1 -- MaxValue: 365 ### Parameter: `containers` @@ -116,8 +112,6 @@ Blob containers to create. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 365 ### Parameter: `corsRules` @@ -125,8 +119,6 @@ The List of CORS rules. You can include up to five CorsRule elements in the requ - Required: No - Type: array -- MinValue: 1 -- MaxValue: 365 **Required parameters** @@ -144,8 +136,6 @@ A list of headers allowed to be part of the cross-origin request. - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 365 ### Parameter: `corsRules.allowedMethods` @@ -168,8 +158,6 @@ A list of HTTP methods that are allowed to be executed by the origin. 'TRACE' ] ``` -- MinValue: 1 -- MaxValue: 365 ### Parameter: `corsRules.allowedOrigins` @@ -177,8 +165,6 @@ A list of origin domains that will be allowed via CORS, or "*" to allow all doma - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 365 ### Parameter: `corsRules.exposedHeaders` @@ -186,8 +172,6 @@ A list of response headers to expose to CORS clients. - Required: Yes - Type: array -- MinValue: 1 -- MaxValue: 365 ### Parameter: `corsRules.maxAgeInSeconds` @@ -195,8 +179,6 @@ The number of seconds that the client/browser should cache a preflight response. - Required: Yes - Type: int -- MinValue: 1 -- MaxValue: 365 ### Parameter: `defaultServiceVersion` @@ -205,8 +187,6 @@ Indicates the default version to use for requests to the Blob service if an inco - Required: No - Type: string - Default: `''` -- MinValue: 1 -- MaxValue: 365 ### Parameter: `deleteRetentionPolicyAllowPermanentDelete` @@ -215,8 +195,6 @@ This property when set to true allows deletion of the soft deleted blob versions - Required: No - Type: bool - Default: `False` -- MinValue: 1 -- MaxValue: 365 ### Parameter: `deleteRetentionPolicyDays` @@ -235,8 +213,6 @@ The blob service properties for blob soft delete. - Required: No - Type: bool - Default: `True` -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings` @@ -244,8 +220,6 @@ The diagnostic settings of the service. - Required: No - Type: array -- MinValue: 1 -- MaxValue: 365 **Optional parameters** @@ -267,8 +241,6 @@ Resource ID of the diagnostic event hub authorization rule for the Event Hubs na - Required: No - Type: string -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.eventHubName` @@ -276,8 +248,6 @@ Name of the diagnostic event hub within the namespace to which logs are streamed - Required: No - Type: string -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.logAnalyticsDestinationType` @@ -292,8 +262,6 @@ A string indicating whether the export to Log Analytics should use the default d 'Dedicated' ] ``` -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.logCategoriesAndGroups` @@ -301,8 +269,6 @@ The name of logs that will be streamed. "allLogs" includes all possible logs for - Required: No - Type: array -- MinValue: 1 -- MaxValue: 365 **Optional parameters** @@ -318,8 +284,6 @@ Name of a Diagnostic Log category for a resource type this setting is applied to - Required: No - Type: string -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.categoryGroup` @@ -327,8 +291,6 @@ Name of a Diagnostic Log category group for a resource type this setting is appl - Required: No - Type: string -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.logCategoriesAndGroups.enabled` @@ -336,8 +298,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.marketplacePartnerResourceId` @@ -345,8 +305,6 @@ The full ARM resource ID of the Marketplace resource to which you would like to - Required: No - Type: string -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.metricCategories` @@ -354,8 +312,6 @@ The name of metrics that will be streamed. "allMetrics" includes all possible me - Required: No - Type: array -- MinValue: 1 -- MaxValue: 365 **Required parameters** @@ -375,8 +331,6 @@ Name of a Diagnostic Metric category for a resource type this setting is applied - Required: Yes - Type: string -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.metricCategories.enabled` @@ -384,8 +338,6 @@ Enable or disable the category explicitly. Default is `true`. - Required: No - Type: bool -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.name` @@ -393,8 +345,6 @@ The name of the diagnostic setting. - Required: No - Type: string -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.storageAccountResourceId` @@ -402,8 +352,6 @@ Resource ID of the diagnostic storage account. For security reasons, it is recom - Required: No - Type: string -- MinValue: 1 -- MaxValue: 365 ### Parameter: `diagnosticSettings.workspaceResourceId` @@ -411,8 +359,6 @@ Resource ID of the diagnostic log analytics workspace. For security reasons, it - Required: No - Type: string -- MinValue: 1 -- MaxValue: 365 ### Parameter: `isVersioningEnabled` @@ -421,8 +367,6 @@ Use versioning to automatically maintain previous versions of your blobs. - Required: No - Type: bool - Default: `False` -- MinValue: 1 -- MaxValue: 365 ### Parameter: `lastAccessTimeTrackingPolicyEnabled` @@ -431,8 +375,6 @@ The blob service property to configure last access time based tracking policy. W - Required: No - Type: bool - Default: `False` -- MinValue: 1 -- MaxValue: 365 ### Parameter: `restorePolicyDays` @@ -442,7 +384,6 @@ How long this blob can be restored. It should be less than DeleteRetentionPolicy - Type: int - Default: `7` - MinValue: 1 -- MaxValue: 365 ### Parameter: `restorePolicyEnabled` @@ -451,8 +392,6 @@ The blob service properties for blob restore policy. If point-in-time restore is - Required: No - Type: bool - Default: `False` -- MinValue: 1 -- MaxValue: 365 ## Outputs diff --git a/avm/res/virtual-machine-images/image-template/README.md b/avm/res/virtual-machine-images/image-template/README.md index f5b95e8709..c3e99f185a 100644 --- a/avm/res/virtual-machine-images/image-template/README.md +++ b/avm/res/virtual-machine-images/image-template/README.md @@ -1095,8 +1095,6 @@ Customization steps to be run when building the VM image. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 960 ### Parameter: `enableTelemetry` @@ -1105,8 +1103,6 @@ Enable/Disable usage telemetry for module. - Required: No - Type: bool - Default: `True` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `errorHandlingOnCustomizerError` @@ -1122,8 +1118,6 @@ If there is a customizer error and this field is set to 'cleanup', the build VM 'cleanup' ] ``` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `errorHandlingOnValidationError` @@ -1139,8 +1133,6 @@ If there is a validation error and this field is set to 'cleanup', the build VM 'cleanup' ] ``` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `location` @@ -1149,8 +1141,6 @@ Location for all resources. - Required: No - Type: string - Default: `[resourceGroup().location]` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `lock` @@ -1158,8 +1148,6 @@ The lock settings of the service. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 960 **Optional parameters** @@ -1182,8 +1170,6 @@ Specify the type of lock. 'ReadOnly' ] ``` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `lock.name` @@ -1191,8 +1177,6 @@ Specify the name of lock. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `managedResourceTags` @@ -1200,8 +1184,6 @@ Tags that will be applied to the resource group and/or resources created by the - Required: No - Type: object -- MinValue: 0 -- MaxValue: 960 ### Parameter: `optimizeVmBoot` @@ -1216,8 +1198,6 @@ The optimize property can be enabled while creating a VM image and allows VM opt 'Enabled' ] ``` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `osDiskSizeGB` @@ -1226,8 +1206,6 @@ Specifies the size of OS disk. - Required: No - Type: int - Default: `128` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `roleAssignments` @@ -1235,8 +1213,6 @@ Array of role assignments to create. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 960 - Roles configurable by name: - `'Contributor'` - `'Owner'` @@ -1268,8 +1244,6 @@ The principal ID of the principal (user/group/identity) to assign the role to. - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `roleAssignments.roleDefinitionIdOrName` @@ -1277,8 +1251,6 @@ The role to assign. You can provide either the display name of the role definiti - Required: Yes - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `roleAssignments.condition` @@ -1286,8 +1258,6 @@ The conditions on the role assignment. This limits the resources it can be assig - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `roleAssignments.conditionVersion` @@ -1301,8 +1271,6 @@ Version of the condition. '2.0' ] ``` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `roleAssignments.delegatedManagedIdentityResourceId` @@ -1310,8 +1278,6 @@ The Resource Id of the delegated managed identity resource. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `roleAssignments.description` @@ -1319,8 +1285,6 @@ The description of the role assignment. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `roleAssignments.name` @@ -1328,8 +1292,6 @@ The name (as GUID) of the role assignment. If not provided, a GUID will be gener - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `roleAssignments.principalType` @@ -1347,8 +1309,6 @@ The principal type of the assigned principal ID. 'User' ] ``` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `stagingResourceGroupResourceId` @@ -1356,8 +1316,6 @@ Resource ID of the staging resource group in the same subscription and location - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `subnetResourceId` @@ -1365,8 +1323,6 @@ Resource ID of an already existing subnet, e.g.: /subscriptions/ - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `tags` @@ -1374,8 +1330,6 @@ Tags of the resource. - Required: No - Type: object -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess` @@ -1383,8 +1337,6 @@ Configuration options and list of validations to be performed on the resulting i - Required: No - Type: object -- MinValue: 0 -- MaxValue: 960 **Optional parameters** @@ -1400,8 +1352,6 @@ If validation fails and this field is set to false, output image(s) will not be - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.inVMValidations` @@ -1409,8 +1359,6 @@ A list of validators that will be performed on the image. Azure Image Builder su - Required: No - Type: array -- MinValue: 0 -- MaxValue: 960 **Required parameters** @@ -1446,8 +1394,6 @@ The type of validation. 'Shell' ] ``` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.inVMValidations.destination` @@ -1455,8 +1401,6 @@ Destination of the file. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.inVMValidations.inline` @@ -1464,8 +1408,6 @@ Array of commands to be run, separated by commas. - Required: No - Type: array -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.inVMValidations.name` @@ -1473,8 +1415,6 @@ Friendly Name to provide context on what this validation step does. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.inVMValidations.runAsSystem` @@ -1482,8 +1422,6 @@ If specified, the PowerShell script will be run with elevated privileges using t - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.inVMValidations.runElevated` @@ -1491,8 +1429,6 @@ If specified, the PowerShell script will be run with elevated privileges. - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.inVMValidations.scriptUri` @@ -1500,8 +1436,6 @@ URI of the PowerShell script to be run for validation. It can be a github link, - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.inVMValidations.sha256Checksum` @@ -1509,8 +1443,6 @@ Value of sha256 checksum of the file, you generate this locally, and then Image - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.inVMValidations.sourceUri` @@ -1518,8 +1450,6 @@ The source URI of the file. - Required: No - Type: string -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.inVMValidations.validExitCodes` @@ -1527,8 +1457,6 @@ Valid codes that can be returned from the script/inline command, this avoids rep - Required: No - Type: array -- MinValue: 0 -- MaxValue: 960 ### Parameter: `validationProcess.sourceValidationOnly` @@ -1536,8 +1464,6 @@ If this field is set to true, the image specified in the 'source' section will d - Required: No - Type: bool -- MinValue: 0 -- MaxValue: 960 ### Parameter: `vmSize` @@ -1546,8 +1472,6 @@ Specifies the size for the VM. - Required: No - Type: string - Default: `'Standard_D2s_v3'` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `vmUserAssignedIdentities` @@ -1556,8 +1480,6 @@ List of User-Assigned Identities associated to the Build VM for accessing Azure - Required: No - Type: array - Default: `[]` -- MinValue: 0 -- MaxValue: 960 ### Parameter: `baseTime` @@ -1566,8 +1488,6 @@ Do not provide a value! This date is used to generate a unique image template na - Required: No - Type: string - Default: `[utcNow('yyyy-MM-dd-HH-mm-ss')]` -- MinValue: 0 -- MaxValue: 960 ## Outputs From 1a310ad17ded5f49067c3559ac2b4f955c43eb33 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Fri, 14 Mar 2025 20:55:39 +0100 Subject: [PATCH 39/43] Update utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> --- utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 857b1e45ae..63c674c31e 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -520,7 +520,7 @@ function Set-DefinitionSection { ((-not [String]::IsNullOrEmpty($formattedMaxValue)) ? $formattedMaxValue : $null), ((-not [String]::IsNullOrEmpty($formattedRoleNames)) ? $formattedRoleNames : $null), ((-not [String]::IsNullOrEmpty($formattedExample)) ? $formattedExample : $null), - (($definition.discriminator.propertyName) ? ('- Type-deciding property: {0}' -f $definition.discriminator.propertyName) : $null), + (($definition.discriminator.propertyName) ? ('- Type-deciding property: `{0}`' -f $definition.discriminator.propertyName) : $null), '' ) | Where-Object { $null -ne $_ } From 7930c8e253d0c89425a0dc467a45d7be8bb2c1e5 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Fri, 14 Mar 2025 20:59:57 +0100 Subject: [PATCH 40/43] Update to [discriminator] --- utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index 63c674c31e..ec6445d45c 100644 --- a/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -520,7 +520,7 @@ function Set-DefinitionSection { ((-not [String]::IsNullOrEmpty($formattedMaxValue)) ? $formattedMaxValue : $null), ((-not [String]::IsNullOrEmpty($formattedRoleNames)) ? $formattedRoleNames : $null), ((-not [String]::IsNullOrEmpty($formattedExample)) ? $formattedExample : $null), - (($definition.discriminator.propertyName) ? ('- Type-deciding property: `{0}`' -f $definition.discriminator.propertyName) : $null), + (($definition.discriminator.propertyName) ? ('- Discriminator: `{0}`' -f $definition.discriminator.propertyName) : $null), '' ) | Where-Object { $null -ne $_ } From 3ee82ff3399f4ceced63d3ddee76c649b0aa5d24 Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Fri, 14 Mar 2025 21:00:19 +0100 Subject: [PATCH 41/43] Update avm/res/insights/metric-alert/main.bicep Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> --- avm/res/insights/metric-alert/main.bicep | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/avm/res/insights/metric-alert/main.bicep b/avm/res/insights/metric-alert/main.bicep index 02f02ff8b8..ba15d94017 100644 --- a/avm/res/insights/metric-alert/main.bicep +++ b/avm/res/insights/metric-alert/main.bicep @@ -211,7 +211,7 @@ type alertWebtestType = { @description('Required. The type of the alert criteria.') 'odata.type': 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' - @description('Required. The Application Insights resource Id.') + @description('Required. The Application Insights resource ID.') componentResourceId: string @description('Required. The number of failed locations.') From ef91287a87b0bb86b895e35377a37f46626ced5b Mon Sep 17 00:00:00 2001 From: Alexander Sehr Date: Fri, 14 Mar 2025 21:00:29 +0100 Subject: [PATCH 42/43] Update avm/res/insights/metric-alert/main.bicep Co-authored-by: Erika Gressi <56914614+eriqua@users.noreply.github.com> --- avm/res/insights/metric-alert/main.bicep | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/avm/res/insights/metric-alert/main.bicep b/avm/res/insights/metric-alert/main.bicep index ba15d94017..f0a68c6447 100644 --- a/avm/res/insights/metric-alert/main.bicep +++ b/avm/res/insights/metric-alert/main.bicep @@ -217,6 +217,6 @@ type alertWebtestType = { @description('Required. The number of failed locations.') failedLocationCount: int - @description('Required. The Application Insights web test resource Id.') + @description('Required. The Application Insights web test resource ID.') webTestResourceId: string } From dc60f619bab8f850deb2cf0df4c414dd1cea2965 Mon Sep 17 00:00:00 2001 From: AlexanderSehr Date: Fri, 14 Mar 2025 22:01:19 +0100 Subject: [PATCH 43/43] Regenerated readmes --- avm/ptn/ai-platform/baseline/README.md | 2 +- .../pim-role-assignment/README.md | 6 +- .../dev-ops/cicd-agents-and-runners/README.md | 6 +- avm/ptn/lz/sub-vending/README.md | 4 +- avm/res/cache/redis-enterprise/README.md | 2 +- .../cache/redis-enterprise/database/README.md | 2 +- avm/res/dev-ops-infrastructure/pool/README.md | 6 +- .../digital-twins-instance/README.md | 396 ++++++++++++++++++ .../digital-twins-instance/endpoint/README.md | 396 ++++++++++++++++++ .../insights/data-collection-rule/README.md | 2 +- avm/res/insights/metric-alert/README.md | 10 +- .../workspace/README.md | 50 ++- .../workspace/connection/README.md | 48 ++- .../network/virtual-network-gateway/README.md | 2 +- .../image-template/README.md | 23 +- 15 files changed, 917 insertions(+), 38 deletions(-) diff --git a/avm/ptn/ai-platform/baseline/README.md b/avm/ptn/ai-platform/baseline/README.md index c24ef2a288..7b6838e468 100644 --- a/avm/ptn/ai-platform/baseline/README.md +++ b/avm/ptn/ai-platform/baseline/README.md @@ -1608,7 +1608,7 @@ The outbound rule. The name of the rule is the object key. - Required: Yes - Type: object -- Type-deciding property: type +- Discriminator: `type`

The available variants are:

diff --git a/avm/ptn/authorization/pim-role-assignment/README.md b/avm/ptn/authorization/pim-role-assignment/README.md index 38a5cc647f..3652980c6a 100644 --- a/avm/ptn/authorization/pim-role-assignment/README.md +++ b/avm/ptn/authorization/pim-role-assignment/README.md @@ -397,7 +397,7 @@ The type of the PIM role assignment whether its active or eligible. - Required: Yes - Type: object -- Type-deciding property: roleAssignmentType +- Discriminator: `roleAssignmentType`

The available variants are:

@@ -445,7 +445,7 @@ The schedule information for the role assignment. - Required: Yes - Type: object -- Type-deciding property: durationType +- Discriminator: `durationType`

The available variants are:

@@ -618,7 +618,7 @@ The schedule information for the role assignment. - Required: Yes - Type: object -- Type-deciding property: durationType +- Discriminator: `durationType`

The available variants are:

diff --git a/avm/ptn/dev-ops/cicd-agents-and-runners/README.md b/avm/ptn/dev-ops/cicd-agents-and-runners/README.md index e471c4b36e..cb52bdf6c1 100644 --- a/avm/ptn/dev-ops/cicd-agents-and-runners/README.md +++ b/avm/ptn/dev-ops/cicd-agents-and-runners/README.md @@ -1328,7 +1328,7 @@ The networking configuration. - Required: Yes - Type: object -- Type-deciding property: networkType +- Discriminator: `networkType`

The available variants are:

@@ -1514,7 +1514,7 @@ The compute type networking type. - Required: Yes - Type: object -- Type-deciding property: computeNetworkType +- Discriminator: `computeNetworkType`

The available variants are:

@@ -1670,7 +1670,7 @@ The self-hosted runner configuration. This can be either GitHub or Azure DevOps. - Required: Yes - Type: object -- Type-deciding property: selfHostedType +- Discriminator: `selfHostedType`

The available variants are:

diff --git a/avm/ptn/lz/sub-vending/README.md b/avm/ptn/lz/sub-vending/README.md index d0ede6dded..0e15681bfb 100644 --- a/avm/ptn/lz/sub-vending/README.md +++ b/avm/ptn/lz/sub-vending/README.md @@ -1841,7 +1841,7 @@ The schedule information for the role assignment. - Required: Yes - Type: object -- Type-deciding property: durationType +- Discriminator: `durationType`

The available variants are:

@@ -2191,7 +2191,7 @@ The type of template for the role assignment condition. - Required: No - Type: object -- Type-deciding property: templateName +- Discriminator: `templateName`

The available variants are:

diff --git a/avm/res/cache/redis-enterprise/README.md b/avm/res/cache/redis-enterprise/README.md index dcf077d75f..d1c4045b27 100644 --- a/avm/res/cache/redis-enterprise/README.md +++ b/avm/res/cache/redis-enterprise/README.md @@ -1729,7 +1729,7 @@ The persistence settings of the service. - Required: No - Type: object -- Type-deciding property: type +- Discriminator: `type`

The available variants are:

diff --git a/avm/res/cache/redis-enterprise/database/README.md b/avm/res/cache/redis-enterprise/database/README.md index 96964ad35e..a4d17bb805 100644 --- a/avm/res/cache/redis-enterprise/database/README.md +++ b/avm/res/cache/redis-enterprise/database/README.md @@ -401,7 +401,7 @@ The persistence settings of the service. type: 'disabled' } ``` -- Type-deciding property: type +- Discriminator: `type`

The available variants are:

diff --git a/avm/res/dev-ops-infrastructure/pool/README.md b/avm/res/dev-ops-infrastructure/pool/README.md index a0192ed3e7..90e2d99d94 100644 --- a/avm/res/dev-ops-infrastructure/pool/README.md +++ b/avm/res/dev-ops-infrastructure/pool/README.md @@ -722,7 +722,7 @@ Defines how the machine will be handled once it executed a job. - Required: Yes - Type: object -- Type-deciding property: kind +- Discriminator: `kind`

The available variants are:

@@ -1137,7 +1137,7 @@ Determines how the stand-by scheme should be provided. - Required: No - Type: object -- Type-deciding property: kind +- Discriminator: `kind`

The available variants are:

@@ -1602,7 +1602,7 @@ Determines how the stand-by scheme should be provided. - Required: No - Type: object -- Type-deciding property: kind +- Discriminator: `kind`

The available variants are:

diff --git a/avm/res/digital-twins/digital-twins-instance/README.md b/avm/res/digital-twins/digital-twins-instance/README.md index 361f2c64a9..2f3a1f2c22 100644 --- a/avm/res/digital-twins/digital-twins-instance/README.md +++ b/avm/res/digital-twins/digital-twins-instance/README.md @@ -1057,6 +1057,402 @@ The properties of the endpoint. - Required: Yes - Type: object +- Discriminator: `endpointType` + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`EventGrid`](#variant-endpointspropertiesendpointtype-eventgrid) | The type for an event grid endpoint. | +| [`EventHub`](#variant-endpointspropertiesendpointtype-eventhub) | The type for an event hub endpoint. | +| [`ServiceBus`](#variant-endpointspropertiesendpointtype-servicebus) | The type for a service bus endpoint. | + +### Variant: `endpoints.properties.endpointType-EventGrid` +The type for an event grid endpoint. + +To use this variant, set the property `endpointType` to `EventGrid`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endpointType`](#parameter-endpointspropertiesendpointtype-eventgridendpointtype) | string | The type of endpoint to create. | +| [`eventGridTopicResourceId`](#parameter-endpointspropertiesendpointtype-eventgrideventgridtopicresourceid) | string | The resource ID of the Event Grid Topic to get access keys from. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`deadLetterSecret`](#parameter-endpointspropertiesendpointtype-eventgriddeadlettersecret) | securestring | Dead letter storage secret for key-based authentication. Will be obfuscated during read. | +| [`deadLetterUri`](#parameter-endpointspropertiesendpointtype-eventgriddeadletteruri) | string | Dead letter storage URL for identity-based authentication. | + +### Parameter: `endpoints.properties.endpointType-EventGrid.endpointType` + +The type of endpoint to create. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'EventGrid' + ] + ``` + +### Parameter: `endpoints.properties.endpointType-EventGrid.eventGridTopicResourceId` + +The resource ID of the Event Grid Topic to get access keys from. + +- Required: Yes +- Type: string + +### Parameter: `endpoints.properties.endpointType-EventGrid.deadLetterSecret` + +Dead letter storage secret for key-based authentication. Will be obfuscated during read. + +- Required: No +- Type: securestring + +### Parameter: `endpoints.properties.endpointType-EventGrid.deadLetterUri` + +Dead letter storage URL for identity-based authentication. + +- Required: No +- Type: string + +### Variant: `endpoints.properties.endpointType-EventHub` +The type for an event hub endpoint. + +To use this variant, set the property `endpointType` to `EventHub`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authentication`](#parameter-endpointspropertiesendpointtype-eventhubauthentication) | object | Specifies the authentication type being used for connecting to the endpoint. | +| [`endpointType`](#parameter-endpointspropertiesendpointtype-eventhubendpointtype) | string | The type of endpoint to create. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`deadLetterSecret`](#parameter-endpointspropertiesendpointtype-eventhubdeadlettersecret) | securestring | Dead letter storage secret for key-based authentication. Will be obfuscated during read. | +| [`deadLetterUri`](#parameter-endpointspropertiesendpointtype-eventhubdeadletteruri) | string | Dead letter storage URL for identity-based authentication. | + +### Parameter: `endpoints.properties.endpointType-EventHub.authentication` + +Specifies the authentication type being used for connecting to the endpoint. + +- Required: Yes +- Type: object +- Discriminator: `type` + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`IdentityBased`](#variant-endpointspropertiesendpointtype-eventhubauthenticationtype-identitybased) | | +| [`KeyBased`](#variant-endpointspropertiesendpointtype-eventhubauthenticationtype-keybased) | | + +### Variant: `endpoints.properties.endpointType-EventHub.authentication.type-IdentityBased` + + +To use this variant, set the property `type` to `IdentityBased`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`eventHubResourceId`](#parameter-endpointspropertiesendpointtype-eventhubauthenticationtype-identitybasedeventhubresourceid) | string | The resource ID of the Event Hub Namespace Event Hub. | +| [`type`](#parameter-endpointspropertiesendpointtype-eventhubauthenticationtype-identitybasedtype) | string | Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`managedIdentities`](#parameter-endpointspropertiesendpointtype-eventhubauthenticationtype-identitybasedmanagedidentities) | object | The managed identity definition for this resource. Only one type of identity is supported: system-assigned or user-assigned, but not both. | + +### Parameter: `endpoints.properties.endpointType-EventHub.authentication.type-IdentityBased.eventHubResourceId` + +The resource ID of the Event Hub Namespace Event Hub. + +- Required: Yes +- Type: string + +### Parameter: `endpoints.properties.endpointType-EventHub.authentication.type-IdentityBased.type` + +Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'IdentityBased' + ] + ``` + +### Parameter: `endpoints.properties.endpointType-EventHub.authentication.type-IdentityBased.managedIdentities` + +The managed identity definition for this resource. Only one type of identity is supported: system-assigned or user-assigned, but not both. + +- Required: No +- Type: object + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`systemAssigned`](#parameter-endpointspropertiesendpointtype-eventhubauthenticationtype-identitybasedmanagedidentitiessystemassigned) | bool | Enables system assigned managed identity on the resource. | +| [`userAssignedResourceId`](#parameter-endpointspropertiesendpointtype-eventhubauthenticationtype-identitybasedmanagedidentitiesuserassignedresourceid) | string | The resource ID(s) to assign to the resource. | + +### Parameter: `endpoints.properties.endpointType-EventHub.authentication.type-IdentityBased.managedIdentities.systemAssigned` + +Enables system assigned managed identity on the resource. + +- Required: No +- Type: bool + +### Parameter: `endpoints.properties.endpointType-EventHub.authentication.type-IdentityBased.managedIdentities.userAssignedResourceId` + +The resource ID(s) to assign to the resource. + +- Required: No +- Type: string + +### Variant: `endpoints.properties.endpointType-EventHub.authentication.type-KeyBased` + + +To use this variant, set the property `type` to `KeyBased`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`eventHubAuthorizationRuleName`](#parameter-endpointspropertiesendpointtype-eventhubauthenticationtype-keybasedeventhubauthorizationrulename) | string | The name of the Event Hub Namespace Event Hub Authorization Rule. | +| [`eventHubResourceId`](#parameter-endpointspropertiesendpointtype-eventhubauthenticationtype-keybasedeventhubresourceid) | string | The resource ID of the Event Hub Namespace Event Hub. | +| [`type`](#parameter-endpointspropertiesendpointtype-eventhubauthenticationtype-keybasedtype) | string | Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. | + +### Parameter: `endpoints.properties.endpointType-EventHub.authentication.type-KeyBased.eventHubAuthorizationRuleName` + +The name of the Event Hub Namespace Event Hub Authorization Rule. + +- Required: Yes +- Type: string + +### Parameter: `endpoints.properties.endpointType-EventHub.authentication.type-KeyBased.eventHubResourceId` + +The resource ID of the Event Hub Namespace Event Hub. + +- Required: Yes +- Type: string + +### Parameter: `endpoints.properties.endpointType-EventHub.authentication.type-KeyBased.type` + +Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'KeyBased' + ] + ``` + +### Parameter: `endpoints.properties.endpointType-EventHub.endpointType` + +The type of endpoint to create. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'EventHub' + ] + ``` + +### Parameter: `endpoints.properties.endpointType-EventHub.deadLetterSecret` + +Dead letter storage secret for key-based authentication. Will be obfuscated during read. + +- Required: No +- Type: securestring + +### Parameter: `endpoints.properties.endpointType-EventHub.deadLetterUri` + +Dead letter storage URL for identity-based authentication. + +- Required: No +- Type: string + +### Variant: `endpoints.properties.endpointType-ServiceBus` +The type for a service bus endpoint. + +To use this variant, set the property `endpointType` to `ServiceBus`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authentication`](#parameter-endpointspropertiesendpointtype-servicebusauthentication) | object | Specifies the authentication type being used for connecting to the endpoint. | +| [`endpointType`](#parameter-endpointspropertiesendpointtype-servicebusendpointtype) | string | The type of endpoint to create. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`deadLetterSecret`](#parameter-endpointspropertiesendpointtype-servicebusdeadlettersecret) | securestring | Dead letter storage secret for key-based authentication. Will be obfuscated during read. | +| [`deadLetterUri`](#parameter-endpointspropertiesendpointtype-servicebusdeadletteruri) | string | Dead letter storage URL for identity-based authentication. | + +### Parameter: `endpoints.properties.endpointType-ServiceBus.authentication` + +Specifies the authentication type being used for connecting to the endpoint. + +- Required: Yes +- Type: object +- Discriminator: `type` + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`IdentityBased`](#variant-endpointspropertiesendpointtype-servicebusauthenticationtype-identitybased) | | +| [`KeyBased`](#variant-endpointspropertiesendpointtype-servicebusauthenticationtype-keybased) | | + +### Variant: `endpoints.properties.endpointType-ServiceBus.authentication.type-IdentityBased` + + +To use this variant, set the property `type` to `IdentityBased`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`serviceBusNamespaceTopicResourceId`](#parameter-endpointspropertiesendpointtype-servicebusauthenticationtype-identitybasedservicebusnamespacetopicresourceid) | string | The ServiceBus Namespace Topic resource ID. | +| [`type`](#parameter-endpointspropertiesendpointtype-servicebusauthenticationtype-identitybasedtype) | string | Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`managedIdentities`](#parameter-endpointspropertiesendpointtype-servicebusauthenticationtype-identitybasedmanagedidentities) | object | The managed identity definition for this resource. Only one type of identity is supported: system-assigned or user-assigned, but not both. | + +### Parameter: `endpoints.properties.endpointType-ServiceBus.authentication.type-IdentityBased.serviceBusNamespaceTopicResourceId` + +The ServiceBus Namespace Topic resource ID. + +- Required: Yes +- Type: string + +### Parameter: `endpoints.properties.endpointType-ServiceBus.authentication.type-IdentityBased.type` + +Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'IdentityBased' + ] + ``` + +### Parameter: `endpoints.properties.endpointType-ServiceBus.authentication.type-IdentityBased.managedIdentities` + +The managed identity definition for this resource. Only one type of identity is supported: system-assigned or user-assigned, but not both. + +- Required: No +- Type: object + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`systemAssigned`](#parameter-endpointspropertiesendpointtype-servicebusauthenticationtype-identitybasedmanagedidentitiessystemassigned) | bool | Enables system assigned managed identity on the resource. | +| [`userAssignedResourceId`](#parameter-endpointspropertiesendpointtype-servicebusauthenticationtype-identitybasedmanagedidentitiesuserassignedresourceid) | string | The resource ID(s) to assign to the resource. | + +### Parameter: `endpoints.properties.endpointType-ServiceBus.authentication.type-IdentityBased.managedIdentities.systemAssigned` + +Enables system assigned managed identity on the resource. + +- Required: No +- Type: bool + +### Parameter: `endpoints.properties.endpointType-ServiceBus.authentication.type-IdentityBased.managedIdentities.userAssignedResourceId` + +The resource ID(s) to assign to the resource. + +- Required: No +- Type: string + +### Variant: `endpoints.properties.endpointType-ServiceBus.authentication.type-KeyBased` + + +To use this variant, set the property `type` to `KeyBased`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`serviceBusNamespaceTopicAuthorizationRuleName`](#parameter-endpointspropertiesendpointtype-servicebusauthenticationtype-keybasedservicebusnamespacetopicauthorizationrulename) | string | The ServiceBus Namespace Topic Authorization Rule name. | +| [`serviceBusNamespaceTopicResourceId`](#parameter-endpointspropertiesendpointtype-servicebusauthenticationtype-keybasedservicebusnamespacetopicresourceid) | string | The ServiceBus Namespace Topic resource ID. | +| [`type`](#parameter-endpointspropertiesendpointtype-servicebusauthenticationtype-keybasedtype) | string | Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. | + +### Parameter: `endpoints.properties.endpointType-ServiceBus.authentication.type-KeyBased.serviceBusNamespaceTopicAuthorizationRuleName` + +The ServiceBus Namespace Topic Authorization Rule name. + +- Required: Yes +- Type: string + +### Parameter: `endpoints.properties.endpointType-ServiceBus.authentication.type-KeyBased.serviceBusNamespaceTopicResourceId` + +The ServiceBus Namespace Topic resource ID. + +- Required: Yes +- Type: string + +### Parameter: `endpoints.properties.endpointType-ServiceBus.authentication.type-KeyBased.type` + +Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'KeyBased' + ] + ``` + +### Parameter: `endpoints.properties.endpointType-ServiceBus.endpointType` + +The type of endpoint to create. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ServiceBus' + ] + ``` + +### Parameter: `endpoints.properties.endpointType-ServiceBus.deadLetterSecret` + +Dead letter storage secret for key-based authentication. Will be obfuscated during read. + +- Required: No +- Type: securestring + +### Parameter: `endpoints.properties.endpointType-ServiceBus.deadLetterUri` + +Dead letter storage URL for identity-based authentication. + +- Required: No +- Type: string ### Parameter: `endpoints.name` diff --git a/avm/res/digital-twins/digital-twins-instance/endpoint/README.md b/avm/res/digital-twins/digital-twins-instance/endpoint/README.md index ef2c58371b..5e33b2bdb8 100644 --- a/avm/res/digital-twins/digital-twins-instance/endpoint/README.md +++ b/avm/res/digital-twins/digital-twins-instance/endpoint/README.md @@ -42,6 +42,402 @@ The properties of the endpoint. - Required: Yes - Type: object +- Discriminator: `endpointType` + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`EventGrid`](#variant-propertiesendpointtype-eventgrid) | The type for an event grid endpoint. | +| [`EventHub`](#variant-propertiesendpointtype-eventhub) | The type for an event hub endpoint. | +| [`ServiceBus`](#variant-propertiesendpointtype-servicebus) | The type for a service bus endpoint. | + +### Variant: `properties.endpointType-EventGrid` +The type for an event grid endpoint. + +To use this variant, set the property `endpointType` to `EventGrid`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`endpointType`](#parameter-propertiesendpointtype-eventgridendpointtype) | string | The type of endpoint to create. | +| [`eventGridTopicResourceId`](#parameter-propertiesendpointtype-eventgrideventgridtopicresourceid) | string | The resource ID of the Event Grid Topic to get access keys from. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`deadLetterSecret`](#parameter-propertiesendpointtype-eventgriddeadlettersecret) | securestring | Dead letter storage secret for key-based authentication. Will be obfuscated during read. | +| [`deadLetterUri`](#parameter-propertiesendpointtype-eventgriddeadletteruri) | string | Dead letter storage URL for identity-based authentication. | + +### Parameter: `properties.endpointType-EventGrid.endpointType` + +The type of endpoint to create. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'EventGrid' + ] + ``` + +### Parameter: `properties.endpointType-EventGrid.eventGridTopicResourceId` + +The resource ID of the Event Grid Topic to get access keys from. + +- Required: Yes +- Type: string + +### Parameter: `properties.endpointType-EventGrid.deadLetterSecret` + +Dead letter storage secret for key-based authentication. Will be obfuscated during read. + +- Required: No +- Type: securestring + +### Parameter: `properties.endpointType-EventGrid.deadLetterUri` + +Dead letter storage URL for identity-based authentication. + +- Required: No +- Type: string + +### Variant: `properties.endpointType-EventHub` +The type for an event hub endpoint. + +To use this variant, set the property `endpointType` to `EventHub`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authentication`](#parameter-propertiesendpointtype-eventhubauthentication) | object | Specifies the authentication type being used for connecting to the endpoint. | +| [`endpointType`](#parameter-propertiesendpointtype-eventhubendpointtype) | string | The type of endpoint to create. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`deadLetterSecret`](#parameter-propertiesendpointtype-eventhubdeadlettersecret) | securestring | Dead letter storage secret for key-based authentication. Will be obfuscated during read. | +| [`deadLetterUri`](#parameter-propertiesendpointtype-eventhubdeadletteruri) | string | Dead letter storage URL for identity-based authentication. | + +### Parameter: `properties.endpointType-EventHub.authentication` + +Specifies the authentication type being used for connecting to the endpoint. + +- Required: Yes +- Type: object +- Discriminator: `type` + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`IdentityBased`](#variant-propertiesendpointtype-eventhubauthenticationtype-identitybased) | | +| [`KeyBased`](#variant-propertiesendpointtype-eventhubauthenticationtype-keybased) | | + +### Variant: `properties.endpointType-EventHub.authentication.type-IdentityBased` + + +To use this variant, set the property `type` to `IdentityBased`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`eventHubResourceId`](#parameter-propertiesendpointtype-eventhubauthenticationtype-identitybasedeventhubresourceid) | string | The resource ID of the Event Hub Namespace Event Hub. | +| [`type`](#parameter-propertiesendpointtype-eventhubauthenticationtype-identitybasedtype) | string | Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`managedIdentities`](#parameter-propertiesendpointtype-eventhubauthenticationtype-identitybasedmanagedidentities) | object | The managed identity definition for this resource. Only one type of identity is supported: system-assigned or user-assigned, but not both. | + +### Parameter: `properties.endpointType-EventHub.authentication.type-IdentityBased.eventHubResourceId` + +The resource ID of the Event Hub Namespace Event Hub. + +- Required: Yes +- Type: string + +### Parameter: `properties.endpointType-EventHub.authentication.type-IdentityBased.type` + +Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'IdentityBased' + ] + ``` + +### Parameter: `properties.endpointType-EventHub.authentication.type-IdentityBased.managedIdentities` + +The managed identity definition for this resource. Only one type of identity is supported: system-assigned or user-assigned, but not both. + +- Required: No +- Type: object + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`systemAssigned`](#parameter-propertiesendpointtype-eventhubauthenticationtype-identitybasedmanagedidentitiessystemassigned) | bool | Enables system assigned managed identity on the resource. | +| [`userAssignedResourceId`](#parameter-propertiesendpointtype-eventhubauthenticationtype-identitybasedmanagedidentitiesuserassignedresourceid) | string | The resource ID(s) to assign to the resource. | + +### Parameter: `properties.endpointType-EventHub.authentication.type-IdentityBased.managedIdentities.systemAssigned` + +Enables system assigned managed identity on the resource. + +- Required: No +- Type: bool + +### Parameter: `properties.endpointType-EventHub.authentication.type-IdentityBased.managedIdentities.userAssignedResourceId` + +The resource ID(s) to assign to the resource. + +- Required: No +- Type: string + +### Variant: `properties.endpointType-EventHub.authentication.type-KeyBased` + + +To use this variant, set the property `type` to `KeyBased`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`eventHubAuthorizationRuleName`](#parameter-propertiesendpointtype-eventhubauthenticationtype-keybasedeventhubauthorizationrulename) | string | The name of the Event Hub Namespace Event Hub Authorization Rule. | +| [`eventHubResourceId`](#parameter-propertiesendpointtype-eventhubauthenticationtype-keybasedeventhubresourceid) | string | The resource ID of the Event Hub Namespace Event Hub. | +| [`type`](#parameter-propertiesendpointtype-eventhubauthenticationtype-keybasedtype) | string | Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. | + +### Parameter: `properties.endpointType-EventHub.authentication.type-KeyBased.eventHubAuthorizationRuleName` + +The name of the Event Hub Namespace Event Hub Authorization Rule. + +- Required: Yes +- Type: string + +### Parameter: `properties.endpointType-EventHub.authentication.type-KeyBased.eventHubResourceId` + +The resource ID of the Event Hub Namespace Event Hub. + +- Required: Yes +- Type: string + +### Parameter: `properties.endpointType-EventHub.authentication.type-KeyBased.type` + +Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'KeyBased' + ] + ``` + +### Parameter: `properties.endpointType-EventHub.endpointType` + +The type of endpoint to create. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'EventHub' + ] + ``` + +### Parameter: `properties.endpointType-EventHub.deadLetterSecret` + +Dead letter storage secret for key-based authentication. Will be obfuscated during read. + +- Required: No +- Type: securestring + +### Parameter: `properties.endpointType-EventHub.deadLetterUri` + +Dead letter storage URL for identity-based authentication. + +- Required: No +- Type: string + +### Variant: `properties.endpointType-ServiceBus` +The type for a service bus endpoint. + +To use this variant, set the property `endpointType` to `ServiceBus`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authentication`](#parameter-propertiesendpointtype-servicebusauthentication) | object | Specifies the authentication type being used for connecting to the endpoint. | +| [`endpointType`](#parameter-propertiesendpointtype-servicebusendpointtype) | string | The type of endpoint to create. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`deadLetterSecret`](#parameter-propertiesendpointtype-servicebusdeadlettersecret) | securestring | Dead letter storage secret for key-based authentication. Will be obfuscated during read. | +| [`deadLetterUri`](#parameter-propertiesendpointtype-servicebusdeadletteruri) | string | Dead letter storage URL for identity-based authentication. | + +### Parameter: `properties.endpointType-ServiceBus.authentication` + +Specifies the authentication type being used for connecting to the endpoint. + +- Required: Yes +- Type: object +- Discriminator: `type` + +

The available variants are:

+ +| Variant | Description | +| :-- | :-- | +| [`IdentityBased`](#variant-propertiesendpointtype-servicebusauthenticationtype-identitybased) | | +| [`KeyBased`](#variant-propertiesendpointtype-servicebusauthenticationtype-keybased) | | + +### Variant: `properties.endpointType-ServiceBus.authentication.type-IdentityBased` + + +To use this variant, set the property `type` to `IdentityBased`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`serviceBusNamespaceTopicResourceId`](#parameter-propertiesendpointtype-servicebusauthenticationtype-identitybasedservicebusnamespacetopicresourceid) | string | The ServiceBus Namespace Topic resource ID. | +| [`type`](#parameter-propertiesendpointtype-servicebusauthenticationtype-identitybasedtype) | string | Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. | + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`managedIdentities`](#parameter-propertiesendpointtype-servicebusauthenticationtype-identitybasedmanagedidentities) | object | The managed identity definition for this resource. Only one type of identity is supported: system-assigned or user-assigned, but not both. | + +### Parameter: `properties.endpointType-ServiceBus.authentication.type-IdentityBased.serviceBusNamespaceTopicResourceId` + +The ServiceBus Namespace Topic resource ID. + +- Required: Yes +- Type: string + +### Parameter: `properties.endpointType-ServiceBus.authentication.type-IdentityBased.type` + +Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'IdentityBased' + ] + ``` + +### Parameter: `properties.endpointType-ServiceBus.authentication.type-IdentityBased.managedIdentities` + +The managed identity definition for this resource. Only one type of identity is supported: system-assigned or user-assigned, but not both. + +- Required: No +- Type: object + +**Optional parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`systemAssigned`](#parameter-propertiesendpointtype-servicebusauthenticationtype-identitybasedmanagedidentitiessystemassigned) | bool | Enables system assigned managed identity on the resource. | +| [`userAssignedResourceId`](#parameter-propertiesendpointtype-servicebusauthenticationtype-identitybasedmanagedidentitiesuserassignedresourceid) | string | The resource ID(s) to assign to the resource. | + +### Parameter: `properties.endpointType-ServiceBus.authentication.type-IdentityBased.managedIdentities.systemAssigned` + +Enables system assigned managed identity on the resource. + +- Required: No +- Type: bool + +### Parameter: `properties.endpointType-ServiceBus.authentication.type-IdentityBased.managedIdentities.userAssignedResourceId` + +The resource ID(s) to assign to the resource. + +- Required: No +- Type: string + +### Variant: `properties.endpointType-ServiceBus.authentication.type-KeyBased` + + +To use this variant, set the property `type` to `KeyBased`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`serviceBusNamespaceTopicAuthorizationRuleName`](#parameter-propertiesendpointtype-servicebusauthenticationtype-keybasedservicebusnamespacetopicauthorizationrulename) | string | The ServiceBus Namespace Topic Authorization Rule name. | +| [`serviceBusNamespaceTopicResourceId`](#parameter-propertiesendpointtype-servicebusauthenticationtype-keybasedservicebusnamespacetopicresourceid) | string | The ServiceBus Namespace Topic resource ID. | +| [`type`](#parameter-propertiesendpointtype-servicebusauthenticationtype-keybasedtype) | string | Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. | + +### Parameter: `properties.endpointType-ServiceBus.authentication.type-KeyBased.serviceBusNamespaceTopicAuthorizationRuleName` + +The ServiceBus Namespace Topic Authorization Rule name. + +- Required: Yes +- Type: string + +### Parameter: `properties.endpointType-ServiceBus.authentication.type-KeyBased.serviceBusNamespaceTopicResourceId` + +The ServiceBus Namespace Topic resource ID. + +- Required: Yes +- Type: string + +### Parameter: `properties.endpointType-ServiceBus.authentication.type-KeyBased.type` + +Specifies the authentication type being used for connecting to the endpoint. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'KeyBased' + ] + ``` + +### Parameter: `properties.endpointType-ServiceBus.endpointType` + +The type of endpoint to create. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'ServiceBus' + ] + ``` + +### Parameter: `properties.endpointType-ServiceBus.deadLetterSecret` + +Dead letter storage secret for key-based authentication. Will be obfuscated during read. + +- Required: No +- Type: securestring + +### Parameter: `properties.endpointType-ServiceBus.deadLetterUri` + +Dead letter storage URL for identity-based authentication. + +- Required: No +- Type: string ### Parameter: `digitalTwinInstanceName` diff --git a/avm/res/insights/data-collection-rule/README.md b/avm/res/insights/data-collection-rule/README.md index 63f0fb0e74..cef1f204da 100644 --- a/avm/res/insights/data-collection-rule/README.md +++ b/avm/res/insights/data-collection-rule/README.md @@ -2815,7 +2815,7 @@ The kind of data collection rule. - Required: Yes - Type: object -- Type-deciding property: kind +- Discriminator: `kind`

The available variants are:

diff --git a/avm/res/insights/metric-alert/README.md b/avm/res/insights/metric-alert/README.md index efe541e217..5f9fc4f7cb 100644 --- a/avm/res/insights/metric-alert/README.md +++ b/avm/res/insights/metric-alert/README.md @@ -524,7 +524,7 @@ Maps to the 'odata.type' field. Specifies the type of the alert criteria. - Required: Yes - Type: object -- Type-deciding property: odata.type +- Discriminator: `odata.type`

The available variants are:

@@ -543,14 +543,14 @@ To use this variant, set the property `odata.type` to `Microsoft.Azure.Monitor.W | Parameter | Type | Description | | :-- | :-- | :-- | -| [`componentResourceId`](#parameter-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteriacomponentresourceid) | string | The Application Insights resource Id. | +| [`componentResourceId`](#parameter-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteriacomponentresourceid) | string | The Application Insights resource ID. | | [`failedLocationCount`](#parameter-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteriafailedlocationcount) | int | The number of failed locations. | | [`odata.type`](#parameter-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteriaodatatype) | string | The type of the alert criteria. | -| [`webTestResourceId`](#parameter-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteriawebtestresourceid) | string | The Application Insights web test resource Id. | +| [`webTestResourceId`](#parameter-criteriaodatatype-microsoftazuremonitorwebtestlocationavailabilitycriteriawebtestresourceid) | string | The Application Insights web test resource ID. | ### Parameter: `criteria.odata.type-Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria.componentResourceId` -The Application Insights resource Id. +The Application Insights resource ID. - Required: Yes - Type: string @@ -577,7 +577,7 @@ The type of the alert criteria. ### Parameter: `criteria.odata.type-Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria.webTestResourceId` -The Application Insights web test resource Id. +The Application Insights web test resource ID. - Required: Yes - Type: string diff --git a/avm/res/machine-learning-services/workspace/README.md b/avm/res/machine-learning-services/workspace/README.md index f6073db151..bf08069ff6 100644 --- a/avm/res/machine-learning-services/workspace/README.md +++ b/avm/res/machine-learning-services/workspace/README.md @@ -1710,7 +1710,7 @@ The properties of the connection, specific to the auth type. - Required: Yes - Type: secureObject -- Type-deciding property: authType +- Discriminator: `authType`

The available variants are:

@@ -1718,6 +1718,7 @@ The properties of the connection, specific to the auth type. | :-- | :-- | | [`AAD`](#variant-connectionsconnectionpropertiesauthtype-aad) | | | [`AccessKey`](#variant-connectionsconnectionpropertiesauthtype-accesskey) | | +| [`AccountKey`](#variant-connectionsconnectionpropertiesauthtype-accountkey) | | | [`ApiKey`](#variant-connectionsconnectionpropertiesauthtype-apikey) | | | [`CustomKeys`](#variant-connectionsconnectionpropertiesauthtype-customkeys) | | | [`ManagedIdentity`](#variant-connectionsconnectionpropertiesauthtype-managedidentity) | | @@ -1805,6 +1806,51 @@ The connection secret access key. - Required: Yes - Type: string +### Variant: `connections.connectionProperties.authType-AccountKey` + + +To use this variant, set the property `authType` to `AccountKey`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionsconnectionpropertiesauthtype-accountkeyauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionsconnectionpropertiesauthtype-accountkeycredentials) | object | The credentials for the connection. | + +### Parameter: `connections.connectionProperties.authType-AccountKey.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AccountKey' + ] + ``` + +### Parameter: `connections.connectionProperties.authType-AccountKey.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`key`](#parameter-connectionsconnectionpropertiesauthtype-accountkeycredentialskey) | string | The connection key. | + +### Parameter: `connections.connectionProperties.authType-AccountKey.credentials.key` + +The connection key. + +- Required: Yes +- Type: string + ### Variant: `connections.connectionProperties.authType-ApiKey` @@ -2786,7 +2832,7 @@ The outbound rule. The name of the rule is the object key. - Required: Yes - Type: object -- Type-deciding property: type +- Discriminator: `type`

The available variants are:

diff --git a/avm/res/machine-learning-services/workspace/connection/README.md b/avm/res/machine-learning-services/workspace/connection/README.md index 97625223d2..2fd230eff2 100644 --- a/avm/res/machine-learning-services/workspace/connection/README.md +++ b/avm/res/machine-learning-services/workspace/connection/README.md @@ -159,7 +159,7 @@ The properties of the connection, specific to the auth type. - Required: Yes - Type: secureObject -- Type-deciding property: authType +- Discriminator: `authType`

The available variants are:

@@ -167,6 +167,7 @@ The properties of the connection, specific to the auth type. | :-- | :-- | | [`AAD`](#variant-connectionpropertiesauthtype-aad) | | | [`AccessKey`](#variant-connectionpropertiesauthtype-accesskey) | | +| [`AccountKey`](#variant-connectionpropertiesauthtype-accountkey) | | | [`ApiKey`](#variant-connectionpropertiesauthtype-apikey) | | | [`CustomKeys`](#variant-connectionpropertiesauthtype-customkeys) | | | [`ManagedIdentity`](#variant-connectionpropertiesauthtype-managedidentity) | | @@ -254,6 +255,51 @@ The connection secret access key. - Required: Yes - Type: string +### Variant: `connectionProperties.authType-AccountKey` + + +To use this variant, set the property `authType` to `AccountKey`. + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`authType`](#parameter-connectionpropertiesauthtype-accountkeyauthtype) | string | The authentication type of the connection target. | +| [`credentials`](#parameter-connectionpropertiesauthtype-accountkeycredentials) | object | The credentials for the connection. | + +### Parameter: `connectionProperties.authType-AccountKey.authType` + +The authentication type of the connection target. + +- Required: Yes +- Type: string +- Allowed: + ```Bicep + [ + 'AccountKey' + ] + ``` + +### Parameter: `connectionProperties.authType-AccountKey.credentials` + +The credentials for the connection. + +- Required: Yes +- Type: object + +**Required parameters** + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| [`key`](#parameter-connectionpropertiesauthtype-accountkeycredentialskey) | string | The connection key. | + +### Parameter: `connectionProperties.authType-AccountKey.credentials.key` + +The connection key. + +- Required: Yes +- Type: string + ### Variant: `connectionProperties.authType-ApiKey` diff --git a/avm/res/network/virtual-network-gateway/README.md b/avm/res/network/virtual-network-gateway/README.md index 8ae165717c..5f8cff0f1f 100644 --- a/avm/res/network/virtual-network-gateway/README.md +++ b/avm/res/network/virtual-network-gateway/README.md @@ -2387,7 +2387,7 @@ Specifies one of the following four configurations: Active-Active with (clusterM - Required: Yes - Type: object -- Type-deciding property: clusterMode +- Discriminator: `clusterMode`

The available variants are:

diff --git a/avm/res/virtual-machine-images/image-template/README.md b/avm/res/virtual-machine-images/image-template/README.md index c3e99f185a..63126d6638 100644 --- a/avm/res/virtual-machine-images/image-template/README.md +++ b/avm/res/virtual-machine-images/image-template/README.md @@ -791,7 +791,7 @@ The distribution targets where the image output needs to go to. - Required: Yes - Type: array -- Type-deciding property: type +- Discriminator: `type`

The available variants are:

@@ -808,15 +808,10 @@ To use this variant, set the property `type` to `SharedImage`. **Required parameters** -| Parameter | Type | Description | -| :-- | :-- | :-- | -| [`type`](#parameter-distributionstype-sharedimagetype) | string | The type of distribution. | - -**Conditional parameters** - | Parameter | Type | Description | | :-- | :-- | :-- | | [`sharedImageGalleryImageDefinitionResourceId`](#parameter-distributionstype-sharedimagesharedimagegalleryimagedefinitionresourceid) | string | Resource ID of Compute Gallery Image Definition to distribute image to, e.g.: /subscriptions//resourceGroups//providers/Microsoft.Compute/galleries//images/. | +| [`type`](#parameter-distributionstype-sharedimagetype) | string | The type of distribution. | **Optional parameters** @@ -829,6 +824,13 @@ To use this variant, set the property `type` to `SharedImage`. | [`sharedImageGalleryImageDefinitionTargetVersion`](#parameter-distributionstype-sharedimagesharedimagegalleryimagedefinitiontargetversion) | string | Version of the Compute Gallery Image. Supports the following Version Syntax: Major.Minor.Build (i.e., '1.1.1' or '10.1.2'). If not provided, a version will be calculated. | | [`storageAccountType`](#parameter-distributionstype-sharedimagestorageaccounttype) | string | The storage account type of the image. Defaults to [Standard_LRS]. | +### Parameter: `distributions.type-SharedImage.sharedImageGalleryImageDefinitionResourceId` + +Resource ID of Compute Gallery Image Definition to distribute image to, e.g.: /subscriptions//resourceGroups//providers/Microsoft.Compute/galleries//images/. + +- Required: Yes +- Type: string + ### Parameter: `distributions.type-SharedImage.type` The type of distribution. @@ -842,13 +844,6 @@ The type of distribution. ] ``` -### Parameter: `distributions.type-SharedImage.sharedImageGalleryImageDefinitionResourceId` - -Resource ID of Compute Gallery Image Definition to distribute image to, e.g.: /subscriptions//resourceGroups//providers/Microsoft.Compute/galleries//images/. - -- Required: Yes -- Type: string - ### Parameter: `distributions.type-SharedImage.artifactTags` Tags that will be applied to the artifact once it has been created/updated by the distributor. If not provided will set tags based on the provided image source.