diff --git a/documentation/announcing-az-module.md b/documentation/announcing-az-module.md index 0a9bf18a5c24..3ce61c0d06d8 100644 --- a/documentation/announcing-az-module.md +++ b/documentation/announcing-az-module.md @@ -173,7 +173,7 @@ Az and AzureRM cannot be imported side-by-side into the same PowerShell session. - Install Az and AzureRM side-by-side in Windows PowerShell and ensure scripts do not mix the modules #### Install Az in PowerShell 7 -You can follow the instructions in [Installing PowerShell 7 on Windows](https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-windows +You can follow the instructions in [Installing PowerShell 7 on Windows](https://learn.microsoft.com/powershell/scripting/install/installing-powershell-core-on-windows ) to install PowerShell 7, then use ```Install-Module Az``` in PowerShell 7 to acquire the Az module. Since Windows PowerShell and PowerShell 7 can exist side-by-side and do not share module directories, this will effectively isolate the two modules. #### Install Az and AzureRM Side-by-Side diff --git a/documentation/development-docs/using-config-framework.md b/documentation/development-docs/using-config-framework.md index 74a408c1c618..dfc22205b30c 100644 --- a/documentation/development-docs/using-config-framework.md +++ b/documentation/development-docs/using-config-framework.md @@ -17,7 +17,7 @@ The config framework was introduced in Az 8, May 2022 to set up a standard of how configs are used by both developers and end users of Azure PowerShell. -This document will go over two most common scenarios for developers. As for how to use the config framework in PowerShell please refer to [Update-AzConfig](https://docs.microsoft.com/powershell/module/az.accounts/update-azconfig). +This document will go over two most common scenarios for developers. As for how to use the config framework in PowerShell please refer to [Update-AzConfig](https://learn.microsoft.com/powershell/module/az.accounts/update-azconfig). ## Guide: How to Add a New Config diff --git a/src/ApplicationInsights/Az.ApplicationInsights.psm1 b/src/ApplicationInsights/Az.ApplicationInsights.psm1 index 290d92635c35..f4d0f233bbd4 100644 --- a/src/ApplicationInsights/Az.ApplicationInsights.psm1 +++ b/src/ApplicationInsights/Az.ApplicationInsights.psm1 @@ -33,7 +33,7 @@ } if(-not $accountsModule) { - 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 + 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 } elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) { 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 } diff --git a/src/ApplicationInsights/custom/README.md b/src/ApplicationInsights/custom/README.md index 618e5ec73008..06c36c0b77c6 100644 --- a/src/ApplicationInsights/custom/README.md +++ b/src/ApplicationInsights/custom/README.md @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s ### Attributes For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.DescriptionAttribute` - - 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. + - 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. - `Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.ApplicationInsights`. - `Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.InternalExportAttribute` diff --git a/src/ApplicationInsights/exports/README.md b/src/ApplicationInsights/exports/README.md index cc3ad992af93..d8473f03c8e5 100644 --- a/src/ApplicationInsights/exports/README.md +++ b/src/ApplicationInsights/exports/README.md @@ -1,5 +1,5 @@ # Exports -This directory contains the cmdlets *exported by* `Az.ApplicationInsights`. No other cmdlets in this repository are directly exported. What that means is the `Az.ApplicationInsights` 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. +This directory contains the cmdlets *exported by* `Az.ApplicationInsights`. No other cmdlets in this repository are directly exported. What that means is the `Az.ApplicationInsights` 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. ## Info - Modifiable: no diff --git a/src/ApplicationInsights/how-to.md b/src/ApplicationInsights/how-to.md index cd740226a984..736bf259c995 100644 --- a/src/ApplicationInsights/how-to.md +++ b/src/ApplicationInsights/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. 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. ## Packing `Az.ApplicationInsights` -To pack `Az.ApplicationInsights` 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. +To pack `Az.ApplicationInsights` 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. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.ApplicationInsights`. diff --git a/src/ApplicationInsights/internal/README.md b/src/ApplicationInsights/internal/README.md index 77829e2688c6..e8f378bb8025 100644 --- a/src/ApplicationInsights/internal/README.md +++ b/src/ApplicationInsights/internal/README.md @@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that - Packaged: yes ## Details -The `Az.ApplicationInsights.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.ApplicationInsights`. Instead, this sub-module is imported by the `..\custom\Az.ApplicationInsights.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.ApplicationInsights.internal\Get-Example` would call an internal cmdlet named `Get-Example`. +The `Az.ApplicationInsights.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.ApplicationInsights`. Instead, this sub-module is imported by the `..\custom\Az.ApplicationInsights.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.ApplicationInsights.internal\Get-Example` would call an internal cmdlet named `Get-Example`. ## Purpose 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.ApplicationInsights`. diff --git a/src/BillingBenefits/Az.BillingBenefits.psm1 b/src/BillingBenefits/Az.BillingBenefits.psm1 index b5477ae387b8..90962c16830e 100644 --- a/src/BillingBenefits/Az.BillingBenefits.psm1 +++ b/src/BillingBenefits/Az.BillingBenefits.psm1 @@ -33,7 +33,7 @@ } if(-not $accountsModule) { - 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 + 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 } elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) { 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 } diff --git a/src/BillingBenefits/custom/README.md b/src/BillingBenefits/custom/README.md index 33d14738ec0a..476ec7d28965 100644 --- a/src/BillingBenefits/custom/README.md +++ b/src/BillingBenefits/custom/README.md @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s ### Attributes For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.DescriptionAttribute` - - 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. + - 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. - `Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.BillingBenefits`. - `Microsoft.Azure.PowerShell.Cmdlets.BillingBenefits.InternalExportAttribute` diff --git a/src/BillingBenefits/exports/README.md b/src/BillingBenefits/exports/README.md index 1e24c0f1a169..d76b56537304 100644 --- a/src/BillingBenefits/exports/README.md +++ b/src/BillingBenefits/exports/README.md @@ -1,5 +1,5 @@ # Exports -This directory contains the cmdlets *exported by* `Az.BillingBenefits`. No other cmdlets in this repository are directly exported. What that means is the `Az.BillingBenefits` 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. +This directory contains the cmdlets *exported by* `Az.BillingBenefits`. No other cmdlets in this repository are directly exported. What that means is the `Az.BillingBenefits` 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. ## Info - Modifiable: no diff --git a/src/BillingBenefits/how-to.md b/src/BillingBenefits/how-to.md index 121da6ac764e..36af20feb084 100644 --- a/src/BillingBenefits/how-to.md +++ b/src/BillingBenefits/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. 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. ## Packing `Az.BillingBenefits` -To pack `Az.BillingBenefits` 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. +To pack `Az.BillingBenefits` 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. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.BillingBenefits`. diff --git a/src/BillingBenefits/internal/README.md b/src/BillingBenefits/internal/README.md index bcf15aa42af5..360824a443bb 100644 --- a/src/BillingBenefits/internal/README.md +++ b/src/BillingBenefits/internal/README.md @@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that - Packaged: yes ## Details -The `Az.BillingBenefits.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.BillingBenefits`. Instead, this sub-module is imported by the `..\custom\Az.BillingBenefits.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.BillingBenefits.internal\Get-Example` would call an internal cmdlet named `Get-Example`. +The `Az.BillingBenefits.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.BillingBenefits`. Instead, this sub-module is imported by the `..\custom\Az.BillingBenefits.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.BillingBenefits.internal\Get-Example` would call an internal cmdlet named `Get-Example`. ## Purpose 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.BillingBenefits`. diff --git a/src/Compute/Compute.Autorest/Az.Compute.psm1 b/src/Compute/Compute.Autorest/Az.Compute.psm1 index 67dc918911e9..051b2c02cb57 100644 --- a/src/Compute/Compute.Autorest/Az.Compute.psm1 +++ b/src/Compute/Compute.Autorest/Az.Compute.psm1 @@ -33,7 +33,7 @@ } if(-not $accountsModule) { - 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 + 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 } elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) { 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 } diff --git a/src/Compute/Compute.Autorest/custom/README.md b/src/Compute/Compute.Autorest/custom/README.md index 1d30d30494cc..6979482c7799 100644 --- a/src/Compute/Compute.Autorest/custom/README.md +++ b/src/Compute/Compute.Autorest/custom/README.md @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s ### Attributes For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.Compute.DescriptionAttribute` - - 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. + - 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. - `Microsoft.Azure.PowerShell.Cmdlets.Compute.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.Compute`. - `Microsoft.Azure.PowerShell.Cmdlets.Compute.InternalExportAttribute` diff --git a/src/Compute/Compute.Autorest/docs/README.md b/src/Compute/Compute.Autorest/docs/README.md index 6a2aa34d6f94..7eba82a643bf 100644 --- a/src/Compute/Compute.Autorest/docs/README.md +++ b/src/Compute/Compute.Autorest/docs/README.md @@ -8,4 +8,4 @@ This directory contains the documentation of the cmdlets for the `Az.Compute` mo - Packaged: yes ## Details -The process of documentation generation loads `Az.Compute` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder. \ No newline at end of file +The process of documentation generation loads `Az.Compute` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder. \ No newline at end of file diff --git a/src/Compute/Compute.Autorest/exports/README.md b/src/Compute/Compute.Autorest/exports/README.md index 70952d3c9947..8e8766e439c4 100644 --- a/src/Compute/Compute.Autorest/exports/README.md +++ b/src/Compute/Compute.Autorest/exports/README.md @@ -1,5 +1,5 @@ # Exports -This directory contains the cmdlets *exported by* `Az.Compute`. No other cmdlets in this repository are directly exported. What that means is the `Az.Compute` 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. +This directory contains the cmdlets *exported by* `Az.Compute`. No other cmdlets in this repository are directly exported. What that means is the `Az.Compute` 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. ## Info - Modifiable: no diff --git a/src/Compute/Compute.Autorest/how-to.md b/src/Compute/Compute.Autorest/how-to.md index 7b0ea7d480d4..865fb53fe262 100644 --- a/src/Compute/Compute.Autorest/how-to.md +++ b/src/Compute/Compute.Autorest/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. 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. ## Packing `Az.Compute` -To pack `Az.Compute` 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. +To pack `Az.Compute` 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. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.Compute`. diff --git a/src/Compute/Compute.Autorest/internal/README.md b/src/Compute/Compute.Autorest/internal/README.md index 941a199792a0..b2cc5ed24e15 100644 --- a/src/Compute/Compute.Autorest/internal/README.md +++ b/src/Compute/Compute.Autorest/internal/README.md @@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that - Packaged: yes ## Details -The `Az.Compute.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.Compute`. Instead, this sub-module is imported by the `..\custom\Az.Compute.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.Compute.internal\Get-Example` would call an internal cmdlet named `Get-Example`. +The `Az.Compute.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.Compute`. Instead, this sub-module is imported by the `..\custom\Az.Compute.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.Compute.internal\Get-Example` would call an internal cmdlet named `Get-Example`. ## Purpose 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.Compute`. diff --git a/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRoleDefinition.md b/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRoleDefinition.md index 20a1ec46e3d0..b4c7f41ab8f8 100644 --- a/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRoleDefinition.md +++ b/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBRoleDefinition.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbroledefinition +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbroledefinition schema: 2.0.0 --- diff --git a/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBUserDefinition.md b/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBUserDefinition.md index 7b892aa535f8..f6d0e17b05ba 100644 --- a/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBUserDefinition.md +++ b/src/CosmosDB/CosmosDB/help/Get-AzCosmosDBMongoDBUserDefinition.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbuserdefinition +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbmongodbuserdefinition schema: 2.0.0 --- diff --git a/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilege.md b/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilege.md index eeaa2d76533c..f3873001db6b 100644 --- a/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilege.md +++ b/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilege.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbprivilege +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbprivilege schema: 2.0.0 --- diff --git a/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilegeResource.md b/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilegeResource.md index 96d551cfef43..b70441e8452d 100644 --- a/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilegeResource.md +++ b/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBPrivilegeResource.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbprivilegeresource +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbprivilegeresource schema: 2.0.0 --- diff --git a/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRole.md b/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRole.md index b8381c8833d7..be4089d339a5 100644 --- a/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRole.md +++ b/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRole.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbrole +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbrole schema: 2.0.0 --- diff --git a/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRoleDefinition.md b/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRoleDefinition.md index 406ee1e16c6f..5aebe1efdeaa 100644 --- a/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRoleDefinition.md +++ b/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBRoleDefinition.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbroledefinition +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbroledefinition schema: 2.0.0 --- diff --git a/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBUserDefinition.md b/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBUserDefinition.md index 4f258ffcb7ad..786d03cae069 100644 --- a/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBUserDefinition.md +++ b/src/CosmosDB/CosmosDB/help/New-AzCosmosDBMongoDBUserDefinition.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbuserdefinition +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/new-azcosmosdbmongodbuserdefinition schema: 2.0.0 --- diff --git a/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBRoleDefinition.md b/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBRoleDefinition.md index 54c8a5b06638..0a52bde81dcc 100644 --- a/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBRoleDefinition.md +++ b/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBRoleDefinition.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbmongodbroledefinition +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbmongodbroledefinition schema: 2.0.0 --- diff --git a/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBUserDefinition.md b/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBUserDefinition.md index 43a2ce6782b2..d57cf189737f 100644 --- a/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBUserDefinition.md +++ b/src/CosmosDB/CosmosDB/help/Remove-AzCosmosDBMongoDBUserDefinition.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbmongodbuserdefinition +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbmongodbuserdefinition schema: 2.0.0 --- diff --git a/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBRoleDefinition.md b/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBRoleDefinition.md index 9242e6e3cd89..2edd5dfc7030 100644 --- a/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBRoleDefinition.md +++ b/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBRoleDefinition.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbmongodbroledefinition +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbmongodbroledefinition schema: 2.0.0 --- diff --git a/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBUserDefinition.md b/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBUserDefinition.md index a8fdd2e3e03e..dc9c4ae51a9b 100644 --- a/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBUserDefinition.md +++ b/src/CosmosDB/CosmosDB/help/Update-AzCosmosDBMongoDBUserDefinition.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml Module Name: Az.CosmosDB -online version: https://docs.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbmongodbuserdefinition +online version: https://learn.microsoft.com/powershell/module/az.cosmosdb/update-azcosmosdbmongodbuserdefinition schema: 2.0.0 --- diff --git a/src/DataProtection/Az.DataProtection.psm1 b/src/DataProtection/Az.DataProtection.psm1 index c2b95760209c..e032a9f20cd5 100644 --- a/src/DataProtection/Az.DataProtection.psm1 +++ b/src/DataProtection/Az.DataProtection.psm1 @@ -33,7 +33,7 @@ } if(-not $accountsModule) { - 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 + 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 } elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) { 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 } diff --git a/src/DataProtection/custom/README.md b/src/DataProtection/custom/README.md index 9217867c6e17..17a6bdafb9b4 100644 --- a/src/DataProtection/custom/README.md +++ b/src/DataProtection/custom/README.md @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s ### Attributes For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.DataProtection.DescriptionAttribute` - - 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. + - 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. - `Microsoft.Azure.PowerShell.Cmdlets.DataProtection.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.DataProtection`. - `Microsoft.Azure.PowerShell.Cmdlets.DataProtection.InternalExportAttribute` diff --git a/src/DataProtection/exports/README.md b/src/DataProtection/exports/README.md index 260542140201..e67d18735c54 100644 --- a/src/DataProtection/exports/README.md +++ b/src/DataProtection/exports/README.md @@ -1,5 +1,5 @@ # Exports -This directory contains the cmdlets *exported by* `Az.DataProtection`. No other cmdlets in this repository are directly exported. What that means is the `Az.DataProtection` 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. +This directory contains the cmdlets *exported by* `Az.DataProtection`. No other cmdlets in this repository are directly exported. What that means is the `Az.DataProtection` 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. ## Info - Modifiable: no diff --git a/src/DataProtection/how-to.md b/src/DataProtection/how-to.md index 11d2ec93efaf..6053655476d9 100644 --- a/src/DataProtection/how-to.md +++ b/src/DataProtection/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. 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. ## Packing `Az.DataProtection` -To pack `Az.DataProtection` 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. +To pack `Az.DataProtection` 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. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.DataProtection`. diff --git a/src/DataProtection/internal/README.md b/src/DataProtection/internal/README.md index 038a83ffc864..dd2ffb358cae 100644 --- a/src/DataProtection/internal/README.md +++ b/src/DataProtection/internal/README.md @@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that - Packaged: yes ## Details -The `Az.DataProtection.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.DataProtection`. Instead, this sub-module is imported by the `..\custom\Az.DataProtection.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.DataProtection.internal\Get-Example` would call an internal cmdlet named `Get-Example`. +The `Az.DataProtection.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.DataProtection`. Instead, this sub-module is imported by the `..\custom\Az.DataProtection.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.DataProtection.internal\Get-Example` would call an internal cmdlet named `Get-Example`. ## Purpose 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.DataProtection`. diff --git a/src/DigitalTwins/Az.DigitalTwins.psm1 b/src/DigitalTwins/Az.DigitalTwins.psm1 index fdb9175bd8a9..4174e35f6e57 100644 --- a/src/DigitalTwins/Az.DigitalTwins.psm1 +++ b/src/DigitalTwins/Az.DigitalTwins.psm1 @@ -33,7 +33,7 @@ } if(-not $accountsModule) { - 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 + 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 } elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) { 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 } diff --git a/src/DigitalTwins/custom/README.md b/src/DigitalTwins/custom/README.md index d4216be2d479..b1749c0d99bc 100644 --- a/src/DigitalTwins/custom/README.md +++ b/src/DigitalTwins/custom/README.md @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s ### Attributes For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.DescriptionAttribute` - - 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. + - 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. - `Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.DigitalTwins`. - `Microsoft.Azure.PowerShell.Cmdlets.DigitalTwins.InternalExportAttribute` diff --git a/src/DigitalTwins/exports/README.md b/src/DigitalTwins/exports/README.md index c23559c1e7d8..d7812a65e700 100644 --- a/src/DigitalTwins/exports/README.md +++ b/src/DigitalTwins/exports/README.md @@ -1,5 +1,5 @@ # Exports -This directory contains the cmdlets *exported by* `Az.DigitalTwins`. No other cmdlets in this repository are directly exported. What that means is the `Az.DigitalTwins` 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. +This directory contains the cmdlets *exported by* `Az.DigitalTwins`. No other cmdlets in this repository are directly exported. What that means is the `Az.DigitalTwins` 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. ## Info - Modifiable: no diff --git a/src/DigitalTwins/how-to.md b/src/DigitalTwins/how-to.md index 88e0db76ec96..7e2476431510 100644 --- a/src/DigitalTwins/how-to.md +++ b/src/DigitalTwins/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. 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. ## Packing `Az.DigitalTwins` -To pack `Az.DigitalTwins` 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. +To pack `Az.DigitalTwins` 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. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.DigitalTwins`. diff --git a/src/DigitalTwins/internal/README.md b/src/DigitalTwins/internal/README.md index 127e225e602c..e55ff5470b6e 100644 --- a/src/DigitalTwins/internal/README.md +++ b/src/DigitalTwins/internal/README.md @@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that - Packaged: yes ## Details -The `Az.DigitalTwins.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.DigitalTwins`. Instead, this sub-module is imported by the `..\custom\Az.DigitalTwins.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.DigitalTwins.internal\Get-Example` would call an internal cmdlet named `Get-Example`. +The `Az.DigitalTwins.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.DigitalTwins`. Instead, this sub-module is imported by the `..\custom\Az.DigitalTwins.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.DigitalTwins.internal\Get-Example` would call an internal cmdlet named `Get-Example`. ## Purpose 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.DigitalTwins`. diff --git a/src/LoadTesting/Az.LoadTesting.psm1 b/src/LoadTesting/Az.LoadTesting.psm1 index 1899cf9d5a41..e0990825f28c 100644 --- a/src/LoadTesting/Az.LoadTesting.psm1 +++ b/src/LoadTesting/Az.LoadTesting.psm1 @@ -33,7 +33,7 @@ } if(-not $accountsModule) { - 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 + 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 } elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) { 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 } diff --git a/src/LoadTesting/custom/README.md b/src/LoadTesting/custom/README.md index 35fd9a5da905..bf6a99a602d4 100644 --- a/src/LoadTesting/custom/README.md +++ b/src/LoadTesting/custom/README.md @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s ### Attributes For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.LoadTesting.DescriptionAttribute` - - 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. + - 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. - `Microsoft.Azure.PowerShell.Cmdlets.LoadTesting.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.LoadTesting`. - `Microsoft.Azure.PowerShell.Cmdlets.LoadTesting.InternalExportAttribute` diff --git a/src/LoadTesting/exports/README.md b/src/LoadTesting/exports/README.md index 6edf7ea64cc7..fe651bb22a3d 100644 --- a/src/LoadTesting/exports/README.md +++ b/src/LoadTesting/exports/README.md @@ -1,5 +1,5 @@ # Exports -This directory contains the cmdlets *exported by* `Az.LoadTesting`. No other cmdlets in this repository are directly exported. What that means is the `Az.LoadTesting` 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. +This directory contains the cmdlets *exported by* `Az.LoadTesting`. No other cmdlets in this repository are directly exported. What that means is the `Az.LoadTesting` 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. ## Info - Modifiable: no diff --git a/src/LoadTesting/how-to.md b/src/LoadTesting/how-to.md index aaa2bf8c0879..fcd42d8a2294 100644 --- a/src/LoadTesting/how-to.md +++ b/src/LoadTesting/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. 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. ## Packing `Az.LoadTesting` -To pack `Az.LoadTesting` 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. +To pack `Az.LoadTesting` 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. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.LoadTesting`. diff --git a/src/LoadTesting/internal/README.md b/src/LoadTesting/internal/README.md index a4aa214604f9..561264f06905 100644 --- a/src/LoadTesting/internal/README.md +++ b/src/LoadTesting/internal/README.md @@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that - Packaged: yes ## Details -The `Az.LoadTesting.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.LoadTesting`. Instead, this sub-module is imported by the `..\custom\Az.LoadTesting.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.LoadTesting.internal\Get-Example` would call an internal cmdlet named `Get-Example`. +The `Az.LoadTesting.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.LoadTesting`. Instead, this sub-module is imported by the `..\custom\Az.LoadTesting.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.LoadTesting.internal\Get-Example` would call an internal cmdlet named `Get-Example`. ## Purpose 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.LoadTesting`. diff --git a/src/MobileNetwork/Az.MobileNetwork.psm1 b/src/MobileNetwork/Az.MobileNetwork.psm1 index 323a388bf9ed..5ac47fb5f892 100644 --- a/src/MobileNetwork/Az.MobileNetwork.psm1 +++ b/src/MobileNetwork/Az.MobileNetwork.psm1 @@ -33,7 +33,7 @@ } if(-not $accountsModule) { - 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 + 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 } elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) { 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 } diff --git a/src/MobileNetwork/custom/README.md b/src/MobileNetwork/custom/README.md index e7575b88a5aa..4f8513791820 100644 --- a/src/MobileNetwork/custom/README.md +++ b/src/MobileNetwork/custom/README.md @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s ### Attributes For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.DescriptionAttribute` - - 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. + - 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. - `Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.MobileNetwork`. - `Microsoft.Azure.PowerShell.Cmdlets.MobileNetwork.InternalExportAttribute` diff --git a/src/MobileNetwork/exports/README.md b/src/MobileNetwork/exports/README.md index b4708a862a3a..f200e0ef970c 100644 --- a/src/MobileNetwork/exports/README.md +++ b/src/MobileNetwork/exports/README.md @@ -1,5 +1,5 @@ # Exports -This directory contains the cmdlets *exported by* `Az.MobileNetwork`. No other cmdlets in this repository are directly exported. What that means is the `Az.MobileNetwork` 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. +This directory contains the cmdlets *exported by* `Az.MobileNetwork`. No other cmdlets in this repository are directly exported. What that means is the `Az.MobileNetwork` 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. ## Info - Modifiable: no diff --git a/src/MobileNetwork/how-to.md b/src/MobileNetwork/how-to.md index 4b496ab8244c..8110192e13b6 100644 --- a/src/MobileNetwork/how-to.md +++ b/src/MobileNetwork/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. 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. ## Packing `Az.MobileNetwork` -To pack `Az.MobileNetwork` 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. +To pack `Az.MobileNetwork` 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. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.MobileNetwork`. diff --git a/src/MobileNetwork/internal/README.md b/src/MobileNetwork/internal/README.md index d8a37ff13bbc..3c45f2737cb8 100644 --- a/src/MobileNetwork/internal/README.md +++ b/src/MobileNetwork/internal/README.md @@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that - Packaged: yes ## Details -The `Az.MobileNetwork.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.MobileNetwork`. Instead, this sub-module is imported by the `..\custom\Az.MobileNetwork.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.MobileNetwork.internal\Get-Example` would call an internal cmdlet named `Get-Example`. +The `Az.MobileNetwork.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.MobileNetwork`. Instead, this sub-module is imported by the `..\custom\Az.MobileNetwork.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.MobileNetwork.internal\Get-Example` would call an internal cmdlet named `Get-Example`. ## Purpose 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.MobileNetwork`. diff --git a/src/Monitor/Monitor/help/Test-AzActionGroup.md b/src/Monitor/Monitor/help/Test-AzActionGroup.md index be849cf47485..8ccaf9a87bf6 100644 --- a/src/Monitor/Monitor/help/Test-AzActionGroup.md +++ b/src/Monitor/Monitor/help/Test-AzActionGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.Monitor.dll-Help.xml Module Name: Az.Monitor -online version: https://docs.microsoft.com/powershell/module/az.monitor/test-azactiongroup +online version: https://learn.microsoft.com/powershell/module/az.monitor/test-azactiongroup schema: 2.0.0 --- diff --git a/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeQuotaRule.md b/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeQuotaRule.md index 2884cf3e6e76..5378483c4269 100644 --- a/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeQuotaRule.md +++ b/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeQuotaRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml Module Name: Az.NetAppFiles -online version: https://docs.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesvolumequotarule +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesvolumequotarule schema: 2.0.0 --- diff --git a/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeReplication.md b/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeReplication.md index 15997a5e2cf2..8649d54b8575 100644 --- a/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeReplication.md +++ b/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesVolumeReplication.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml Module Name: Az.NetAppFiles -online version: https://docs.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesvolumereplication +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/get-aznetappfilesvolumereplication schema: 2.0.0 --- diff --git a/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesVolumeQuotaRule.md b/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesVolumeQuotaRule.md index 779b4865fd28..67319bc3127b 100644 --- a/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesVolumeQuotaRule.md +++ b/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesVolumeQuotaRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml Module Name: Az.NetAppFiles -online version: https://docs.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesvolumequotarule +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/new-aznetappfilesvolumequotarule schema: 2.0.0 --- diff --git a/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesVolumeQuotaRule.md b/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesVolumeQuotaRule.md index dcec67682e1f..5e915867e06f 100644 --- a/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesVolumeQuotaRule.md +++ b/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesVolumeQuotaRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml Module Name: Az.NetAppFiles -online version: https://docs.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilesvolumequotarule +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/remove-aznetappfilesvolumequotarule schema: 2.0.0 --- diff --git a/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesVolumeQuotaRule.md b/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesVolumeQuotaRule.md index 37b54e033208..1616ce7d33da 100644 --- a/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesVolumeQuotaRule.md +++ b/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesVolumeQuotaRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml Module Name: Az.NetAppFiles -online version: https://docs.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilesvolumequotarule +online version: https://learn.microsoft.com/powershell/module/az.netappfiles/update-aznetappfilesvolumequotarule schema: 2.0.0 --- diff --git a/src/Peering/Az.Peering.psm1 b/src/Peering/Az.Peering.psm1 index f3db634a5816..168f5d4498b2 100644 --- a/src/Peering/Az.Peering.psm1 +++ b/src/Peering/Az.Peering.psm1 @@ -33,7 +33,7 @@ } if(-not $accountsModule) { - 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 + 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 } elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) { 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 } diff --git a/src/Peering/custom/README.md b/src/Peering/custom/README.md index ec560a23208e..65b506011900 100644 --- a/src/Peering/custom/README.md +++ b/src/Peering/custom/README.md @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s ### Attributes For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.Peering.DescriptionAttribute` - - 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. + - 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. - `Microsoft.Azure.PowerShell.Cmdlets.Peering.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.Peering`. - `Microsoft.Azure.PowerShell.Cmdlets.Peering.InternalExportAttribute` diff --git a/src/Peering/exports/README.md b/src/Peering/exports/README.md index 3d63e42f4514..3431acbbbb8a 100644 --- a/src/Peering/exports/README.md +++ b/src/Peering/exports/README.md @@ -1,5 +1,5 @@ # Exports -This directory contains the cmdlets *exported by* `Az.Peering`. No other cmdlets in this repository are directly exported. What that means is the `Az.Peering` 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. +This directory contains the cmdlets *exported by* `Az.Peering`. No other cmdlets in this repository are directly exported. What that means is the `Az.Peering` 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. ## Info - Modifiable: no diff --git a/src/Peering/how-to.md b/src/Peering/how-to.md index deb294266da8..aa545b0e8b50 100644 --- a/src/Peering/how-to.md +++ b/src/Peering/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. 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. ## Packing `Az.Peering` -To pack `Az.Peering` 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. +To pack `Az.Peering` 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. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.Peering`. diff --git a/src/Peering/internal/README.md b/src/Peering/internal/README.md index cea0f0def498..1d3c2691d1a3 100644 --- a/src/Peering/internal/README.md +++ b/src/Peering/internal/README.md @@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that - Packaged: yes ## Details -The `Az.Peering.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.Peering`. Instead, this sub-module is imported by the `..\custom\Az.Peering.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.Peering.internal\Get-Example` would call an internal cmdlet named `Get-Example`. +The `Az.Peering.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.Peering`. Instead, this sub-module is imported by the `..\custom\Az.Peering.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.Peering.internal\Get-Example` would call an internal cmdlet named `Get-Example`. ## Purpose 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.Peering`. diff --git a/src/StackHCI/Az.StackHCI.psm1 b/src/StackHCI/Az.StackHCI.psm1 index 8351db4f372d..024b0701bbca 100644 --- a/src/StackHCI/Az.StackHCI.psm1 +++ b/src/StackHCI/Az.StackHCI.psm1 @@ -33,7 +33,7 @@ } if(-not $accountsModule) { - 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 + 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 } elseif (($accountsModule.Version -lt [System.Version]'2.7.5') -and (-not $localAccounts)) { 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 } diff --git a/src/StackHCI/custom/README.md b/src/StackHCI/custom/README.md index d32e6632589a..e9c24f15b5a4 100644 --- a/src/StackHCI/custom/README.md +++ b/src/StackHCI/custom/README.md @@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s ### Attributes For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.StackHCI.DescriptionAttribute` - - 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. + - 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. - `Microsoft.Azure.PowerShell.Cmdlets.StackHCI.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.StackHCI`. - `Microsoft.Azure.PowerShell.Cmdlets.StackHCI.InternalExportAttribute` diff --git a/src/StackHCI/exports/README.md b/src/StackHCI/exports/README.md index 6759a212e2ce..cfea9ca49b83 100644 --- a/src/StackHCI/exports/README.md +++ b/src/StackHCI/exports/README.md @@ -1,5 +1,5 @@ # Exports -This directory contains the cmdlets *exported by* `Az.StackHCI`. No other cmdlets in this repository are directly exported. What that means is the `Az.StackHCI` 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. +This directory contains the cmdlets *exported by* `Az.StackHCI`. No other cmdlets in this repository are directly exported. What that means is the `Az.StackHCI` 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. ## Info - Modifiable: no diff --git a/src/StackHCI/how-to.md b/src/StackHCI/how-to.md index 27cdfa3c726c..43c60d72a424 100644 --- a/src/StackHCI/how-to.md +++ b/src/StackHCI/how-to.md @@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module. 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. ## Packing `Az.StackHCI` -To pack `Az.StackHCI` 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. +To pack `Az.StackHCI` 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. ## Module Script Details There are multiple scripts created for performing different actions for developing `Az.StackHCI`. diff --git a/src/StackHCI/internal/README.md b/src/StackHCI/internal/README.md index 02c4ea3fb268..6ced9f965b49 100644 --- a/src/StackHCI/internal/README.md +++ b/src/StackHCI/internal/README.md @@ -8,7 +8,7 @@ This directory contains a module to handle *internal only* cmdlets. Cmdlets that - Packaged: yes ## Details -The `Az.StackHCI.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.StackHCI`. Instead, this sub-module is imported by the `..\custom\Az.StackHCI.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.StackHCI.internal\Get-Example` would call an internal cmdlet named `Get-Example`. +The `Az.StackHCI.internal.psm1` file is generated to this folder. This module file handles the hidden cmdlets. These cmdlets will not be exported by `Az.StackHCI`. Instead, this sub-module is imported by the `..\custom\Az.StackHCI.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.StackHCI.internal\Get-Example` would call an internal cmdlet named `Get-Example`. ## Purpose 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.StackHCI`. diff --git a/tools/Az/Az.psd1 b/tools/Az/Az.psd1 index 8abcb187cfc9..1dc1aeaaa505 100644 --- a/tools/Az/Az.psd1 +++ b/tools/Az/Az.psd1 @@ -31,7 +31,7 @@ Copyright = 'Microsoft Corporation. All rights reserved.' # Description of the functionality provided by this module Description = 'Microsoft Azure PowerShell - Cmdlets to manage resources in Azure. This module is compatible with PowerShell and Windows PowerShell. -For more information about the Az module, please visit the following: https://docs.microsoft.com/powershell/azure/' +For more information about the Az module, please visit the following: https://learn.microsoft.com/powershell/azure/' # Minimum version of the PowerShell engine required by this module PowerShellVersion = '5.1' diff --git a/tools/AzPreview.psd1.template b/tools/AzPreview.psd1.template index 5d908bb8c552..d534217c62a3 100644 --- a/tools/AzPreview.psd1.template +++ b/tools/AzPreview.psd1.template @@ -31,7 +31,7 @@ Copyright = 'Microsoft Corporation. All rights reserved.' # Description of the functionality provided by this module Description = 'Microsoft Azure PowerShell - Including stable version and preview version of Azure PowerShell modules. This module is compatible with PowerShell and Windows PowerShell. -For more information about the AzPreview module, please visit the following: https://docs.microsoft.com/powershell/azure/' +For more information about the AzPreview module, please visit the following: https://learn.microsoft.com/powershell/azure/' # Minimum version of the PowerShell engine required by this module PowerShellVersion = '5.1' diff --git a/tools/AzPreview/AzPreview.psd1 b/tools/AzPreview/AzPreview.psd1 index 3caf5d42cd85..570df5a2624e 100644 --- a/tools/AzPreview/AzPreview.psd1 +++ b/tools/AzPreview/AzPreview.psd1 @@ -31,7 +31,7 @@ Copyright = 'Microsoft Corporation. All rights reserved.' # Description of the functionality provided by this module Description = 'Microsoft Azure PowerShell - Including stable version and preview version of Azure PowerShell modules. This module is compatible with PowerShell and Windows PowerShell. -For more information about the AzPreview module, please visit the following: https://docs.microsoft.com/powershell/azure/' +For more information about the AzPreview module, please visit the following: https://learn.microsoft.com/powershell/azure/' # Minimum version of the PowerShell engine required by this module PowerShellVersion = '5.1' diff --git a/tools/Gen2Master/Templates/ModulePage.md b/tools/Gen2Master/Templates/ModulePage.md index 17c517fdb174..670488de8c3d 100644 --- a/tools/Gen2Master/Templates/ModulePage.md +++ b/tools/Gen2Master/Templates/ModulePage.md @@ -1,7 +1,7 @@ --- Module Name: Az.{ModuleNamePlaceHolder} Module Guid: {GUID} -Download Help Link: https://docs.microsoft.com/powershell/module/az.{LowCaseModuleNamePlaceHolder} +Download Help Link: https://learn.microsoft.com/powershell/module/az.{LowCaseModuleNamePlaceHolder} Help Version: 1.0.0.0 Locale: en-US --- diff --git a/tools/HelpGeneration/HelpGeneration.psm1 b/tools/HelpGeneration/HelpGeneration.psm1 index 0f819c86c241..8bd3eabe9054 100644 --- a/tools/HelpGeneration/HelpGeneration.psm1 +++ b/tools/HelpGeneration/HelpGeneration.psm1 @@ -225,7 +225,7 @@ function Test-AzMarkdownHelp } "online version:" { - $onlineString = "https://docs.microsoft.com/powershell/module/$($ModuleName.ToLower())/$($CmdletName.ToLower())" + $onlineString = "https://learn.microsoft.com/powershell/module/$($ModuleName.ToLower())/$($CmdletName.ToLower())" $split = $content[$idx] -split "online version:" if ([string]::IsNullOrWhiteSpace($split[1]) -or $split[1] -notlike "*$onlineString*") {