diff --git a/avm/res/compute/gallery/image/README.md b/avm/res/compute/gallery/image/README.md index 0c99e3a326..c2c50e2644 100644 --- a/avm/res/compute/gallery/image/README.md +++ b/avm/res/compute/gallery/image/README.md @@ -43,14 +43,8 @@ This module deploys an Azure Compute Gallery Image Definition. | [`endOfLife`](#parameter-endoflife) | string | The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable. Allowed format: 2020-01-10T23:00:00.000Z. | | [`eula`](#parameter-eula) | string | The Eula agreement for the gallery Image Definition. Has to be a valid URL. | | [`excludedDiskTypes`](#parameter-excludeddisktypes) | array | List of the excluded disk types (e.g., Standard_LRS). | -| [`hyperVGeneration`](#parameter-hypervgeneration) | string | The hypervisor generation of the Virtual Machine. -- If this value is not specified, then it is determined by the securityType parameter. -- If the securityType parameter is specified, then the value of hyperVGeneration will be V2, else V1. - | -| [`isAcceleratedNetworkSupported`](#parameter-isacceleratednetworksupported) | bool | Specify if the image supports accelerated networking. -Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, greatly improving its networking performance. -This high-performance path bypasses the host from the data path, which reduces latency, jitter, and CPU utilization for the most demanding network workloads on supported VM types. - | +| [`hyperVGeneration`](#parameter-hypervgeneration) | string | The hypervisor generation of the Virtual Machine.
  • If this value is not specified, then it is determined by the securityType parameter.
  • If the securityType parameter is specified, then the value of hyperVGeneration will be V2, else V1.

    | +| [`isAcceleratedNetworkSupported`](#parameter-isacceleratednetworksupported) | bool | Specify if the image supports accelerated networking.

    Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, greatly improving its networking performance.

    This high-performance path bypasses the host from the data path, which reduces latency, jitter, and CPU utilization for the most demanding network workloads on supported VM types.

    | | [`isHibernateSupported`](#parameter-ishibernatesupported) | bool | Specifiy if the image supports hibernation. | | [`location`](#parameter-location) | string | Location for all resources. | | [`maxRecommendedMemory`](#parameter-maxrecommendedmemory) | int | The maximum amount of RAM in GB recommended for this image. | @@ -148,10 +142,7 @@ List of the excluded disk types (e.g., Standard_LRS). ### Parameter: `hyperVGeneration` -The hypervisor generation of the Virtual Machine. -- If this value is not specified, then it is determined by the securityType parameter. -- If the securityType parameter is specified, then the value of hyperVGeneration will be V2, else V1. - +The hypervisor generation of the Virtual Machine.

  • If this value is not specified, then it is determined by the securityType parameter.
  • If the securityType parameter is specified, then the value of hyperVGeneration will be V2, else V1.

    - Required: No - Type: string @@ -165,10 +156,7 @@ The hypervisor generation of the Virtual Machine. ### Parameter: `isAcceleratedNetworkSupported` -Specify if the image supports accelerated networking. -Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, greatly improving its networking performance. -This high-performance path bypasses the host from the data path, which reduces latency, jitter, and CPU utilization for the most demanding network workloads on supported VM types. - +Specify if the image supports accelerated networking.

    Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, greatly improving its networking performance.

    This high-performance path bypasses the host from the data path, which reduces latency, jitter, and CPU utilization for the most demanding network workloads on supported VM types.

    - Required: No - Type: bool diff --git a/avm/res/web/site/README.md b/avm/res/web/site/README.md index b348f7f45b..d8bc8743a8 100644 --- a/avm/res/web/site/README.md +++ b/avm/res/web/site/README.md @@ -1121,11 +1121,7 @@ module site 'br/public:avm/res/web/site:' = { | [`clientAffinityEnabled`](#parameter-clientaffinityenabled) | bool | If client affinity is enabled. | | [`clientCertEnabled`](#parameter-clientcertenabled) | bool | To enable client certificate authentication (TLS mutual authentication). | | [`clientCertExclusionPaths`](#parameter-clientcertexclusionpaths) | string | Client certificate authentication comma-separated exclusion paths. | -| [`clientCertMode`](#parameter-clientcertmode) | string | This composes with ClientCertEnabled setting. -- ClientCertEnabled=false means ClientCert is ignored. -- ClientCertEnabled=true and ClientCertMode=Required means ClientCert is required. -- ClientCertEnabled=true and ClientCertMode=Optional means ClientCert is optional or accepted. - | +| [`clientCertMode`](#parameter-clientcertmode) | string | This composes with ClientCertEnabled setting.

  • ClientCertEnabled=false means ClientCert is ignored.
  • ClientCertEnabled=true and ClientCertMode=Required means ClientCert is required.
  • ClientCertEnabled=true and ClientCertMode=Optional means ClientCert is optional or accepted.

    | | [`cloningInfo`](#parameter-cloninginfo) | object | If specified during app creation, the app is cloned from a source app. | | [`containerSize`](#parameter-containersize) | int | Size of the function container. | | [`customDomainVerificationId`](#parameter-customdomainverificationid) | string | Unique identifier that verifies the custom domains assigned to the app. Customer will add this ID to a txt record for verification. | @@ -1248,11 +1244,7 @@ Client certificate authentication comma-separated exclusion paths. ### Parameter: `clientCertMode` -This composes with ClientCertEnabled setting. -- ClientCertEnabled=false means ClientCert is ignored. -- ClientCertEnabled=true and ClientCertMode=Required means ClientCert is required. -- ClientCertEnabled=true and ClientCertMode=Optional means ClientCert is optional or accepted. - +This composes with ClientCertEnabled setting.

  • ClientCertEnabled=false means ClientCert is ignored.
  • ClientCertEnabled=true and ClientCertMode=Required means ClientCert is required.
  • ClientCertEnabled=true and ClientCertMode=Optional means ClientCert is optional or accepted.

    - Required: No - Type: string diff --git a/avm/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 b/avm/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 index a97548796c..a787ba219a 100644 --- a/avm/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 +++ b/avm/utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1 @@ -306,14 +306,14 @@ function Set-DefinitionSection { } $isRequired = (Get-IsParameterRequired -TemplateFileContent $TemplateFileContent -Parameter $parameter) ? 'Yes' : 'No' - $description = $parameter.ContainsKey('metadata') ? $parameter['metadata']['description'] : $null + $description = $parameter.ContainsKey('metadata') ? $parameter['metadata']['description'].substring("$category. ".Length).Replace("`n- ", '

  • ').Replace("`r`n", '

    ').Replace("`n", '

    ') : $null ##################### # Table content # ##################### # build table for definition properties - $tableSectionContent += ('| [`{0}`]({1}) | {2} | {3} |' -f $parameter.name, $paramIdentifierLink, $type, $description.substring("$category. ".Length)) + $tableSectionContent += ('| [`{0}`]({1}) | {2} | {3} |' -f $parameter.name, $paramIdentifierLink, $type, $description) #################### # List content # @@ -394,7 +394,7 @@ function Set-DefinitionSection { $listSectionContent += @( $paramHeader, ($parameter.ContainsKey('metadata') ? '' : $null), - ($parameter.ContainsKey('metadata') ? $parameter['metadata']['description'].substring("$category. ".Length) : $null), + $description ($parameter.ContainsKey('metadata') ? '' : $null), ('- Required: {0}' -f $isRequired), ('- Type: {0}' -f $type),