Skip to content

Commit 60d9a25

Browse files
authored
[main - Dashboard|DataBox|DataBoxEdge|Databricks|Datadog] domain name of online doc is changed from docs.microsoft.com to learn.microsoft.com. (Azure#20270)
1 parent b9d62f7 commit 60d9a25

File tree

204 files changed

+257
-257
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

204 files changed

+257
-257
lines changed

src/Dashboard/Az.Dashboard.psm1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
}
3434

3535
if(-not $accountsModule) {
36-
Write-Error "`nThis module requires $accountsName version 2.7.5 or greater. For installation instructions, please see: https://docs.microsoft.com/powershell/azure/install-az-ps" -ErrorAction Stop
36+
Write-Error "`nThis module requires $accountsName version 2.7.5 or greater. For installation instructions, please see: https://learn.microsoft.com/powershell/azure/install-az-ps" -ErrorAction Stop
3737
} elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) {
3838
Write-Error "`nThis module requires $accountsName version 2.7.5 or greater. An earlier version of Az.Accounts is imported in the current PowerShell session. If you are running test, please try to add the switch '-RegenerateSupportModule' when executing 'test-module.ps1'. Otherwise please open a new PowerShell session and import this module again.`nAdditionally, this error could indicate that multiple incompatible versions of Azure PowerShell modules are installed on your system. For troubleshooting information, please see: https://aka.ms/azps-version-error" -ErrorAction Stop
3939
}

src/Dashboard/create-model-cmdlets.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ Create an in-memory object for ${ObjectType}.
158158
.Outputs
159159
${ObjectTypeWithNamespace}
160160
.Link
161-
https://docs.microsoft.com/powershell/module/az.${ModuleName}/new-Az${ModulePrefix}${ObjectType}Object
161+
https://learn.microsoft.com/powershell/module/az.${ModuleName}/new-Az${ModulePrefix}${ObjectType}Object
162162
#>
163163
function New-Az${ModulePrefix}${ObjectType}Object {
164164
[OutputType('${ObjectTypeWithNamespace}')]

src/Dashboard/custom/New-AzGrafana.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To create the parameters described below, construct a hash table containing the
3434
GRAFANAINTEGRATIONAZUREMONITORWORKSPACEINTEGRATION <IAzureMonitorWorkspaceIntegration[]>: .
3535
[AzureMonitorWorkspaceResourceId <String>]: The resource Id of the connected Azure Monitor Workspace.
3636
.Link
37-
https://docs.microsoft.com/powershell/module/az.dashboard/new-azgrafana
37+
https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafana
3838
#>
3939
function New-AzGrafana {
4040
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana])]

src/Dashboard/custom/New-AzGrafanaMonitorWorkspaceIntegrationObject.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Create an in-memory object for AzureMonitorWorkspaceIntegration.
2323
.Outputs
2424
Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.AzureMonitorWorkspaceIntegration
2525
.Link
26-
https://docs.microsoft.com/powershell/module/az.dashboard/new-azgrafanamonitorworkspaceintegrationobject
26+
https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafanamonitorworkspaceintegrationobject
2727
#>
2828
function New-AzGrafanaMonitorWorkspaceIntegrationObject {
2929
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.AzureMonitorWorkspaceIntegration')]

src/Dashboard/custom/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s
3232
### Attributes
3333
For processing the cmdlets, we've created some additional attributes:
3434
- `Microsoft.Azure.PowerShell.Cmdlets.Dashboard.DescriptionAttribute`
35-
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
35+
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
3636
- `Microsoft.Azure.PowerShell.Cmdlets.Dashboard.DoNotExportAttribute`
3737
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.Dashboard`.
3838
- `Microsoft.Azure.PowerShell.Cmdlets.Dashboard.InternalExportAttribute`

src/Dashboard/exports/Get-AzGrafana.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ INPUTOBJECT <IDashboardIdentity>: Identity Parameter
4343
[SubscriptionId <String>]: The ID of the target subscription.
4444
[WorkspaceName <String>]: The workspace name of Azure Managed Grafana.
4545
.Link
46-
https://docs.microsoft.com/powershell/module/az.dashboard/get-azgrafana
46+
https://learn.microsoft.com/powershell/module/az.dashboard/get-azgrafana
4747
#>
4848
function Get-AzGrafana {
4949
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana])]

src/Dashboard/exports/New-AzGrafana.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To create the parameters described below, construct a hash table containing the
3434
MONITORWORKSPACEINTEGRATION <IAzureMonitorWorkspaceIntegration[]>: The MonitorWorkspaceIntegration of Azure Managed Grafana.
3535
[AzureMonitorWorkspaceResourceId <String>]: The resource Id of the connected Azure Monitor Workspace.
3636
.Link
37-
https://docs.microsoft.com/powershell/module/az.dashboard/new-azgrafana
37+
https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafana
3838
#>
3939
function New-AzGrafana {
4040
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana])]

src/Dashboard/exports/New-AzGrafanaMonitorWorkspaceIntegrationObject.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ New-AzGrafanaMonitorWorkspaceIntegrationObject -AzureMonitorWorkspaceResourceId
2525
.Outputs
2626
Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.AzureMonitorWorkspaceIntegration
2727
.Link
28-
https://docs.microsoft.com/powershell/module/az.dashboard/new-azgrafanamonitorworkspaceintegrationobject
28+
https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafanamonitorworkspaceintegrationobject
2929
#>
3030
function New-AzGrafanaMonitorWorkspaceIntegrationObject {
3131
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.AzureMonitorWorkspaceIntegration])]

src/Dashboard/exports/ProxyCmdletDefinitions.ps1

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ INPUTOBJECT <IDashboardIdentity>: Identity Parameter
4343
[SubscriptionId <String>]: The ID of the target subscription.
4444
[WorkspaceName <String>]: The workspace name of Azure Managed Grafana.
4545
.Link
46-
https://docs.microsoft.com/powershell/module/az.dashboard/get-azgrafana
46+
https://learn.microsoft.com/powershell/module/az.dashboard/get-azgrafana
4747
#>
4848
function Get-AzGrafana {
4949
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana])]
@@ -235,7 +235,7 @@ INPUTOBJECT <IDashboardIdentity>: Identity Parameter
235235
[SubscriptionId <String>]: The ID of the target subscription.
236236
[WorkspaceName <String>]: The workspace name of Azure Managed Grafana.
237237
.Link
238-
https://docs.microsoft.com/powershell/module/az.dashboard/remove-azgrafana
238+
https://learn.microsoft.com/powershell/module/az.dashboard/remove-azgrafana
239239
#>
240240
function Remove-AzGrafana {
241241
[OutputType([System.Boolean])]
@@ -443,7 +443,7 @@ INPUTOBJECT <IDashboardIdentity>: Identity Parameter
443443
MONITORWORKSPACEINTEGRATION <IAzureMonitorWorkspaceIntegration[]>: The MonitorWorkspaceIntegration of Azure Managed Grafana.
444444
[AzureMonitorWorkspaceResourceId <String>]: The resource Id of the connected Azure Monitor Workspace.
445445
.Link
446-
https://docs.microsoft.com/powershell/module/az.dashboard/update-azgrafana
446+
https://learn.microsoft.com/powershell/module/az.dashboard/update-azgrafana
447447
#>
448448
function Update-AzGrafana {
449449
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana])]
@@ -682,7 +682,7 @@ To create the parameters described below, construct a hash table containing the
682682
MONITORWORKSPACEINTEGRATION <IAzureMonitorWorkspaceIntegration[]>: The MonitorWorkspaceIntegration of Azure Managed Grafana.
683683
[AzureMonitorWorkspaceResourceId <String>]: The resource Id of the connected Azure Monitor Workspace.
684684
.Link
685-
https://docs.microsoft.com/powershell/module/az.dashboard/new-azgrafana
685+
https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafana
686686
#>
687687
function New-AzGrafana {
688688
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana])]
@@ -935,7 +935,7 @@ New-AzGrafanaMonitorWorkspaceIntegrationObject -AzureMonitorWorkspaceResourceId
935935
.Outputs
936936
Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.AzureMonitorWorkspaceIntegration
937937
.Link
938-
https://docs.microsoft.com/powershell/module/az.dashboard/new-azgrafanamonitorworkspaceintegrationobject
938+
https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafanamonitorworkspaceintegrationobject
939939
#>
940940
function New-AzGrafanaMonitorWorkspaceIntegrationObject {
941941
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.AzureMonitorWorkspaceIntegration])]

src/Dashboard/exports/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Exports
2-
This directory contains the cmdlets *exported by* `Az.Dashboard`. No other cmdlets in this repository are directly exported. What that means is the `Az.Dashboard` module will run [Export-ModuleMember](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/export-modulemember) on the cmldets in this directory. The cmdlets in this directory are generated at **build-time**. Do not put any custom code, files, cmdlets, etc. into this directory. Please use `..\custom` for all custom implementation.
2+
This directory contains the cmdlets *exported by* `Az.Dashboard`. No other cmdlets in this repository are directly exported. What that means is the `Az.Dashboard` module will run [Export-ModuleMember](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/export-modulemember) on the cmldets in this directory. The cmdlets in this directory are generated at **build-time**. Do not put any custom code, files, cmdlets, etc. into this directory. Please use `..\custom` for all custom implementation.
33

44
## Info
55
- Modifiable: no

src/Dashboard/exports/Remove-AzGrafana.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ INPUTOBJECT <IDashboardIdentity>: Identity Parameter
4141
[SubscriptionId <String>]: The ID of the target subscription.
4242
[WorkspaceName <String>]: The workspace name of Azure Managed Grafana.
4343
.Link
44-
https://docs.microsoft.com/powershell/module/az.dashboard/remove-azgrafana
44+
https://learn.microsoft.com/powershell/module/az.dashboard/remove-azgrafana
4545
#>
4646
function Remove-AzGrafana {
4747
[OutputType([System.Boolean])]

src/Dashboard/exports/Update-AzGrafana.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ INPUTOBJECT <IDashboardIdentity>: Identity Parameter
4444
MONITORWORKSPACEINTEGRATION <IAzureMonitorWorkspaceIntegration[]>: The MonitorWorkspaceIntegration of Azure Managed Grafana.
4545
[AzureMonitorWorkspaceResourceId <String>]: The resource Id of the connected Azure Monitor Workspace.
4646
.Link
47-
https://docs.microsoft.com/powershell/module/az.dashboard/update-azgrafana
47+
https://learn.microsoft.com/powershell/module/az.dashboard/update-azgrafana
4848
#>
4949
function Update-AzGrafana {
5050
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana])]

src/Dashboard/generated/runtime/BuildTime/Models/PsHelpMarkdownOutputs.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ internal class ModulePageMetadataOutput
133133
{
134134
public PsModuleHelpInfo ModuleInfo { get; }
135135

136-
private static string HelpLinkPrefix { get; } = @"https://docs.microsoft.com/powershell/module/";
136+
private static string HelpLinkPrefix { get; } = @"https://learn.microsoft.com/powershell/module/";
137137

138138
public ModulePageMetadataOutput(PsModuleHelpInfo moduleInfo)
139139
{

src/Dashboard/generated/runtime/BuildTime/Models/PsProxyTypes.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ internal class CommentInfo
367367
public string OnlineVersion { get; }
368368
public string[] RelatedLinks { get; }
369369

370-
private const string HelpLinkPrefix = @"https://docs.microsoft.com/powershell/module/";
370+
private const string HelpLinkPrefix = @"https://learn.microsoft.com/powershell/module/";
371371

372372
public CommentInfo(VariantGroup variantGroup)
373373
{

src/Dashboard/help/Az.Dashboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
Module Name: Az.Dashboard
33
Module Guid: 8475f339-2250-485a-a9cc-aba350de72d2
4-
Download Help Link: https://docs.microsoft.com/powershell/module/az.dashboard
4+
Download Help Link: https://learn.microsoft.com/powershell/module/az.dashboard
55
Help Version: 1.0.0.0
66
Locale: en-US
77
---

src/Dashboard/help/Get-AzGrafana.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file:
33
Module Name: Az.Dashboard
4-
online version: https://docs.microsoft.com/powershell/module/az.dashboard/get-azgrafana
4+
online version: https://learn.microsoft.com/powershell/module/az.dashboard/get-azgrafana
55
schema: 2.0.0
66
---
77

src/Dashboard/help/New-AzGrafana.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file:
33
Module Name: Az.Dashboard
4-
online version: https://docs.microsoft.com/powershell/module/az.dashboard/new-azgrafana
4+
online version: https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafana
55
schema: 2.0.0
66
---
77

src/Dashboard/help/New-AzGrafanaMonitorWorkspaceIntegrationObject.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file:
33
Module Name: Az.Dashboard
4-
online version: https://docs.microsoft.com/powershell/module/az.dashboard/new-azgrafanamonitorworkspaceintegrationobject
4+
online version: https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafanamonitorworkspaceintegrationobject
55
schema: 2.0.0
66
---
77

src/Dashboard/help/Remove-AzGrafana.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file:
33
Module Name: Az.Dashboard
4-
online version: https://docs.microsoft.com/powershell/module/az.dashboard/remove-azgrafana
4+
online version: https://learn.microsoft.com/powershell/module/az.dashboard/remove-azgrafana
55
schema: 2.0.0
66
---
77

src/Dashboard/help/Update-AzGrafana.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file:
33
Module Name: Az.Dashboard
4-
online version: https://docs.microsoft.com/powershell/module/az.dashboard/update-azgrafana
4+
online version: https://learn.microsoft.com/powershell/module/az.dashboard/update-azgrafana
55
schema: 2.0.0
66
---
77

src/Dashboard/how-to.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module.
1414
To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [README.md](examples/README.md) in the `examples` folder.
1515

1616
## Packing `Az.Dashboard`
17-
To pack `Az.Dashboard` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://docs.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team.
17+
To pack `Az.Dashboard` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://learn.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team.
1818

1919
## Module Script Details
2020
There are multiple scripts created for performing different actions for developing `Az.Dashboard`.

src/Dashboard/internal/Get-AzGrafanaOperation.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ List all available API operations provided by Microsoft.Dashboard.
2727
.Outputs
2828
Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api30.IOperation
2929
.Link
30-
https://docs.microsoft.com/powershell/module/az.dashboard/get-azgrafanaoperation
30+
https://learn.microsoft.com/powershell/module/az.dashboard/get-azgrafanaoperation
3131
#>
3232
function Get-AzGrafanaOperation {
3333
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api30.IOperation])]

src/Dashboard/internal/New-AzGrafana.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To create the parameters described below, construct a hash table containing the
3434
MONITORWORKSPACEINTEGRATION <IAzureMonitorWorkspaceIntegration[]>: The MonitorWorkspaceIntegration of Azure Managed Grafana.
3535
[AzureMonitorWorkspaceResourceId <String>]: The resource Id of the connected Azure Monitor Workspace.
3636
.Link
37-
https://docs.microsoft.com/powershell/module/az.dashboard/new-azgrafana
37+
https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafana
3838
#>
3939
function New-AzGrafana {
4040
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana])]

src/Dashboard/internal/ProxyCmdletDefinitions.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ List all available API operations provided by Microsoft.Dashboard.
2727
.Outputs
2828
Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api30.IOperation
2929
.Link
30-
https://docs.microsoft.com/powershell/module/az.dashboard/get-azgrafanaoperation
30+
https://learn.microsoft.com/powershell/module/az.dashboard/get-azgrafanaoperation
3131
#>
3232
function Get-AzGrafanaOperation {
3333
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api30.IOperation])]
@@ -143,7 +143,7 @@ To create the parameters described below, construct a hash table containing the
143143
MONITORWORKSPACEINTEGRATION <IAzureMonitorWorkspaceIntegration[]>: The MonitorWorkspaceIntegration of Azure Managed Grafana.
144144
[AzureMonitorWorkspaceResourceId <String>]: The resource Id of the connected Azure Monitor Workspace.
145145
.Link
146-
https://docs.microsoft.com/powershell/module/az.dashboard/new-azgrafana
146+
https://learn.microsoft.com/powershell/module/az.dashboard/new-azgrafana
147147
#>
148148
function New-AzGrafana {
149149
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Dashboard.Models.Api20220801.IManagedGrafana])]

src/Dashboard/internal/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that
88
- Packaged: yes
99

1010
## Details
11-
The `Az.Dashboard.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.Dashboard`. Instead, this sub-module is imported by the `..\custom\Az.Dashboard.custom.psm1` module, allowing you to use hidden cmdlets in your custom, exposed cmdlets. To call these cmdlets in your custom scripts, simply use [module-qualified calls](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_command_precedence?view=powershell-6#qualified-names). For example, `Az.Dashboard.internal\Get-Example` would call an internal cmdlet named `Get-Example`.
11+
The `Az.Dashboard.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.Dashboard`. Instead, this sub-module is imported by the `..\custom\Az.Dashboard.custom.psm1` module, allowing you to use hidden cmdlets in your custom, exposed cmdlets. To call these cmdlets in your custom scripts, simply use [module-qualified calls](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_command_precedence?view=powershell-6#qualified-names). For example, `Az.Dashboard.internal\Get-Example` would call an internal cmdlet named `Get-Example`.
1212

1313
## Purpose
1414
This allows you to include REST specifications for services that you *do not wish to expose from your module*, but simply want to call within custom cmdlets. For example, if you want to make a custom cmdlet that uses `Storage` services, you could include a simplified `Storage` REST specification that has only the operations you need. When you run the generator and build this module, note the generated `Storage` cmdlets. Then, in your readme configuration, use [cmdlet hiding](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md#cmdlet-hiding-exportation-suppression) on the `Storage` cmdlets and they will *only be exposed to the custom cmdlets* you want to write, and not be exported as part of `Az.Dashboard`.

src/DataBox/Az.DataBox.psm1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
}
3434

3535
if(-not $accountsModule) {
36-
Write-Error "`nThis module requires $accountsName version 2.2.3 or greater. For installation instructions, please see: https://docs.microsoft.com/powershell/azure/install-az-ps" -ErrorAction Stop
36+
Write-Error "`nThis module requires $accountsName version 2.2.3 or greater. For installation instructions, please see: https://learn.microsoft.com/powershell/azure/install-az-ps" -ErrorAction Stop
3737
} elseif (($accountsModule.Version -lt [System.Version]'2.2.3') -and (-not $localAccounts)) {
3838
Write-Error "`nThis module requires $accountsName version 2.2.3 or greater. An earlier version of Az.Accounts is imported in the current PowerShell session. If you are running test, please try to add the switch '-RegenerateSupportModule' when executing 'test-module.ps1'. Otherwise please open a new PowerShell session and import this module again.`nAdditionally, this error could indicate that multiple incompatible versions of Azure PowerShell modules are installed on your system. For troubleshooting information, please see: https://aka.ms/azps-version-error" -ErrorAction Stop
3939
}

0 commit comments

Comments
 (0)