Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fixes] Fixed issue with multi-line parameter descriptions #4488

Merged
merged 2 commits into from
Feb 7, 2024
Merged

[Fixes] Fixed issue with multi-line parameter descriptions #4488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1dec75a
Ported multiline fix from AVM
AlexanderSehr Feb 6, 2024
223a7b3
Update to latest
AlexanderSehr Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions modules/insights/private-link-scope/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,10 +379,7 @@ This instance deploys the module in alignment with the best-practices of the Azu

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`accessModeSettings`](#parameter-accessmodesettings) | object | Specifies the access mode of ingestion or queries through associated private endpoints in scope. For security reasons, it is recommended to use PrivateOnly whenever possible to avoid data exfiltration.

* Private Only - This mode allows the connected virtual network to reach only Private Link resources. It is the most secure mode and is set as the default when the `privateEndpoints` parameter is configured.
* Open - Allows the connected virtual network to reach both Private Link resources and the resources not in the AMPLS resource. Data exfiltration cannot be prevented in this mode. |
| [`accessModeSettings`](#parameter-accessmodesettings) | object | Specifies the access mode of ingestion or queries through associated private endpoints in scope. For security reasons, it is recommended to use PrivateOnly whenever possible to avoid data exfiltration.<p><p> * Private Only - This mode allows the connected virtual network to reach only Private Link resources. It is the most secure mode and is set as the default when the `privateEndpoints` parameter is configured.<p> * Open - Allows the connected virtual network to reach both Private Link resources and the resources not in the AMPLS resource. Data exfiltration cannot be prevented in this mode. |
| [`enableDefaultTelemetry`](#parameter-enabledefaulttelemetry) | bool | Enable telemetry via a Globally Unique Identifier (GUID). |
| [`location`](#parameter-location) | string | The location of the private link scope. Should be global. |
| [`lock`](#parameter-lock) | object | The lock settings of the service. |
Expand All @@ -400,10 +397,7 @@ Name of the private link scope.

### Parameter: `accessModeSettings`

Specifies the access mode of ingestion or queries through associated private endpoints in scope. For security reasons, it is recommended to use PrivateOnly whenever possible to avoid data exfiltration.

* Private Only - This mode allows the connected virtual network to reach only Private Link resources. It is the most secure mode and is set as the default when the `privateEndpoints` parameter is configured.
* Open - Allows the connected virtual network to reach both Private Link resources and the resources not in the AMPLS resource. Data exfiltration cannot be prevented in this mode.
Specifies the access mode of ingestion or queries through associated private endpoints in scope. For security reasons, it is recommended to use PrivateOnly whenever possible to avoid data exfiltration.<p><p> * Private Only - This mode allows the connected virtual network to reach only Private Link resources. It is the most secure mode and is set as the default when the `privateEndpoints` parameter is configured.<p> * Open - Allows the connected virtual network to reach both Private Link resources and the resources not in the AMPLS resource. Data exfiltration cannot be prevented in this mode.

- Required: No
- Type: object
Expand Down
6 changes: 3 additions & 3 deletions utilities/pipelines/sharedScripts/Set-ModuleReadMe.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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- ", '<li>').Replace("`r`n", '<p>').Replace("`n", '<p>') : $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 #
Expand Down Expand Up @@ -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),
Expand Down
Loading