From 420d2668a0dadcd1dcd4f57c0cf5c8996392c4e1 Mon Sep 17 00:00:00 2001 From: German Robayo Paz Date: Fri, 7 Aug 2026 22:28:56 +0000 Subject: [PATCH 1/6] feat: onboard Az.AppNetwork PowerShell module for Microsoft.AppLink Generate the Az.AppNetwork module from the AppLink TypeSpec source (specification/applink/AppLink.Management, API 2025-08-01-preview) using the @azure-tools/typespec-powershell emitter via AzDev New-DevTSPModule. - Add AppLink and AppLinkMember CRUD cmdlets, plus AvailableVersion and UpgradeHistory list cmdlets. - Add AzPSConfig (tspconfig.yaml) with SubscriptionId default and variant pruning; hide the raw Operation cmdlet. - Add AppLink lifecycle e2e Pester tests (create/get/list/update/delete) with resource-group provisioning in test/utils.ps1. - Register the module in tools/CreateMappings_rules.json. Co-Authored-By: Claude Opus 4 (1M context) --- .../AppNetwork.Autorest/.gitattributes | 1 + src/AppNetwork/AppNetwork.Autorest/.gitignore | 16 + .../Properties/AssemblyInfo.cs | 29 ++ src/AppNetwork/AppNetwork.Autorest/README.md | 24 + .../appLinks-appLinkMembers.json | 95 ++++ .../UX/Microsoft.AppLink/appLinks.json | 85 ++++ .../custom/Az.AppNetwork.custom.psm1 | 17 + .../AppNetwork.Autorest/custom/README.md | 41 ++ .../AppNetwork.Autorest/docs/Az.AppNetwork.md | 49 +++ .../docs/Get-AzAppNetworkAppLink.md | 158 +++++++ .../docs/Get-AzAppNetworkAppLinkMember.md | 190 ++++++++ .../docs/Get-AzAppNetworkAvailableVersion.md | 123 ++++++ .../docs/Get-AzAppNetworkUpgradeHistory.md | 139 ++++++ .../docs/New-AzAppNetworkAppLink.md | 293 +++++++++++++ .../docs/New-AzAppNetworkAppLinkMember.md | 411 ++++++++++++++++++ .../AppNetwork.Autorest/docs/README.md | 11 + .../docs/Remove-AzAppNetworkAppLink.md | 224 ++++++++++ .../docs/Remove-AzAppNetworkAppLinkMember.md | 261 +++++++++++ .../docs/Set-AzAppNetworkAppLink.md | 293 +++++++++++++ .../docs/Set-AzAppNetworkAppLinkMember.md | 384 ++++++++++++++++ .../docs/Update-AzAppNetworkAppLink.md | 257 +++++++++++ .../docs/Update-AzAppNetworkAppLinkMember.md | 371 ++++++++++++++++ .../examples/Get-AzAppNetworkAppLink.md | 22 + .../examples/Get-AzAppNetworkAppLinkMember.md | 22 + .../Get-AzAppNetworkAvailableVersion.md | 22 + .../Get-AzAppNetworkUpgradeHistory.md | 22 + .../examples/New-AzAppNetworkAppLink.md | 22 + .../examples/New-AzAppNetworkAppLinkMember.md | 22 + .../examples/Remove-AzAppNetworkAppLink.md | 22 + .../Remove-AzAppNetworkAppLinkMember.md | 22 + .../examples/Set-AzAppNetworkAppLink.md | 22 + .../examples/Set-AzAppNetworkAppLinkMember.md | 22 + .../examples/Update-AzAppNetworkAppLink.md | 22 + .../Update-AzAppNetworkAppLinkMember.md | 22 + src/AppNetwork/AppNetwork.Autorest/how-to.md | 58 +++ .../AppNetwork.Autorest/resources/README.md | 11 + .../test/Get-AzAppNetworkAppLink.Tests.ps1 | 41 ++ .../Get-AzAppNetworkAppLinkMember.Tests.ps1 | 33 ++ ...Get-AzAppNetworkAvailableVersion.Tests.ps1 | 21 + .../Get-AzAppNetworkUpgradeHistory.Tests.ps1 | 21 + .../test/New-AzAppNetworkAppLink.Tests.ps1 | 34 ++ .../New-AzAppNetworkAppLinkMember.Tests.ps1 | 33 ++ .../AppNetwork.Autorest/test/README.md | 17 + .../test/Remove-AzAppNetworkAppLink.Tests.ps1 | 28 ++ ...Remove-AzAppNetworkAppLinkMember.Tests.ps1 | 29 ++ .../test/Set-AzAppNetworkAppLink.Tests.ps1 | 29 ++ .../Set-AzAppNetworkAppLinkMember.Tests.ps1 | 29 ++ .../test/Update-AzAppNetworkAppLink.Tests.ps1 | 28 ++ ...Update-AzAppNetworkAppLinkMember.Tests.ps1 | 37 ++ .../AppNetwork.Autorest/test/loadEnv.ps1 | 29 ++ .../AppNetwork.Autorest/test/utils.ps1 | 66 +++ .../AppNetwork.Autorest/tsp-location.yaml | 4 + .../AppNetwork.Autorest/tspconfig.yaml | 37 ++ .../utils/Get-SubscriptionIdTestSafe.ps1 | 7 + .../utils/Unprotect-SecureString.ps1 | 16 + src/AppNetwork/AppNetwork.sln | 74 ++++ src/AppNetwork/AppNetwork/AppNetwork.csproj | 28 ++ src/AppNetwork/AppNetwork/Az.AppNetwork.psd1 | 138 ++++++ src/AppNetwork/AppNetwork/ChangeLog.md | 28 ++ .../AppNetwork/Properties/AssemblyInfo.cs | 28 ++ .../help/Get-AzAppNetworkAppLink.md | 158 +++++++ .../help/Get-AzAppNetworkAppLinkMember.md | 190 ++++++++ .../help/Get-AzAppNetworkAvailableVersion.md | 123 ++++++ .../help/Get-AzAppNetworkUpgradeHistory.md | 139 ++++++ .../help/New-AzAppNetworkAppLink.md | 293 +++++++++++++ .../help/New-AzAppNetworkAppLinkMember.md | 411 ++++++++++++++++++ .../help/Remove-AzAppNetworkAppLink.md | 224 ++++++++++ .../help/Remove-AzAppNetworkAppLinkMember.md | 261 +++++++++++ .../help/Set-AzAppNetworkAppLink.md | 293 +++++++++++++ .../help/Set-AzAppNetworkAppLinkMember.md | 384 ++++++++++++++++ .../help/Update-AzAppNetworkAppLink.md | 257 +++++++++++ .../help/Update-AzAppNetworkAppLinkMember.md | 371 ++++++++++++++++ tools/CreateMappings_rules.json | 4 + 73 files changed, 7748 insertions(+) create mode 100644 src/AppNetwork/AppNetwork.Autorest/.gitattributes create mode 100644 src/AppNetwork/AppNetwork.Autorest/.gitignore create mode 100644 src/AppNetwork/AppNetwork.Autorest/Properties/AssemblyInfo.cs create mode 100644 src/AppNetwork/AppNetwork.Autorest/README.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks-appLinkMembers.json create mode 100644 src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks.json create mode 100644 src/AppNetwork/AppNetwork.Autorest/custom/Az.AppNetwork.custom.psm1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/custom/README.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Az.AppNetwork.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAvailableVersion.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/README.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAvailableVersion.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkUpgradeHistory.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/how-to.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/resources/README.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLink.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLinkMember.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAvailableVersion.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkUpgradeHistory.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLink.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLinkMember.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/README.md create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLink.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLinkMember.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/Set-AzAppNetworkAppLink.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/Set-AzAppNetworkAppLinkMember.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLink.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLinkMember.Tests.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/loadEnv.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/test/utils.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/tsp-location.yaml create mode 100644 src/AppNetwork/AppNetwork.Autorest/tspconfig.yaml create mode 100644 src/AppNetwork/AppNetwork.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 create mode 100644 src/AppNetwork/AppNetwork.Autorest/utils/Unprotect-SecureString.ps1 create mode 100644 src/AppNetwork/AppNetwork.sln create mode 100644 src/AppNetwork/AppNetwork/AppNetwork.csproj create mode 100644 src/AppNetwork/AppNetwork/Az.AppNetwork.psd1 create mode 100644 src/AppNetwork/AppNetwork/ChangeLog.md create mode 100644 src/AppNetwork/AppNetwork/Properties/AssemblyInfo.cs create mode 100644 src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md create mode 100644 src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md create mode 100644 src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md create mode 100644 src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md create mode 100644 src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md diff --git a/src/AppNetwork/AppNetwork.Autorest/.gitattributes b/src/AppNetwork/AppNetwork.Autorest/.gitattributes new file mode 100644 index 000000000000..2125666142eb --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/.gitattributes @@ -0,0 +1 @@ +* text=auto \ No newline at end of file diff --git a/src/AppNetwork/AppNetwork.Autorest/.gitignore b/src/AppNetwork/AppNetwork.Autorest/.gitignore new file mode 100644 index 000000000000..6ec158bd9768 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/.gitignore @@ -0,0 +1,16 @@ +bin +obj +.vs +generated +internal +exports +tools +test/*-TestResults.xml +license.txt +/*.ps1 +/*.psd1 +/*.ps1xml +/*.psm1 +/*.snk +/*.csproj +/*.nuspec \ No newline at end of file diff --git a/src/AppNetwork/AppNetwork.Autorest/Properties/AssemblyInfo.cs b/src/AppNetwork/AppNetwork.Autorest/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..581e4a27dee8 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/Properties/AssemblyInfo.cs @@ -0,0 +1,29 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. +// Changes may cause incorrect behavior and will be lost if the code is regenerated. +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the Apache License, Version 2.0 (the ""License""); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ""AS IS"" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +// is regenerated. + +using System; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")] +[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] +[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] +[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - MicrosoftAppLinkManagementService")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0")] +[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0")] +[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] +[assembly: System.CLSCompliantAttribute(false)] diff --git a/src/AppNetwork/AppNetwork.Autorest/README.md b/src/AppNetwork/AppNetwork.Autorest/README.md new file mode 100644 index 000000000000..14c17489bdaf --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/README.md @@ -0,0 +1,24 @@ + +# Az.AppNetwork +This directory contains the PowerShell module for the AppNetwork service. + +--- +## Info +- Modifiable: yes +- Generated: all +- Committed: yes +- Packaged: yes + +--- +## Detail +This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension. + +## Module Requirements +- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater + +## Authentication +AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent. + +## Development +For information on how to develop for `Az.AppNetwork`, see [how-to.md](how-to.md). + diff --git a/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks-appLinkMembers.json b/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks-appLinkMembers.json new file mode 100644 index 000000000000..cf31cfc38f88 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks-appLinkMembers.json @@ -0,0 +1,95 @@ +{ + "resourceType": "appLinks/appLinkMembers", + "apiVersion": "2025-08-01-preview", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.appnetwork" + }, + "commands": [ + { + "name": "Get-AzAppNetworkAppLinkMember", + "description": "Get an AppLinkMember.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/appLinks/{appLinkName}/appLinkMembers/{appLinkMemberName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkapplinkmember" + }, + "parameterSets": [ + { + "parameters": [ + "-AppLinkName ", + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get an AppLinkMember.", + "parameters": [ + { + "name": "-AppLinkName", + "value": "[Path.appLinkName]" + }, + { + "name": "-Name", + "value": "[Path.appLinkMemberName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzAppNetworkAppLinkMember", + "description": "Delete an AppLinkMember.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/appLinks/{appLinkName}/appLinkMembers/{appLinkMemberName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.appnetwork/remove-azappnetworkapplinkmember" + }, + "parameterSets": [ + { + "parameters": [ + "-AppLinkName ", + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete an AppLinkMember.", + "parameters": [ + { + "name": "-AppLinkName", + "value": "[Path.appLinkName]" + }, + { + "name": "-Name", + "value": "[Path.appLinkMemberName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks.json b/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks.json new file mode 100644 index 000000000000..79fd62a559c3 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks.json @@ -0,0 +1,85 @@ +{ + "resourceType": "appLinks", + "apiVersion": "2025-08-01-preview", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.appnetwork" + }, + "commands": [ + { + "name": "Get-AzAppNetworkAppLink", + "description": "Get an AppLink.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/appLinks/{appLinkName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkapplink" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get an AppLink.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.appLinkName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzAppNetworkAppLink", + "description": "Delete an AppLink.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/appLinks/{appLinkName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.appnetwork/remove-azappnetworkapplink" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete an AppLink.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.appLinkName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/AppNetwork/AppNetwork.Autorest/custom/Az.AppNetwork.custom.psm1 b/src/AppNetwork/AppNetwork.Autorest/custom/Az.AppNetwork.custom.psm1 new file mode 100644 index 000000000000..7cb8dd27c78c --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/custom/Az.AppNetwork.custom.psm1 @@ -0,0 +1,17 @@ +# region Generated + # Load the private module dll + $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '../bin/Az.AppNetwork.private.dll') + + # Load the internal module + $internalModulePath = Join-Path $PSScriptRoot '../internal/Az.AppNetwork.internal.psm1' + if(Test-Path $internalModulePath) { + $null = Import-Module -Name $internalModulePath + } + + # Export nothing to clear implicit exports + Export-ModuleMember + + # Export script cmdlets + Get-ChildItem -Path $PSScriptRoot -Recurse -Include '*.ps1' -File | ForEach-Object { . $_.FullName } + Export-ModuleMember -Function (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot) -Alias (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot -AsAlias) +# endregion diff --git a/src/AppNetwork/AppNetwork.Autorest/custom/README.md b/src/AppNetwork/AppNetwork.Autorest/custom/README.md new file mode 100644 index 000000000000..1464e92dc7fb --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/custom/README.md @@ -0,0 +1,41 @@ +# Custom +This directory contains custom implementation for non-generated cmdlets for the `Az.AppNetwork` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.AppNetwork.custom.psm1`. This file should not be modified. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: yes + +## Details +For `Az.AppNetwork` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*. + +For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.AppNetwork.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder. + +For script cmdlets, these are loaded via the `Az.AppNetwork.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build. + +## Purpose +This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder. + +## Usage +The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: +- Break +- DefaultProfile +- HttpPipelineAppend +- HttpPipelinePrepend +- Proxy +- ProxyCredential +- ProxyUseDefaultCredentials + +These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.AppNetwork`. For C#, follow the usage seen in the `ProcessRecordAsync` method. + +### Attributes +For processing the cmdlets, we've created some additional attributes: +- `Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.DescriptionAttribute` + - 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.AppNetwork.DoNotExportAttribute` + - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.AppNetwork`. +- `Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.InternalExportAttribute` + - Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.AppNetwork`. For more information, see [README.md](../internal/README.md) in the `../internal` folder. +- `Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.ProfileAttribute` + - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules. \ No newline at end of file diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Az.AppNetwork.md b/src/AppNetwork/AppNetwork.Autorest/docs/Az.AppNetwork.md new file mode 100644 index 000000000000..b8615d0720e4 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Az.AppNetwork.md @@ -0,0 +1,49 @@ +--- +Module Name: Az.AppNetwork +Module Guid: 3506ae4a-812e-4fc7-b94d-5c874376b565 +Download Help Link: https://learn.microsoft.com/powershell/module/az.appnetwork +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.AppNetwork Module +## Description +Microsoft Azure PowerShell: AppNetwork cmdlets + +## Az.AppNetwork Cmdlets +### [Get-AzAppNetworkAppLink](Get-AzAppNetworkAppLink.md) +Get an AppLink. + +### [Get-AzAppNetworkAppLinkMember](Get-AzAppNetworkAppLinkMember.md) +Get an AppLinkMember. + +### [Get-AzAppNetworkAvailableVersion](Get-AzAppNetworkAvailableVersion.md) +List AvailableVersion resources by location. + +### [Get-AzAppNetworkUpgradeHistory](Get-AzAppNetworkUpgradeHistory.md) +List UpgradeHistory resources by AppLinkMember. + +### [New-AzAppNetworkAppLink](New-AzAppNetworkAppLink.md) +Create an AppLink. + +### [New-AzAppNetworkAppLinkMember](New-AzAppNetworkAppLinkMember.md) +Create an AppLinkMember. + +### [Remove-AzAppNetworkAppLink](Remove-AzAppNetworkAppLink.md) +Delete an AppLink. + +### [Remove-AzAppNetworkAppLinkMember](Remove-AzAppNetworkAppLinkMember.md) +Delete an AppLinkMember. + +### [Set-AzAppNetworkAppLink](Set-AzAppNetworkAppLink.md) +Update an AppLink. + +### [Set-AzAppNetworkAppLinkMember](Set-AzAppNetworkAppLinkMember.md) +Update an AppLinkMember. + +### [Update-AzAppNetworkAppLink](Update-AzAppNetworkAppLink.md) +Update an AppLink. + +### [Update-AzAppNetworkAppLinkMember](Update-AzAppNetworkAppLinkMember.md) +Update an AppLinkMember. + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..84309454d72f --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md @@ -0,0 +1,158 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkapplink +schema: 2.0.0 +--- + +# Get-AzAppNetworkAppLink + +## SYNOPSIS +Get an AppLink. + +## SYNTAX + +### List1 (Default) +``` +Get-AzAppNetworkAppLink [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAppNetworkAppLink -InputObject [-DefaultProfile ] [] +``` + +### List +``` +Get-AzAppNetworkAppLink -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get an AppLink. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AppLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..823f226b49b0 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkapplinkmember +schema: 2.0.0 +--- + +# Get-AzAppNetworkAppLinkMember + +## SYNOPSIS +Get an AppLinkMember. + +## SYNTAX + +### List (Default) +``` +Get-AzAppNetworkAppLinkMember -AppLinkName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAppNetworkAppLinkMember -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityAppLink +``` +Get-AzAppNetworkAppLinkMember -AppLinkInputObject -Name + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get an AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: GetViaIdentityAppLink +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityAppLink +Aliases: AppLinkMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAvailableVersion.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAvailableVersion.md new file mode 100644 index 000000000000..8312ed430c72 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAvailableVersion.md @@ -0,0 +1,123 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkavailableversion +schema: 2.0.0 +--- + +# Get-AzAppNetworkAvailableVersion + +## SYNOPSIS +List AvailableVersion resources by location. + +## SYNTAX + +``` +Get-AzAppNetworkAvailableVersion -Location [-SubscriptionId ] [-KubernetesVersion ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +List AvailableVersion resources by location. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubernetesVersion +Kubernetes version to filter profiles + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of the Azure region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAvailableVersion + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md new file mode 100644 index 000000000000..ff2bbbcbde2f --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md @@ -0,0 +1,139 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkupgradehistory +schema: 2.0.0 +--- + +# Get-AzAppNetworkUpgradeHistory + +## SYNOPSIS +List UpgradeHistory resources by AppLinkMember. + +## SYNTAX + +``` +Get-AzAppNetworkUpgradeHistory -AppLinkMemberName -AppLinkName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +List UpgradeHistory resources by AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkMemberName +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IUpgradeHistory + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..57f6a7613166 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md @@ -0,0 +1,293 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/new-azappnetworkapplink +schema: 2.0.0 +--- + +# New-AzAppNetworkAppLink + +## SYNOPSIS +Create an AppLink. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzAppNetworkAppLink -Name -ResourceGroupName -Location + [-SubscriptionId ] [-EnableSystemAssignedIdentity] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzAppNetworkAppLink -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzAppNetworkAppLink -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create an AppLink. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..f5562d1d1353 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md @@ -0,0 +1,411 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/new-azappnetworkapplinkmember +schema: 2.0.0 +--- + +# New-AzAppNetworkAppLinkMember + +## SYNOPSIS +Create an AppLinkMember. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -Location [-SubscriptionId ] [-ClusterType ] [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-MetadataResourceId ] + [-PrivateConnectSubnetResourceId ] [-SelfManagedUpgradeProfileVersion ] [-Tag ] + [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityAppLinkExpanded +``` +New-AzAppNetworkAppLinkMember -AppLinkInputObject -Name -Location + [-ClusterType ] [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-MetadataResourceId ] + [-PrivateConnectSubnetResourceId ] [-SelfManagedUpgradeProfileVersion ] [-Tag ] + [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create an AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: CreateViaIdentityAppLinkExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +Cluster type + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EastWestGatewayVisibility +East-West gateway visibility. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullyManagedUpgradeProfileReleaseChannel +Release channel + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetadataResourceId +Resource ID + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppLinkMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateConnectSubnetResourceId +Delegated Subnet to AppLink. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelfManagedUpgradeProfileVersion +Istio version + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeProfileMode +Upgrade mode. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/README.md b/src/AppNetwork/AppNetwork.Autorest/docs/README.md new file mode 100644 index 000000000000..0959cc416cce --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/README.md @@ -0,0 +1,11 @@ +# Docs +This directory contains the documentation of the cmdlets for the `Az.AppNetwork` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `../examples` folder. + +## Info +- Modifiable: no +- Generated: all +- Committed: yes +- Packaged: yes + +## Details +The process of documentation generation loads `Az.AppNetwork` 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/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..b678ac0063d4 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/remove-azappnetworkapplink +schema: 2.0.0 +--- + +# Remove-AzAppNetworkAppLink + +## SYNOPSIS +Delete an AppLink. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAppNetworkAppLink -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete an AppLink. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AppLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..4dbf87cafcc7 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md @@ -0,0 +1,261 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/remove-azappnetworkapplinkmember +schema: 2.0.0 +--- + +# Remove-AzAppNetworkAppLinkMember + +## SYNOPSIS +Delete an AppLinkMember. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzAppNetworkAppLinkMember -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityAppLink +``` +Remove-AzAppNetworkAppLinkMember -AppLinkInputObject -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete an AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: DeleteViaIdentityAppLink +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityAppLink +Aliases: AppLinkMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..42f7dbe6c5a5 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md @@ -0,0 +1,293 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/set-azappnetworkapplink +schema: 2.0.0 +--- + +# Set-AzAppNetworkAppLink + +## SYNOPSIS +Update an AppLink. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzAppNetworkAppLink -Name -ResourceGroupName -Location + [-SubscriptionId ] [-EnableSystemAssignedIdentity ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonFilePath +``` +Set-AzAppNetworkAppLink -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonString +``` +Set-AzAppNetworkAppLink -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update an AppLink. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..a017fe906dcb --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md @@ -0,0 +1,384 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/set-azappnetworkapplinkmember +schema: 2.0.0 +--- + +# Set-AzAppNetworkAppLinkMember + +## SYNOPSIS +Update an AppLinkMember. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -Location [-SubscriptionId ] [-ClusterType ] [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-MetadataResourceId ] + [-PrivateConnectSubnetResourceId ] [-SelfManagedUpgradeProfileVersion ] [-Tag ] + [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonFilePath +``` +Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Update an AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +Cluster type + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EastWestGatewayVisibility +East-West gateway visibility. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullyManagedUpgradeProfileReleaseChannel +Release channel + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetadataResourceId +Resource ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppLinkMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateConnectSubnetResourceId +Delegated Subnet to AppLink. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelfManagedUpgradeProfileVersion +Istio version + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeProfileMode +Upgrade mode. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..4a47098562d4 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/update-azappnetworkapplink +schema: 2.0.0 +--- + +# Update-AzAppNetworkAppLink + +## SYNOPSIS +Update an AppLink. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + [-EnableSystemAssignedIdentity ] [-Tag ] [-UserAssignedIdentity ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAppNetworkAppLink -InputObject [-EnableSystemAssignedIdentity ] + [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update an AppLink. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AppLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..71bc87913f9e --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md @@ -0,0 +1,371 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/update-azappnetworkapplinkmember +schema: 2.0.0 +--- + +# Update-AzAppNetworkAppLinkMember + +## SYNOPSIS +Update an AppLinkMember. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + [-SubscriptionId ] [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-SelfManagedUpgradeProfileVersion ] + [-Tag ] [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityAppLinkExpanded +``` +Update-AzAppNetworkAppLinkMember -AppLinkInputObject -Name + [-EastWestGatewayVisibility ] [-FullyManagedUpgradeProfileReleaseChannel ] + [-SelfManagedUpgradeProfileVersion ] [-Tag ] [-UpgradeProfileMode ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAppNetworkAppLinkMember -InputObject [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-SelfManagedUpgradeProfileVersion ] + [-Tag ] [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Update an AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: UpdateViaIdentityAppLinkExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EastWestGatewayVisibility +East-West gateway visibility. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullyManagedUpgradeProfileReleaseChannel +Release channel + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: AppLinkMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelfManagedUpgradeProfileVersion +Istio version + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeProfileMode +Upgrade mode. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLink.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLinkMember.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAvailableVersion.md b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAvailableVersion.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAvailableVersion.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkUpgradeHistory.md b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkUpgradeHistory.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkUpgradeHistory.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLink.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLinkMember.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLink.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLinkMember.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLink.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLinkMember.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLink.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLinkMember.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/AppNetwork/AppNetwork.Autorest/how-to.md b/src/AppNetwork/AppNetwork.Autorest/how-to.md new file mode 100644 index 000000000000..b674516d7b33 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/how-to.md @@ -0,0 +1,58 @@ +# How-To +This document describes how to develop for `Az.AppNetwork`. + +## Building `Az.AppNetwork` +To build, run the `build-module.ps1` at the root of the module directory. This will generate the proxy script cmdlets that are the cmdlets being exported by this module. After the build completes, the proxy script cmdlets will be output to the `exports` folder. To read more about the proxy script cmdlets, look at the [README.md](exports/README.md) in the `exports` folder. + +## Creating custom cmdlets +To add cmdlets that were not generated by the REST specification, use the `custom` folder. This folder allows you to add handwritten `.ps1` and `.cs` files. Currently, we support using `.ps1` scripts as new cmdlets or as additional low-level variants (via `ParameterSet`), and `.cs` files as low-level (variants) cmdlets that the exported script cmdlets call. We do not support exporting any `.cs` (dll) cmdlets directly. To read more about custom cmdlets, look at the [README.md](custom/README.md) in the `custom` folder. + +## Generating documentation +To generate documentation, the process is now integrated into the `build-module.ps1` script. If you don't want to run this process as part of `build-module.ps1`, you can provide the `-NoDocs` switch. If you want to run documentation generation after the build process, you may still run the `generate-help.ps1` script. Overall, the process will look at the documentation comments in the generated and custom cmdlets and types, and create `.md` files into the `docs` folder. Additionally, this pulls in any examples from the `examples` folder and adds them to the generated help markdown documents. To read more about examples, look at the [README.md](examples/README.md) in the `examples` folder. To read more about documentation, look at the [README.md](docs/README.md) in the `docs` folder. + +## Testing `Az.AppNetwork` +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.AppNetwork` +To pack `Az.AppNetwork` 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.AppNetwork`. +- `build-module.ps1` + - Builds the module DLL (`./bin/Az.AppNetwork.private.dll`), creates the exported cmdlets and documentation, generates custom cmdlet test stubs and exported cmdlet example stubs, and updates `./Az.AppNetwork.psd1` with Azure profile information. + - **Parameters**: [`Switch` parameters] + - `-Run`: After building, creates an isolated PowerShell session and loads `Az.AppNetwork`. + - `-Test`: After building, runs the `Pester` tests defined in the `test` folder. + - `-Docs`: After building, generates the Markdown documents for the modules into the `docs` folder. + - `-Pack`: After building, packages the module into a `.nupkg`. + - `-Code`: After building, opens a VSCode window with the module's directory and runs (see `-Run`) the module. + - `-Release`: Builds the module in `Release` configuration (as opposed to `Debug` configuration). + - `-NoDocs`: Supresses writing the documentation markdown files as part of the cmdlet exporting process. + - `-Debugger`: Used when attaching the debugger in Visual Studio to the PowerShell session, and running the build process without recompiling the DLL. This suppresses running the script as an isolated process. +- `run-module.ps1` + - Creates an isolated PowerShell session and loads `Az.AppNetwork` into the session. + - Same as `-Run` in `build-module.ps1`. + - **Parameters**: [`Switch` parameters] + - `-Code`: Opens a VSCode window with the module's directory. + - Same as `-Code` in `build-module.ps1`. +- `generate-help.ps1` + - Generates the Markdown documents for the modules into the `docs` folder. + - Same as `-Docs` in `build-module.ps1`. +- `test-module.ps1` + - Runs the `Pester` tests defined in the `test` folder. + - Same as `-Test` in `build-module.ps1`. +- `pack-module.ps1` + - Packages the module into a `.nupkg` for distribution. + - Same as `-Pack` in `build-module.ps1`. +- `generate-help.ps1` + - Generates the Markdown documents for the modules into the `docs` folder. + - Same as `-Docs` in `build-module.ps1`. + - This process is now integrated into `build-module.ps1` automatically. To disable, use `-NoDocs` when running `build-module.ps1`. +- `export-surface.ps1` + - Generates Markdown documents for both the cmdlet surface and the model (class) surface of the module. + - These files are placed into the `resources` folder. + - Used for investigating the surface of your module. These are *not* documentation for distribution. +- `check-dependencies.ps1` + - Used in `run-module.ps1` and `test-module.ps1` to verify dependent modules are available to run those tasks. + - It will download local (within the module's directory structure) versions of those modules as needed. + - This script *does not* need to be ran by-hand. \ No newline at end of file diff --git a/src/AppNetwork/AppNetwork.Autorest/resources/README.md b/src/AppNetwork/AppNetwork.Autorest/resources/README.md new file mode 100644 index 000000000000..736492341e3d --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/resources/README.md @@ -0,0 +1,11 @@ +# Resources +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `../custom` folder. + +## Info +- Modifiable: yes +- Generated: no +- Committed: yes +- Packaged: no + +## Purpose +Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact. \ No newline at end of file diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLink.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLink.Tests.ps1 new file mode 100644 index 000000000000..6f7d7e261e85 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLink.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzAppNetworkAppLink')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzAppNetworkAppLink.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzAppNetworkAppLink' { + It 'List1' { + # List by subscription + { Get-AzAppNetworkAppLink } | Should -Not -Throw + } + + It 'Get' { + { + $appLink = Get-AzAppNetworkAppLink -Name $env.appLinkName -ResourceGroupName $env.resourceGroup + $appLink.Name | Should -Be $env.appLinkName + } | Should -Not -Throw + } + + It 'List' { + # List by resource group + { + $appLinks = Get-AzAppNetworkAppLink -ResourceGroupName $env.resourceGroup + $appLinks.Name | Should -Contain $env.appLinkName + } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLinkMember.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLinkMember.Tests.ps1 new file mode 100644 index 000000000000..fa6c5e3609eb --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLinkMember.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzAppNetworkAppLinkMember')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzAppNetworkAppLinkMember.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzAppNetworkAppLinkMember' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityAppLink' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAvailableVersion.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAvailableVersion.Tests.ps1 new file mode 100644 index 000000000000..20ba5d1654db --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAvailableVersion.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzAppNetworkAvailableVersion')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzAppNetworkAvailableVersion.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzAppNetworkAvailableVersion' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkUpgradeHistory.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkUpgradeHistory.Tests.ps1 new file mode 100644 index 000000000000..ed0907a2eb9e --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkUpgradeHistory.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzAppNetworkUpgradeHistory')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzAppNetworkUpgradeHistory.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzAppNetworkUpgradeHistory' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLink.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLink.Tests.ps1 new file mode 100644 index 000000000000..65738b77b1b2 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLink.Tests.ps1 @@ -0,0 +1,34 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzAppNetworkAppLink')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzAppNetworkAppLink.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New-AzAppNetworkAppLink' { + It 'CreateExpanded' { + { + $appLink = New-AzAppNetworkAppLink -Name $env.appLinkName -ResourceGroupName $env.resourceGroup -Location $env.location + $appLink.Name | Should -Be $env.appLinkName + $appLink.Location | Should -Be $env.location + $appLink.ProvisioningState | Should -Be 'Succeeded' + } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLinkMember.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLinkMember.Tests.ps1 new file mode 100644 index 000000000000..691f4d2627c4 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLinkMember.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzAppNetworkAppLinkMember')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzAppNetworkAppLinkMember.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New-AzAppNetworkAppLinkMember' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityAppLinkExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/README.md b/src/AppNetwork/AppNetwork.Autorest/test/README.md new file mode 100644 index 000000000000..1969200c6a09 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/README.md @@ -0,0 +1,17 @@ +# Test +This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `../custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: no + +## Details +We allow three testing modes: *live*, *record*, and *playback*. These can be selected using the `-Live`, `-Record`, and `-Playback` switches respectively on the `test-module.ps1` script. This script will run through any `.Tests.ps1` scripts in the `test` folder. If you choose the *record* mode, it will create a `.Recording.json` file of the REST calls between the client and server. Then, when you choose *playback* mode, it will use the `.Recording.json` file to mock the communication between server and client. The *live* mode runs the same as the *record* mode; however, it doesn't create the `.Recording.json` file. + +## Purpose +Custom cmdlets generally encompass additional functionality not described in the REST specification, or combines functionality generated from the REST spec. To validate this functionality continues to operate as intended, creating tests that can be ran and re-ran against custom cmdlets is part of the framework. + +## Usage +To execute tests, run the `test-module.ps1`. To write tests, [this example](https://github.com/pester/Pester/blob/8b9cf4248315e44f1ac6673be149f7e0d7f10466/Examples/Planets/Get-Planet.Tests.ps1#L1) from the Pester repository is very useful for getting started. \ No newline at end of file diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLink.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLink.Tests.ps1 new file mode 100644 index 000000000000..6684af3cf66f --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLink.Tests.ps1 @@ -0,0 +1,28 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzAppNetworkAppLink')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzAppNetworkAppLink.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzAppNetworkAppLink' { + It 'Delete' { + { + Remove-AzAppNetworkAppLink -Name $env.appLinkName -ResourceGroupName $env.resourceGroup + { Get-AzAppNetworkAppLink -Name $env.appLinkName -ResourceGroupName $env.resourceGroup -ErrorAction Stop } | Should -Throw + } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLinkMember.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLinkMember.Tests.ps1 new file mode 100644 index 000000000000..f5f566acdd09 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLinkMember.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzAppNetworkAppLinkMember')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzAppNetworkAppLinkMember.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzAppNetworkAppLinkMember' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityAppLink' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Set-AzAppNetworkAppLink.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Set-AzAppNetworkAppLink.Tests.ps1 new file mode 100644 index 000000000000..558024399c84 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/Set-AzAppNetworkAppLink.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Set-AzAppNetworkAppLink')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Set-AzAppNetworkAppLink.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Set-AzAppNetworkAppLink' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Set-AzAppNetworkAppLinkMember.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Set-AzAppNetworkAppLinkMember.Tests.ps1 new file mode 100644 index 000000000000..5aed5cba69c7 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/Set-AzAppNetworkAppLinkMember.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Set-AzAppNetworkAppLinkMember')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Set-AzAppNetworkAppLinkMember.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Set-AzAppNetworkAppLinkMember' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLink.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLink.Tests.ps1 new file mode 100644 index 000000000000..fc499d6599f1 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLink.Tests.ps1 @@ -0,0 +1,28 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzAppNetworkAppLink')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzAppNetworkAppLink.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzAppNetworkAppLink' { + It 'UpdateExpanded' { + { + $appLink = Update-AzAppNetworkAppLink -Name $env.appLinkName -ResourceGroupName $env.resourceGroup -Tag @{ env = 'test' } + $appLink.Tag.env | Should -Be 'test' + } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLinkMember.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLinkMember.Tests.ps1 new file mode 100644 index 000000000000..d6e6c2c9a9f9 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLinkMember.Tests.ps1 @@ -0,0 +1,37 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzAppNetworkAppLinkMember')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzAppNetworkAppLinkMember.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzAppNetworkAppLinkMember' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityAppLinkExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/AppNetwork/AppNetwork.Autorest/test/loadEnv.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/loadEnv.ps1 new file mode 100644 index 000000000000..6a7c385c6b7d --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/loadEnv.ps1 @@ -0,0 +1,29 @@ +# ---------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. +# ---------------------------------------------------------------------------------- +$envFile = 'env.json' +if ($TestMode -eq 'live') { + $envFile = 'localEnv.json' +} + +if (Test-Path -Path (Join-Path $PSScriptRoot $envFile)) { + $envFilePath = Join-Path $PSScriptRoot $envFile +} else { + $envFilePath = Join-Path $PSScriptRoot '..\$envFile' +} +$env = @{} +if (Test-Path -Path $envFilePath) { + $env = Get-Content (Join-Path $PSScriptRoot $envFile) | ConvertFrom-Json + $PSDefaultParameterValues=@{"*:Tenant"=$env.Tenant} +} \ No newline at end of file diff --git a/src/AppNetwork/AppNetwork.Autorest/test/utils.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/utils.ps1 new file mode 100644 index 000000000000..9a6bdbd428b8 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/test/utils.ps1 @@ -0,0 +1,66 @@ +function RandomString([bool]$allChars, [int32]$len) { + if ($allChars) { + return -join ((33..126) | Get-Random -Count $len | % {[char]$_}) + } else { + return -join ((48..57) + (97..122) | Get-Random -Count $len | % {[char]$_}) + } +} +function Start-TestSleep { + [CmdletBinding(DefaultParameterSetName = 'SleepBySeconds')] + param( + [parameter(Mandatory = $true, Position = 0, ParameterSetName = 'SleepBySeconds')] + [ValidateRange(0.0, 2147483.0)] + [double] $Seconds, + + [parameter(Mandatory = $true, ParameterSetName = 'SleepByMilliseconds')] + [ValidateRange('NonNegative')] + [Alias('ms')] + [int] $Milliseconds + ) + + if ($TestMode -ne 'playback') { + switch ($PSCmdlet.ParameterSetName) { + 'SleepBySeconds' { + Start-Sleep -Seconds $Seconds + } + 'SleepByMilliseconds' { + Start-Sleep -Milliseconds $Milliseconds + } + } + } +} + +$env = @{} +if ($UsePreviousConfigForRecord) { + $previousEnv = Get-Content (Join-Path $PSScriptRoot 'env.json') | ConvertFrom-Json + $previousEnv.psobject.properties | Foreach-Object { $env[$_.Name] = $_.Value } +} +# Add script method called AddWithCache to $env, when useCache is set true, it will try to get the value from the $env first. +# example: $val = $env.AddWithCache('key', $val, $true) +$env | Add-Member -Type ScriptMethod -Value { param( [string]$key, [object]$val, [bool]$useCache) if ($this.Contains($key) -and $useCache) { return $this[$key] } else { $this[$key] = $val; return $val } } -Name 'AddWithCache' +function setupEnv() { + # Preload subscriptionId and tenant from context, which will be used in test + # as default. You could change them if needed. + $env.SubscriptionId = (Get-AzContext).Subscription.Id + $env.Tenant = (Get-AzContext).Tenant.Id + # For any resources you created for test, you should add it to $env here. + $env.location = 'eastus' + $env.resourceGroup = 'appnetwork-test-' + (RandomString -allChars $false -len 6) + $env.appLinkName = 'applink-' + (RandomString -allChars $false -len 6) + if ($TestMode -ne 'playback') { + Write-Host "Creating resource group $($env.resourceGroup) in $($env.location)" + New-AzResourceGroup -Name $env.resourceGroup -Location $env.location | Out-Null + } + $envFile = 'env.json' + if ($TestMode -eq 'live') { + $envFile = 'localEnv.json' + } + set-content -Path (Join-Path $PSScriptRoot $envFile) -Value (ConvertTo-Json $env) +} +function cleanupEnv() { + # Clean resources you create for testing + if ($TestMode -ne 'playback') { + Remove-AzResourceGroup -Name $env.resourceGroup -Force -ErrorAction SilentlyContinue | Out-Null + } +} + diff --git a/src/AppNetwork/AppNetwork.Autorest/tsp-location.yaml b/src/AppNetwork/AppNetwork.Autorest/tsp-location.yaml new file mode 100644 index 000000000000..22d2dc2d7937 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/applink/AppLink.Management +commit: 4e3a778ec67cde969d2d22e5dab5a25383b67989 +repo: Azure/azure-rest-api-specs +additionalDirectories: diff --git a/src/AppNetwork/AppNetwork.Autorest/tspconfig.yaml b/src/AppNetwork/AppNetwork.Autorest/tspconfig.yaml new file mode 100644 index 000000000000..c223c1cf1c60 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/tspconfig.yaml @@ -0,0 +1,37 @@ +options: + "@azure-tools/typespec-powershell": + service-dir: "src" + emitter-output-dir: "{output-dir}/{service-dir}/AppNetwork/AppNetwork.Autorest" + clear-output-folder: true + debug: true + azure: true + module-version: 0.1.0 + prefix: "Az" + subject-prefix: "AppNetwork" + service-name: AppNetwork + module-name: "{prefix}.{service-name}" + output-folder: "{output-dir}" + exclude-tableview-properties: + - Id + - Type + directive: + # Hide the raw Operations listing cmdlet + - where: + subject: Operation + hide: true + # Default SubscriptionId from the current Az context + - where: + parameter-name: SubscriptionId + set: + default: + name: SubscriptionId Default + description: Gets the SubscriptionId from the current context. + script: "(Get-AzContext).Subscription.Id" + # Remove the non-Expanded / non-JSON parameter sets for Create/Update + - where: + variant: ^(Create|Update)(?!.*?Expanded|ViaJsonString|ViaJsonFilePath) + remove: true + # ViaIdentity is not required for New-* cmdlets + - where: + variant: ^CreateViaIdentity$|^CreateViaIdentityExpanded$ + remove: true diff --git a/src/AppNetwork/AppNetwork.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 b/src/AppNetwork/AppNetwork.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 new file mode 100644 index 000000000000..5319862d3372 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 @@ -0,0 +1,7 @@ +param() +if ($env:AzPSAutorestTestPlaybackMode) { + $loadEnvPath = Join-Path $PSScriptRoot '..' 'test' 'loadEnv.ps1' + . ($loadEnvPath) + return $env.SubscriptionId +} +return (Get-AzContext).Subscription.Id \ No newline at end of file diff --git a/src/AppNetwork/AppNetwork.Autorest/utils/Unprotect-SecureString.ps1 b/src/AppNetwork/AppNetwork.Autorest/utils/Unprotect-SecureString.ps1 new file mode 100644 index 000000000000..cb05b51a6220 --- /dev/null +++ b/src/AppNetwork/AppNetwork.Autorest/utils/Unprotect-SecureString.ps1 @@ -0,0 +1,16 @@ +#This script converts securestring to plaintext + +param( + [Parameter(Mandatory, ValueFromPipeline)] + [System.Security.SecureString] + ${SecureString} +) + +$ssPtr = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($SecureString) +try { + $plaintext = [System.Runtime.InteropServices.Marshal]::PtrToStringBSTR($ssPtr) +} finally { + [System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ssPtr) +} + +return $plaintext \ No newline at end of file diff --git a/src/AppNetwork/AppNetwork.sln b/src/AppNetwork/AppNetwork.sln new file mode 100644 index 000000000000..8c84f281da32 --- /dev/null +++ b/src/AppNetwork/AppNetwork.sln @@ -0,0 +1,74 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Accounts", "Accounts", "{B37AA8DA-DAE5-4BED-9BA6-09C99248F48D}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication", "..\Accounts\Authentication\Authentication.csproj", "{B5018693-8336-495D-840C-1FDDCB4C0628}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication.ResourceManager", "..\Accounts\Authentication.ResourceManager\Authentication.ResourceManager.csproj", "{9D0DE013-43D9-432A-9E70-9C721F1CFE76}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AuthenticationAssemblyLoadContext", "..\Accounts\AuthenticationAssemblyLoadContext\AuthenticationAssemblyLoadContext.csproj", "{E329207D-AB60-4CFA-A7B0-4EF85AB386DF}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Accounts", "..\Accounts\Accounts\Accounts.csproj", "{83C881C3-6AC7-4BBA-80A2-C0018F54F6EE}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accounts\Authenticators\Authenticators.csproj", "{69F0BEA4-FC55-4A9B-A4F4-C778052317D4}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssemblyLoading", "..\Accounts\AssemblyLoading\AssemblyLoading.csproj", "{27299B28-B94A-49B5-8059-A5465D7AE94E}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AppNetwork", "AppNetwork\AppNetwork.csproj", "{1CEDE903-6150-4250-BDCC-8E246897AF5B}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.AppNetwork", "AppNetwork.Autorest\Az.AppNetwork.csproj", "{1E145E1A-F840-4AF2-9F7B-1627308852C8}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {B5018693-8336-495D-840C-1FDDCB4C0628}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B5018693-8336-495D-840C-1FDDCB4C0628}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B5018693-8336-495D-840C-1FDDCB4C0628}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B5018693-8336-495D-840C-1FDDCB4C0628}.Release|Any CPU.Build.0 = Release|Any CPU + {9D0DE013-43D9-432A-9E70-9C721F1CFE76}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9D0DE013-43D9-432A-9E70-9C721F1CFE76}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9D0DE013-43D9-432A-9E70-9C721F1CFE76}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9D0DE013-43D9-432A-9E70-9C721F1CFE76}.Release|Any CPU.Build.0 = Release|Any CPU + {E329207D-AB60-4CFA-A7B0-4EF85AB386DF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E329207D-AB60-4CFA-A7B0-4EF85AB386DF}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E329207D-AB60-4CFA-A7B0-4EF85AB386DF}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E329207D-AB60-4CFA-A7B0-4EF85AB386DF}.Release|Any CPU.Build.0 = Release|Any CPU + {83C881C3-6AC7-4BBA-80A2-C0018F54F6EE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {83C881C3-6AC7-4BBA-80A2-C0018F54F6EE}.Debug|Any CPU.Build.0 = Debug|Any CPU + {83C881C3-6AC7-4BBA-80A2-C0018F54F6EE}.Release|Any CPU.ActiveCfg = Release|Any CPU + {83C881C3-6AC7-4BBA-80A2-C0018F54F6EE}.Release|Any CPU.Build.0 = Release|Any CPU + {69F0BEA4-FC55-4A9B-A4F4-C778052317D4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {69F0BEA4-FC55-4A9B-A4F4-C778052317D4}.Debug|Any CPU.Build.0 = Debug|Any CPU + {69F0BEA4-FC55-4A9B-A4F4-C778052317D4}.Release|Any CPU.ActiveCfg = Release|Any CPU + {69F0BEA4-FC55-4A9B-A4F4-C778052317D4}.Release|Any CPU.Build.0 = Release|Any CPU + {27299B28-B94A-49B5-8059-A5465D7AE94E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {27299B28-B94A-49B5-8059-A5465D7AE94E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {27299B28-B94A-49B5-8059-A5465D7AE94E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {27299B28-B94A-49B5-8059-A5465D7AE94E}.Release|Any CPU.Build.0 = Release|Any CPU + {1CEDE903-6150-4250-BDCC-8E246897AF5B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {1CEDE903-6150-4250-BDCC-8E246897AF5B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1CEDE903-6150-4250-BDCC-8E246897AF5B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {1CEDE903-6150-4250-BDCC-8E246897AF5B}.Release|Any CPU.Build.0 = Release|Any CPU + {1E145E1A-F840-4AF2-9F7B-1627308852C8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {1E145E1A-F840-4AF2-9F7B-1627308852C8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1E145E1A-F840-4AF2-9F7B-1627308852C8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {1E145E1A-F840-4AF2-9F7B-1627308852C8}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {B5018693-8336-495D-840C-1FDDCB4C0628} = {B37AA8DA-DAE5-4BED-9BA6-09C99248F48D} + {9D0DE013-43D9-432A-9E70-9C721F1CFE76} = {B37AA8DA-DAE5-4BED-9BA6-09C99248F48D} + {E329207D-AB60-4CFA-A7B0-4EF85AB386DF} = {B37AA8DA-DAE5-4BED-9BA6-09C99248F48D} + {83C881C3-6AC7-4BBA-80A2-C0018F54F6EE} = {B37AA8DA-DAE5-4BED-9BA6-09C99248F48D} + {69F0BEA4-FC55-4A9B-A4F4-C778052317D4} = {B37AA8DA-DAE5-4BED-9BA6-09C99248F48D} + {27299B28-B94A-49B5-8059-A5465D7AE94E} = {B37AA8DA-DAE5-4BED-9BA6-09C99248F48D} + EndGlobalSection +EndGlobal diff --git a/src/AppNetwork/AppNetwork/AppNetwork.csproj b/src/AppNetwork/AppNetwork/AppNetwork.csproj new file mode 100644 index 000000000000..0a3fd72df9a7 --- /dev/null +++ b/src/AppNetwork/AppNetwork/AppNetwork.csproj @@ -0,0 +1,28 @@ + + + + + + + AppNetwork + + + + netstandard2.0 + $(AzAssemblyPrefix)$(PsModuleName) + $(AzAssemblyPrefix)$(PsModuleName) + true + false + $(RepoArtifacts)$(Configuration)\Az.$(PsModuleName)\ + $(OutputPath) + + + + + + + + + + + diff --git a/src/AppNetwork/AppNetwork/Az.AppNetwork.psd1 b/src/AppNetwork/AppNetwork/Az.AppNetwork.psd1 new file mode 100644 index 000000000000..3298e62cf3ac --- /dev/null +++ b/src/AppNetwork/AppNetwork/Az.AppNetwork.psd1 @@ -0,0 +1,138 @@ +# +# Module manifest for module 'Az.AppNetwork' +# +# Generated by: Microsoft Corporation +# +# Generated on: 08/07/2026 +# + +@{ + +# Script module or binary module file associated with this manifest. +# RootModule = '' + +# Version number of this module. +ModuleVersion = '0.1.0' + +# Supported PSEditions +CompatiblePSEditions = 'Core', 'Desktop' + +# ID used to uniquely identify this module +GUID = 'accceef6-8113-453a-a31c-4f2ce57893d6' + +# Author of this module +Author = 'Microsoft Corporation' + +# Company or vendor of this module +CompanyName = 'Microsoft Corporation' + +# Copyright statement for this module +Copyright = 'Microsoft Corporation. All rights reserved.' + +# Description of the functionality provided by this module +Description = 'Microsoft Azure PowerShell: AppNetwork cmdlets' + +# Minimum version of the PowerShell engine required by this module +PowerShellVersion = '5.1' + +# Name of the PowerShell host required by this module +# PowerShellHostName = '' + +# Minimum version of the PowerShell host required by this module +# PowerShellHostVersion = '' + +# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +DotNetFrameworkVersion = '4.7.2' + +# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +# ClrVersion = '' + +# Processor architecture (None, X86, Amd64) required by this module +# ProcessorArchitecture = '' + +# Modules that must be imported into the global environment prior to importing this module +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '5.5.2'; }) + +# Assemblies that must be loaded prior to importing this module +RequiredAssemblies = 'AppNetwork.Autorest/bin/Az.AppNetwork.private.dll' + +# Script files (.ps1) that are run in the caller's environment prior to importing this module. +ScriptsToProcess = @() + +# Type files (.ps1xml) to be loaded when importing this module +TypesToProcess = @() + +# Format files (.ps1xml) to be loaded when importing this module +FormatsToProcess = 'AppNetwork.Autorest/Az.AppNetwork.format.ps1xml' + +# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess +NestedModules = @('AppNetwork.Autorest/Az.AppNetwork.psm1') + +# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. +FunctionsToExport = 'Get-AzAppNetworkAppLink', 'Get-AzAppNetworkAppLinkMember', + 'Get-AzAppNetworkAvailableVersion', + 'Get-AzAppNetworkUpgradeHistory', 'New-AzAppNetworkAppLink', + 'New-AzAppNetworkAppLinkMember', 'Remove-AzAppNetworkAppLink', + 'Remove-AzAppNetworkAppLinkMember', 'Set-AzAppNetworkAppLink', + 'Set-AzAppNetworkAppLinkMember', 'Update-AzAppNetworkAppLink', + 'Update-AzAppNetworkAppLinkMember' + +# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. +CmdletsToExport = @() + +# Variables to export from this module +# VariablesToExport = @() + +# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. +AliasesToExport = @() + +# DSC resources to export from this module +# DscResourcesToExport = @() + +# List of all modules packaged with this module +# ModuleList = @() + +# List of all files packaged with this module +# FileList = @() + +# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. +PrivateData = @{ + + PSData = @{ + + # Tags applied to this module. These help with module discovery in online galleries. + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'AppNetwork' + + # A URL to the license for this module. + LicenseUri = 'https://aka.ms/azps-license' + + # A URL to the main website for this project. + ProjectUri = 'https://github.com/Azure/azure-powershell' + + # A URL to an icon representing this module. + # IconUri = '' + + # ReleaseNotes of this module + # ReleaseNotes = '' + + # Prerelease string of this module + # Prerelease = '' + + # Flag to indicate whether the module requires explicit user acceptance for install/update/save + # RequireLicenseAcceptance = $false + + # External dependent modules of this module + # ExternalModuleDependencies = @() + + } # End of PSData hashtable + +} # End of PrivateData hashtable + +# HelpInfo URI of this module +# HelpInfoURI = '' + +# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. +# DefaultCommandPrefix = '' + +} + diff --git a/src/AppNetwork/AppNetwork/ChangeLog.md b/src/AppNetwork/AppNetwork/ChangeLog.md new file mode 100644 index 000000000000..40e12402d2f8 --- /dev/null +++ b/src/AppNetwork/AppNetwork/ChangeLog.md @@ -0,0 +1,28 @@ + +## Upcoming Release +* Initial onboarding of the `Az.AppNetwork` module for the `Microsoft.AppLink` resource provider (API version `2025-08-01-preview`), generated from TypeSpec. + - Added AppLink cmdlets: `Get/New/Set/Update/Remove-AzAppNetworkAppLink`. + - Added AppLinkMember cmdlets: `Get/New/Set/Update/Remove-AzAppNetworkAppLinkMember`. + - Added `Get-AzAppNetworkAvailableVersion` and `Get-AzAppNetworkUpgradeHistory`. + +## Version 0.1.0 +* First preview release for module Az.AppNetwork + diff --git a/src/AppNetwork/AppNetwork/Properties/AssemblyInfo.cs b/src/AppNetwork/AppNetwork/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..51115e80287b --- /dev/null +++ b/src/AppNetwork/AppNetwork/Properties/AssemblyInfo.cs @@ -0,0 +1,28 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using System; +using System.Reflection; +using System.Runtime.InteropServices; + +[assembly: AssemblyTitle("Microsoft Azure Powershell - AppNetwork")] +[assembly: AssemblyCompany(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyCompany)] +[assembly: AssemblyProduct(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyProduct)] +[assembly: AssemblyCopyright(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyCopyright)] + +[assembly: ComVisible(false)] +[assembly: CLSCompliant(false)] +[assembly: Guid("d1e63412-01c8-49c4-be94-3e2cfdbe29e6")] +[assembly: AssemblyVersion("0.1.0")] +[assembly: AssemblyFileVersion("0.1.0")] diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..84309454d72f --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md @@ -0,0 +1,158 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkapplink +schema: 2.0.0 +--- + +# Get-AzAppNetworkAppLink + +## SYNOPSIS +Get an AppLink. + +## SYNTAX + +### List1 (Default) +``` +Get-AzAppNetworkAppLink [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAppNetworkAppLink -InputObject [-DefaultProfile ] [] +``` + +### List +``` +Get-AzAppNetworkAppLink -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get an AppLink. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AppLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..823f226b49b0 --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLinkMember.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkapplinkmember +schema: 2.0.0 +--- + +# Get-AzAppNetworkAppLinkMember + +## SYNOPSIS +Get an AppLinkMember. + +## SYNTAX + +### List (Default) +``` +Get-AzAppNetworkAppLinkMember -AppLinkName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAppNetworkAppLinkMember -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityAppLink +``` +Get-AzAppNetworkAppLinkMember -AppLinkInputObject -Name + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get an AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: GetViaIdentityAppLink +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityAppLink +Aliases: AppLinkMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md new file mode 100644 index 000000000000..8312ed430c72 --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md @@ -0,0 +1,123 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkavailableversion +schema: 2.0.0 +--- + +# Get-AzAppNetworkAvailableVersion + +## SYNOPSIS +List AvailableVersion resources by location. + +## SYNTAX + +``` +Get-AzAppNetworkAvailableVersion -Location [-SubscriptionId ] [-KubernetesVersion ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +List AvailableVersion resources by location. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KubernetesVersion +Kubernetes version to filter profiles + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The name of the Azure region. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAvailableVersion + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md new file mode 100644 index 000000000000..ff2bbbcbde2f --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md @@ -0,0 +1,139 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkupgradehistory +schema: 2.0.0 +--- + +# Get-AzAppNetworkUpgradeHistory + +## SYNOPSIS +List UpgradeHistory resources by AppLinkMember. + +## SYNTAX + +``` +Get-AzAppNetworkUpgradeHistory -AppLinkMemberName -AppLinkName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +List UpgradeHistory resources by AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkMemberName +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IUpgradeHistory + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..57f6a7613166 --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md @@ -0,0 +1,293 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/new-azappnetworkapplink +schema: 2.0.0 +--- + +# New-AzAppNetworkAppLink + +## SYNOPSIS +Create an AppLink. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzAppNetworkAppLink -Name -ResourceGroupName -Location + [-SubscriptionId ] [-EnableSystemAssignedIdentity] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzAppNetworkAppLink -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzAppNetworkAppLink -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create an AppLink. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..f5562d1d1353 --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md @@ -0,0 +1,411 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/new-azappnetworkapplinkmember +schema: 2.0.0 +--- + +# New-AzAppNetworkAppLinkMember + +## SYNOPSIS +Create an AppLinkMember. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -Location [-SubscriptionId ] [-ClusterType ] [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-MetadataResourceId ] + [-PrivateConnectSubnetResourceId ] [-SelfManagedUpgradeProfileVersion ] [-Tag ] + [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityAppLinkExpanded +``` +New-AzAppNetworkAppLinkMember -AppLinkInputObject -Name -Location + [-ClusterType ] [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-MetadataResourceId ] + [-PrivateConnectSubnetResourceId ] [-SelfManagedUpgradeProfileVersion ] [-Tag ] + [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create an AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: CreateViaIdentityAppLinkExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +Cluster type + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EastWestGatewayVisibility +East-West gateway visibility. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullyManagedUpgradeProfileReleaseChannel +Release channel + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetadataResourceId +Resource ID + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppLinkMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateConnectSubnetResourceId +Delegated Subnet to AppLink. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelfManagedUpgradeProfileVersion +Istio version + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeProfileMode +Upgrade mode. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityAppLinkExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..b678ac0063d4 --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLink.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/remove-azappnetworkapplink +schema: 2.0.0 +--- + +# Remove-AzAppNetworkAppLink + +## SYNOPSIS +Delete an AppLink. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAppNetworkAppLink -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete an AppLink. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AppLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..4dbf87cafcc7 --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md @@ -0,0 +1,261 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/remove-azappnetworkapplinkmember +schema: 2.0.0 +--- + +# Remove-AzAppNetworkAppLinkMember + +## SYNOPSIS +Delete an AppLinkMember. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzAppNetworkAppLinkMember -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityAppLink +``` +Remove-AzAppNetworkAppLinkMember -AppLinkInputObject -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete an AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: DeleteViaIdentityAppLink +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityAppLink +Aliases: AppLinkMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..42f7dbe6c5a5 --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md @@ -0,0 +1,293 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/set-azappnetworkapplink +schema: 2.0.0 +--- + +# Set-AzAppNetworkAppLink + +## SYNOPSIS +Update an AppLink. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzAppNetworkAppLink -Name -ResourceGroupName -Location + [-SubscriptionId ] [-EnableSystemAssignedIdentity ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonFilePath +``` +Set-AzAppNetworkAppLink -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonString +``` +Set-AzAppNetworkAppLink -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update an AppLink. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..a017fe906dcb --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md @@ -0,0 +1,384 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/set-azappnetworkapplinkmember +schema: 2.0.0 +--- + +# Set-AzAppNetworkAppLinkMember + +## SYNOPSIS +Update an AppLinkMember. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -Location [-SubscriptionId ] [-ClusterType ] [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-MetadataResourceId ] + [-PrivateConnectSubnetResourceId ] [-SelfManagedUpgradeProfileVersion ] [-Tag ] + [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonFilePath +``` +Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Update an AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterType +Cluster type + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EastWestGatewayVisibility +East-West gateway visibility. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullyManagedUpgradeProfileReleaseChannel +Release channel + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MetadataResourceId +Resource ID + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: AppLinkMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateConnectSubnetResourceId +Delegated Subnet to AppLink. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelfManagedUpgradeProfileVersion +Istio version + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeProfileMode +Upgrade mode. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md new file mode 100644 index 000000000000..4a47098562d4 --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md @@ -0,0 +1,257 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/update-azappnetworkapplink +schema: 2.0.0 +--- + +# Update-AzAppNetworkAppLink + +## SYNOPSIS +Update an AppLink. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + [-EnableSystemAssignedIdentity ] [-Tag ] [-UserAssignedIdentity ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAppNetworkAppLink -InputObject [-EnableSystemAssignedIdentity ] + [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update an AppLink. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: AppLinkName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink + +## NOTES + +## RELATED LINKS + diff --git a/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md new file mode 100644 index 000000000000..71bc87913f9e --- /dev/null +++ b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md @@ -0,0 +1,371 @@ +--- +external help file: +Module Name: Az.AppNetwork +online version: https://learn.microsoft.com/powershell/module/az.appnetwork/update-azappnetworkapplinkmember +schema: 2.0.0 +--- + +# Update-AzAppNetworkAppLinkMember + +## SYNOPSIS +Update an AppLinkMember. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + [-SubscriptionId ] [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-SelfManagedUpgradeProfileVersion ] + [-Tag ] [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityAppLinkExpanded +``` +Update-AzAppNetworkAppLinkMember -AppLinkInputObject -Name + [-EastWestGatewayVisibility ] [-FullyManagedUpgradeProfileReleaseChannel ] + [-SelfManagedUpgradeProfileVersion ] [-Tag ] [-UpgradeProfileMode ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAppNetworkAppLinkMember -InputObject [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-SelfManagedUpgradeProfileVersion ] + [-Tag ] [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Update an AppLinkMember. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AppLinkInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: UpdateViaIdentityAppLinkExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -AppLinkName +The name of the AppLink + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EastWestGatewayVisibility +East-West gateway visibility. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullyManagedUpgradeProfileReleaseChannel +Release channel + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the AppLinkMember + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: AppLinkMemberName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SelfManagedUpgradeProfileVersion +Istio version + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpgradeProfileMode +Upgrade mode. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppNetworkIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember + +## NOTES + +## RELATED LINKS + diff --git a/tools/CreateMappings_rules.json b/tools/CreateMappings_rules.json index 774409aa4977..bcf3dd202e78 100644 --- a/tools/CreateMappings_rules.json +++ b/tools/CreateMappings_rules.json @@ -880,6 +880,10 @@ "module": "AppComplianceAutomation", "alias": "AppComplianceAutomation" }, + { + "module": "AppNetwork", + "alias": "AppNetwork" + }, { "module": "Informatica", "alias": "Informatica" From 7d1e67ab013b5f1e55a94ddf0707e473f6465866 Mon Sep 17 00:00:00 2001 From: German Robayo Paz Date: Fri, 7 Aug 2026 23:27:27 +0000 Subject: [PATCH 2/6] test: correct AppLink e2e assertions and add AppLinkMember lifecycle tests Fixes discovered via live testing against Azure: - New-AzAppNetworkAppLink requires -EnableSystemAssignedIdentity; the service rejects create without a SystemAssigned identity. Assert IdentityType. - Tag is a TrackedResourceTags object; access via indexer ($t['env']) not dot-notation. Fix the Update tag assertion. - Add AppLinkMember create/get/delete lifecycle tests using -ClusterType AKS, -MetadataResourceId (AKS ARM id), and FullyManaged upgrade profile. - Wire memberName and aksClusterId (AKS_CLUSTER_ID env) into test/utils.ps1; document the required AKS prerequisites (--enable-oidc-issuer --enable-aad --enable-gateway-api) and AppLink subnet delegation. Co-Authored-By: Claude Opus 4 (1M context) --- .../test/Get-AzAppNetworkAppLinkMember.Tests.ps1 | 14 ++++++++++---- .../test/New-AzAppNetworkAppLink.Tests.ps1 | 3 ++- .../test/New-AzAppNetworkAppLinkMember.Tests.ps1 | 12 ++++++++++-- .../Remove-AzAppNetworkAppLinkMember.Tests.ps1 | 7 +++++-- .../test/Update-AzAppNetworkAppLink.Tests.ps1 | 2 +- src/AppNetwork/AppNetwork.Autorest/test/utils.ps1 | 8 ++++++++ 6 files changed, 36 insertions(+), 10 deletions(-) diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLinkMember.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLinkMember.Tests.ps1 index fa6c5e3609eb..8b65611ae8d7 100644 --- a/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLinkMember.Tests.ps1 +++ b/src/AppNetwork/AppNetwork.Autorest/test/Get-AzAppNetworkAppLinkMember.Tests.ps1 @@ -15,12 +15,18 @@ if(($null -eq $TestName) -or ($TestName -contains 'Get-AzAppNetworkAppLinkMember } Describe 'Get-AzAppNetworkAppLinkMember' { - It 'List' -skip { - { throw [System.NotImplementedException] } | Should -Not -Throw + It 'List' { + { + $members = Get-AzAppNetworkAppLinkMember -AppLinkName $env.appLinkName -ResourceGroupName $env.resourceGroup + $members.Name | Should -Contain $env.memberName + } | Should -Not -Throw } - It 'Get' -skip { - { throw [System.NotImplementedException] } | Should -Not -Throw + It 'Get' { + { + $member = Get-AzAppNetworkAppLinkMember -Name $env.memberName -AppLinkName $env.appLinkName -ResourceGroupName $env.resourceGroup + $member.Name | Should -Be $env.memberName + } | Should -Not -Throw } It 'GetViaIdentityAppLink' -skip { diff --git a/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLink.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLink.Tests.ps1 index 65738b77b1b2..8d1040e4f84a 100644 --- a/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLink.Tests.ps1 +++ b/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLink.Tests.ps1 @@ -17,9 +17,10 @@ if(($null -eq $TestName) -or ($TestName -contains 'New-AzAppNetworkAppLink')) Describe 'New-AzAppNetworkAppLink' { It 'CreateExpanded' { { - $appLink = New-AzAppNetworkAppLink -Name $env.appLinkName -ResourceGroupName $env.resourceGroup -Location $env.location + $appLink = New-AzAppNetworkAppLink -Name $env.appLinkName -ResourceGroupName $env.resourceGroup -Location $env.location -EnableSystemAssignedIdentity $appLink.Name | Should -Be $env.appLinkName $appLink.Location | Should -Be $env.location + $appLink.IdentityType | Should -Be 'SystemAssigned' $appLink.ProvisioningState | Should -Be 'Succeeded' } | Should -Not -Throw } diff --git a/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLinkMember.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLinkMember.Tests.ps1 index 691f4d2627c4..9f47952f8053 100644 --- a/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLinkMember.Tests.ps1 +++ b/src/AppNetwork/AppNetwork.Autorest/test/New-AzAppNetworkAppLinkMember.Tests.ps1 @@ -15,8 +15,16 @@ if(($null -eq $TestName) -or ($TestName -contains 'New-AzAppNetworkAppLinkMember } Describe 'New-AzAppNetworkAppLinkMember' { - It 'CreateExpanded' -skip { - { throw [System.NotImplementedException] } | Should -Not -Throw + It 'CreateExpanded' { + { + $member = New-AzAppNetworkAppLinkMember -Name $env.memberName -AppLinkName $env.appLinkName -ResourceGroupName $env.resourceGroup -Location $env.location ` + -ClusterType AKS -MetadataResourceId $env.aksClusterId ` + -UpgradeProfileMode FullyManaged -FullyManagedUpgradeProfileReleaseChannel Stable + $member.Name | Should -Be $env.memberName + $member.ClusterType | Should -Be 'AKS' + $member.MetadataResourceId | Should -Be $env.aksClusterId + $member.ProvisioningState | Should -Be 'Succeeded' + } | Should -Not -Throw } It 'CreateViaJsonString' -skip { diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLinkMember.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLinkMember.Tests.ps1 index f5f566acdd09..b8cec31cd404 100644 --- a/src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLinkMember.Tests.ps1 +++ b/src/AppNetwork/AppNetwork.Autorest/test/Remove-AzAppNetworkAppLinkMember.Tests.ps1 @@ -15,8 +15,11 @@ if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzAppNetworkAppLinkMem } Describe 'Remove-AzAppNetworkAppLinkMember' { - It 'Delete' -skip { - { throw [System.NotImplementedException] } | Should -Not -Throw + It 'Delete' { + { + Remove-AzAppNetworkAppLinkMember -Name $env.memberName -AppLinkName $env.appLinkName -ResourceGroupName $env.resourceGroup + { Get-AzAppNetworkAppLinkMember -Name $env.memberName -AppLinkName $env.appLinkName -ResourceGroupName $env.resourceGroup -ErrorAction Stop } | Should -Throw + } | Should -Not -Throw } It 'DeleteViaIdentityAppLink' -skip { diff --git a/src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLink.Tests.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLink.Tests.ps1 index fc499d6599f1..2c91e03e6465 100644 --- a/src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLink.Tests.ps1 +++ b/src/AppNetwork/AppNetwork.Autorest/test/Update-AzAppNetworkAppLink.Tests.ps1 @@ -18,7 +18,7 @@ Describe 'Update-AzAppNetworkAppLink' { It 'UpdateExpanded' { { $appLink = Update-AzAppNetworkAppLink -Name $env.appLinkName -ResourceGroupName $env.resourceGroup -Tag @{ env = 'test' } - $appLink.Tag.env | Should -Be 'test' + $appLink.Tag['env'] | Should -Be 'test' } | Should -Not -Throw } diff --git a/src/AppNetwork/AppNetwork.Autorest/test/utils.ps1 b/src/AppNetwork/AppNetwork.Autorest/test/utils.ps1 index 9a6bdbd428b8..fcc0c6c009c2 100644 --- a/src/AppNetwork/AppNetwork.Autorest/test/utils.ps1 +++ b/src/AppNetwork/AppNetwork.Autorest/test/utils.ps1 @@ -47,6 +47,14 @@ function setupEnv() { $env.location = 'eastus' $env.resourceGroup = 'appnetwork-test-' + (RandomString -allChars $false -len 6) $env.appLinkName = 'applink-' + (RandomString -allChars $false -len 6) + $env.memberName = 'member-' + (RandomString -allChars $false -len 6) + # AKS cluster used as the AppLinkMember target. It must be created with the + # AppLink prerequisites enabled: + # az aks create ... --enable-oidc-issuer --enable-aad --enable-gateway-api + # Provide an existing cluster's ARM resource id via $env.aksClusterId, or set + # AKS_CLUSTER_ID before recording. AppLinkMember provisioning is a service-side + # mesh onboarding operation, so the target cluster must already be reachable. + $env.aksClusterId = $env:AKS_CLUSTER_ID if ($TestMode -ne 'playback') { Write-Host "Creating resource group $($env.resourceGroup) in $($env.location)" New-AzResourceGroup -Name $env.resourceGroup -Location $env.location | Out-Null From e963f57b7e383c01a2400e7162d9504d1e8d3d0b Mon Sep 17 00:00:00 2001 From: German Robayo Paz Date: Mon, 10 Aug 2026 20:42:30 +0000 Subject: [PATCH 3/6] docs: add cmdlet examples mirroring the appnet-preview Azure CLI extension Replace the generated example placeholders for all Az.AppNetwork cmdlets with real examples adapted from the appnet-preview CLI extension (Azure/azure-cli-extensions src/appnet-preview), translating each az appnet / az appnet member command to its PowerShell equivalent: - AppLink: create/show/list/update/delete - AppLinkMember: join (New), show/list, update, remove - AvailableVersion and UpgradeHistory list examples Regenerated docs/*.md so the EXAMPLES sections pick up the new content. Co-Authored-By: Claude Opus 4 (1M context) --- .../docs/Get-AzAppNetworkAppLink.md | 34 ++++++++++++++----- .../docs/Get-AzAppNetworkAppLinkMember.md | 21 +++++++----- .../docs/Get-AzAppNetworkAvailableVersion.md | 22 ++++-------- .../docs/Get-AzAppNetworkUpgradeHistory.md | 21 ++++-------- .../docs/New-AzAppNetworkAppLink.md | 20 ++++++----- .../docs/New-AzAppNetworkAppLinkMember.md | 26 +++++++++----- .../docs/Remove-AzAppNetworkAppLink.md | 21 ++---------- .../docs/Remove-AzAppNetworkAppLinkMember.md | 21 ++---------- .../docs/Set-AzAppNetworkAppLink.md | 21 ++++-------- .../docs/Set-AzAppNetworkAppLinkMember.md | 24 +++++-------- .../docs/Update-AzAppNetworkAppLink.md | 21 ++++-------- .../docs/Update-AzAppNetworkAppLinkMember.md | 20 ++++++----- .../examples/Get-AzAppNetworkAppLink.md | 33 +++++++++++++----- .../examples/Get-AzAppNetworkAppLinkMember.md | 22 +++++++----- .../Get-AzAppNetworkAvailableVersion.md | 23 ++++--------- .../Get-AzAppNetworkUpgradeHistory.md | 22 ++++-------- .../examples/New-AzAppNetworkAppLink.md | 21 +++++++----- .../examples/New-AzAppNetworkAppLinkMember.md | 27 ++++++++++----- .../examples/Remove-AzAppNetworkAppLink.md | 22 ++---------- .../Remove-AzAppNetworkAppLinkMember.md | 22 ++---------- .../examples/Set-AzAppNetworkAppLink.md | 22 ++++-------- .../examples/Set-AzAppNetworkAppLinkMember.md | 25 +++++--------- .../examples/Update-AzAppNetworkAppLink.md | 22 ++++-------- .../Update-AzAppNetworkAppLinkMember.md | 21 +++++++----- 24 files changed, 241 insertions(+), 313 deletions(-) diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md index 84309454d72f..e6fbc528c5d9 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md @@ -39,27 +39,45 @@ Get an AppLink. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List Application Networks in the current subscription ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLink ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg +appnet-test-02 eastus Succeeded other_rg ``` -{{ Add description here }} +Lists all Application Network resources in the current subscription. -### Example 2: {{ Add title here }} +### Example 2: List Application Networks in a resource group ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLink -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg ``` -{{ Add description here }} +Lists the Application Network resources in the `test_rg` resource group. + +### Example 3: Get an Application Network resource +```powershell +Get-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg +``` + +Gets the details of the Application Network resource named `appnet-test-01`. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md index 823f226b49b0..7167489caf49 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md @@ -41,27 +41,32 @@ Get an AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List members of an Application Network resource ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLinkMember -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg +member-02 AKS Succeeded test_rg ``` -{{ Add description here }} +Lists all members of the `appnet-test-01` Application Network resource. -### Example 2: {{ Add title here }} +### Example 2: Get a member of an Application Network resource ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Gets the `member-01` member of the `appnet-test-01` Application Network resource. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAvailableVersion.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAvailableVersion.md index 8312ed430c72..8168d32df116 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAvailableVersion.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAvailableVersion.md @@ -22,27 +22,19 @@ List AvailableVersion resources by location. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List available Application Network versions in a location ```powershell -{{ Add code here }} +Get-AzAppNetworkAvailableVersion -Location westus2 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Version Support +------- ------- +1.4 Supported +1.3 Supported ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Lists the Application Network versions available in the `westus2` location. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md index ff2bbbcbde2f..0868f969cd4f 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md @@ -22,27 +22,18 @@ List UpgradeHistory resources by AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List the upgrade history of an Application Network member ```powershell -{{ Add code here }} +Get-AzAppNetworkUpgradeHistory -AppLinkMemberName member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +FromVersion ToVersion InitiatedBy StartTimestamp EndTimestamp +----------- --------- ----------- -------------- ------------ +1.3 1.4 Admin 2025-09-24T10:30:00Z 2025-09-25T00:00:00Z ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Lists the upgrade history of the `member-01` member of the `appnet-test-01` Application Network resource. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md index 57f6a7613166..35a13a1de489 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md @@ -39,27 +39,31 @@ Create an AppLink. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Create an Application Network resource ```powershell -{{ Add code here }} +New-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Location westus2 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg ``` -{{ Add description here }} +Creates an Azure Kubernetes Application Network resource named `appnet-test-01` in the `test_rg` resource group. -### Example 2: {{ Add title here }} +### Example 2: Create an Application Network resource with a system-assigned identity ```powershell -{{ Add code here }} +New-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Location westus2 -EnableSystemAssignedIdentity ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState IdentityType ResourceGroupName +---- -------- ----------------- ------------ ----------------- +appnet-test-01 westus2 Succeeded SystemAssigned test_rg ``` -{{ Add description here }} +Creates an Application Network resource with a system-assigned managed identity enabled. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md index f5562d1d1353..a7774ee44155 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md @@ -51,27 +51,37 @@ Create an AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Join an AKS cluster to an Application Network using fully managed upgrades ```powershell -{{ Add code here }} +New-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -Location westus2 ` + -ClusterType AKS ` + -MetadataResourceId '/subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/test-rg/providers/Microsoft.ContainerService/managedClusters/test-member1' ` + -UpgradeProfileMode FullyManaged -FullyManagedUpgradeProfileReleaseChannel Stable ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Joins an AKS cluster to the `appnet-test-01` Application Network as member `member-01`, using the fully managed upgrade mode on the `Stable` release channel. -### Example 2: {{ Add title here }} +### Example 2: Join an AKS cluster to an Application Network using self managed upgrades ```powershell -{{ Add code here }} +New-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -Location westus2 ` + -ClusterType AKS ` + -MetadataResourceId '/subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/test-rg/providers/Microsoft.ContainerService/managedClusters/test-member1' ` + -UpgradeProfileMode SelfManaged -SelfManagedUpgradeProfileVersion 1.4 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Joins an AKS cluster to the `appnet-test-01` Application Network as member `member-01`, using the self managed upgrade mode pinned to Application Network version `1.4`. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md index b678ac0063d4..e0f4a8fb3b59 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md @@ -29,27 +29,12 @@ Delete an AppLink. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Delete an Application Network resource ```powershell -{{ Add code here }} +Remove-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg ``` -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Deletes the Application Network resource named `appnet-test-01` from the `test_rg` resource group. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md index 4dbf87cafcc7..389a8b9e02a9 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md @@ -36,27 +36,12 @@ Delete an AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Remove a member from an Application Network ```powershell -{{ Add code here }} +Remove-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Removes the `member-01` member from the `appnet-test-01` Application Network resource. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md index 42f7dbe6c5a5..241f9ecc60dc 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md @@ -39,27 +39,18 @@ Update an AppLink. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Replace an Application Network resource ```powershell -{{ Add code here }} +Set-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Location westus2 -EnableSystemAssignedIdentity -Tag @{ key2913 = 'test_tag' } ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState IdentityType ResourceGroupName +---- -------- ----------------- ------------ ----------------- +appnet-test-01 westus2 Succeeded SystemAssigned test_rg ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Creates or replaces the Application Network resource named `appnet-test-01` with the specified location, identity, and tags. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md index a017fe906dcb..15de02fcc11e 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md @@ -41,27 +41,21 @@ Update an AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Create or replace an Application Network member ```powershell -{{ Add code here }} +Set-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -Location westus2 ` + -ClusterType AKS ` + -MetadataResourceId '/subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/test-rg/providers/Microsoft.ContainerService/managedClusters/test-member1' ` + -UpgradeProfileMode FullyManaged -FullyManagedUpgradeProfileReleaseChannel Stable ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Creates or replaces the `member-01` member of the `appnet-test-01` Application Network resource with the fully managed upgrade profile. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md index 4a47098562d4..5f81dfc8526d 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md @@ -31,27 +31,18 @@ Update an AppLink. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Update the tags of an Application Network resource ```powershell -{{ Add code here }} +Update-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Tag @{ key2913 = 'test_tag' } ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Updates the tags of the Application Network resource named `appnet-test-01`. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md index 71bc87913f9e..01425f10f04b 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md @@ -56,27 +56,31 @@ Update an AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Update the release channel of an Application Network member ```powershell -{{ Add code here }} +Update-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -FullyManagedUpgradeProfileReleaseChannel Stable ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Updates the fully managed release channel of the `member-01` Application Network member to `Stable`. -### Example 2: {{ Add title here }} +### Example 2: Update the Application Network version of a self managed member ```powershell -{{ Add code here }} +Update-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -SelfManagedUpgradeProfileVersion 1.4 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Updates the self managed Application Network version of the `member-01` member to `1.4`. ## PARAMETERS diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLink.md index 0371f56c36d2..08cc751d6b11 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLink.md @@ -1,22 +1,39 @@ -### Example 1: {{ Add title here }} +### Example 1: List Application Networks in the current subscription ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLink ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg +appnet-test-02 eastus Succeeded other_rg ``` -{{ Add description here }} +Lists all Application Network resources in the current subscription. -### Example 2: {{ Add title here }} +### Example 2: List Application Networks in a resource group ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLink -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg ``` -{{ Add description here }} +Lists the Application Network resources in the `test_rg` resource group. +### Example 3: Get an Application Network resource +```powershell +Get-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg +``` + +Gets the details of the Application Network resource named `appnet-test-01`. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLinkMember.md index 0371f56c36d2..4bf3eb871c24 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAppLinkMember.md @@ -1,22 +1,26 @@ -### Example 1: {{ Add title here }} +### Example 1: List members of an Application Network resource ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLinkMember -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg +member-02 AKS Succeeded test_rg ``` -{{ Add description here }} +Lists all members of the `appnet-test-01` Application Network resource. -### Example 2: {{ Add title here }} +### Example 2: Get a member of an Application Network resource ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} - +Gets the `member-01` member of the `appnet-test-01` Application Network resource. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAvailableVersion.md b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAvailableVersion.md index 0371f56c36d2..99d920e1b5a6 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAvailableVersion.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkAvailableVersion.md @@ -1,22 +1,13 @@ -### Example 1: {{ Add title here }} +### Example 1: List available Application Network versions in a location ```powershell -{{ Add code here }} +Get-AzAppNetworkAvailableVersion -Location westus2 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Version Support +------- ------- +1.4 Supported +1.3 Supported ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - +Lists the Application Network versions available in the `westus2` location. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkUpgradeHistory.md b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkUpgradeHistory.md index 0371f56c36d2..69414016dc0a 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkUpgradeHistory.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Get-AzAppNetworkUpgradeHistory.md @@ -1,22 +1,12 @@ -### Example 1: {{ Add title here }} +### Example 1: List the upgrade history of an Application Network member ```powershell -{{ Add code here }} +Get-AzAppNetworkUpgradeHistory -AppLinkMemberName member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +FromVersion ToVersion InitiatedBy StartTimestamp EndTimestamp +----------- --------- ----------- -------------- ------------ +1.3 1.4 Admin 2025-09-24T10:30:00Z 2025-09-25T00:00:00Z ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - +Lists the upgrade history of the `member-01` member of the `appnet-test-01` Application Network resource. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLink.md index 0371f56c36d2..359ba9be2bd8 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLink.md @@ -1,22 +1,25 @@ -### Example 1: {{ Add title here }} +### Example 1: Create an Application Network resource ```powershell -{{ Add code here }} +New-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Location westus2 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg ``` -{{ Add description here }} +Creates an Azure Kubernetes Application Network resource named `appnet-test-01` in the `test_rg` resource group. -### Example 2: {{ Add title here }} +### Example 2: Create an Application Network resource with a system-assigned identity ```powershell -{{ Add code here }} +New-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Location westus2 -EnableSystemAssignedIdentity ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState IdentityType ResourceGroupName +---- -------- ----------------- ------------ ----------------- +appnet-test-01 westus2 Succeeded SystemAssigned test_rg ``` -{{ Add description here }} - +Creates an Application Network resource with a system-assigned managed identity enabled. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLinkMember.md index 0371f56c36d2..5263fe1fb52d 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/New-AzAppNetworkAppLinkMember.md @@ -1,22 +1,31 @@ -### Example 1: {{ Add title here }} +### Example 1: Join an AKS cluster to an Application Network using fully managed upgrades ```powershell -{{ Add code here }} +New-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -Location westus2 ` + -ClusterType AKS ` + -MetadataResourceId '/subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/test-rg/providers/Microsoft.ContainerService/managedClusters/test-member1' ` + -UpgradeProfileMode FullyManaged -FullyManagedUpgradeProfileReleaseChannel Stable ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Joins an AKS cluster to the `appnet-test-01` Application Network as member `member-01`, using the fully managed upgrade mode on the `Stable` release channel. -### Example 2: {{ Add title here }} +### Example 2: Join an AKS cluster to an Application Network using self managed upgrades ```powershell -{{ Add code here }} +New-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -Location westus2 ` + -ClusterType AKS ` + -MetadataResourceId '/subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/test-rg/providers/Microsoft.ContainerService/managedClusters/test-member1' ` + -UpgradeProfileMode SelfManaged -SelfManagedUpgradeProfileVersion 1.4 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} - +Joins an AKS cluster to the `appnet-test-01` Application Network as member `member-01`, using the self managed upgrade mode pinned to Application Network version `1.4`. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLink.md index 0371f56c36d2..c9a279ea863f 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLink.md @@ -1,22 +1,6 @@ -### Example 1: {{ Add title here }} +### Example 1: Delete an Application Network resource ```powershell -{{ Add code here }} +Remove-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg ``` -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - +Deletes the Application Network resource named `appnet-test-01` from the `test_rg` resource group. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLinkMember.md index 0371f56c36d2..7fc949e41766 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Remove-AzAppNetworkAppLinkMember.md @@ -1,22 +1,6 @@ -### Example 1: {{ Add title here }} +### Example 1: Remove a member from an Application Network ```powershell -{{ Add code here }} +Remove-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - +Removes the `member-01` member from the `appnet-test-01` Application Network resource. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLink.md index 0371f56c36d2..a2cfadbab047 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLink.md @@ -1,22 +1,12 @@ -### Example 1: {{ Add title here }} +### Example 1: Replace an Application Network resource ```powershell -{{ Add code here }} +Set-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Location westus2 -EnableSystemAssignedIdentity -Tag @{ key2913 = 'test_tag' } ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState IdentityType ResourceGroupName +---- -------- ----------------- ------------ ----------------- +appnet-test-01 westus2 Succeeded SystemAssigned test_rg ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - +Creates or replaces the Application Network resource named `appnet-test-01` with the specified location, identity, and tags. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLinkMember.md index 0371f56c36d2..4d980aad8aa7 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Set-AzAppNetworkAppLinkMember.md @@ -1,22 +1,15 @@ -### Example 1: {{ Add title here }} +### Example 1: Create or replace an Application Network member ```powershell -{{ Add code here }} +Set-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -Location westus2 ` + -ClusterType AKS ` + -MetadataResourceId '/subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/test-rg/providers/Microsoft.ContainerService/managedClusters/test-member1' ` + -UpgradeProfileMode FullyManaged -FullyManagedUpgradeProfileReleaseChannel Stable ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - +Creates or replaces the `member-01` member of the `appnet-test-01` Application Network resource with the fully managed upgrade profile. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLink.md index 0371f56c36d2..4dfc42f4b66c 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLink.md @@ -1,22 +1,12 @@ -### Example 1: {{ Add title here }} +### Example 1: Update the tags of an Application Network resource ```powershell -{{ Add code here }} +Update-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Tag @{ key2913 = 'test_tag' } ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - +Updates the tags of the Application Network resource named `appnet-test-01`. diff --git a/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLinkMember.md index 0371f56c36d2..7cbb9b4e905b 100644 --- a/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/examples/Update-AzAppNetworkAppLinkMember.md @@ -1,22 +1,25 @@ -### Example 1: {{ Add title here }} +### Example 1: Update the release channel of an Application Network member ```powershell -{{ Add code here }} +Update-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -FullyManagedUpgradeProfileReleaseChannel Stable ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Updates the fully managed release channel of the `member-01` Application Network member to `Stable`. -### Example 2: {{ Add title here }} +### Example 2: Update the Application Network version of a self managed member ```powershell -{{ Add code here }} +Update-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -SelfManagedUpgradeProfileVersion 1.4 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} - +Updates the self managed Application Network version of the `member-01` member to `1.4`. From e5b38bb31dcca1fe4e141dad7314986b756c85e7 Mon Sep 17 00:00:00 2001 From: German Robayo Paz Date: Mon, 10 Aug 2026 23:03:21 +0000 Subject: [PATCH 4/6] docs: regenerate platyPS help with the new cmdlet examples The earlier examples commit updated the AutoRest docs/*.md but the committed platyPS help/*.md files still contained the placeholder examples. Regenerate help/*.md via generate-help.ps1 so both doc sets are consistent and carry the appnet-preview-derived examples. Co-Authored-By: Claude Opus 4 (1M context) --- .../help/Get-AzAppNetworkAppLink.md | 51 ++++++++----- .../help/Get-AzAppNetworkAppLinkMember.md | 45 ++++++------ .../help/Get-AzAppNetworkAvailableVersion.md | 25 +++---- .../help/Get-AzAppNetworkUpgradeHistory.md | 27 +++---- .../help/New-AzAppNetworkAppLink.md | 41 ++++++----- .../help/New-AzAppNetworkAppLinkMember.md | 71 ++++++++++-------- .../help/Remove-AzAppNetworkAppLink.md | 29 ++------ .../help/Remove-AzAppNetworkAppLinkMember.md | 41 ++++------- .../help/Set-AzAppNetworkAppLink.md | 46 +++++------- .../help/Set-AzAppNetworkAppLinkMember.md | 41 +++++------ .../help/Update-AzAppNetworkAppLink.md | 35 ++++----- .../help/Update-AzAppNetworkAppLinkMember.md | 72 ++++++++++--------- 12 files changed, 245 insertions(+), 279 deletions(-) diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md index 84309454d72f..faba88167517 100644 --- a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkapplink schema: 2.0.0 @@ -14,7 +14,8 @@ Get an AppLink. ### List1 (Default) ``` -Get-AzAppNetworkAppLink [-SubscriptionId ] [-DefaultProfile ] [] +Get-AzAppNetworkAppLink [-SubscriptionId ] [-DefaultProfile ] + [] ``` ### Get @@ -23,14 +24,15 @@ Get-AzAppNetworkAppLink -Name -ResourceGroupName [-Subscriptio [-DefaultProfile ] [] ``` -### GetViaIdentity +### List ``` -Get-AzAppNetworkAppLink -InputObject [-DefaultProfile ] [] +Get-AzAppNetworkAppLink -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] ``` -### List +### GetViaIdentity ``` -Get-AzAppNetworkAppLink -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] +Get-AzAppNetworkAppLink -InputObject [-DefaultProfile ] [] ``` @@ -39,27 +41,45 @@ Get an AppLink. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List Application Networks in the current subscription ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLink ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg +appnet-test-02 eastus Succeeded other_rg ``` -{{ Add description here }} +Lists all Application Network resources in the current subscription. -### Example 2: {{ Add title here }} +### Example 2: List Application Networks in a resource group ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLink -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg ``` -{{ Add description here }} +Lists the Application Network resources in the `test_rg` resource group. + +### Example 3: Get an Application Network resource +```powershell +Get-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg +``` + +```output +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg +``` + +Gets the details of the Application Network resource named `appnet-test-01`. ## PARAMETERS @@ -131,7 +151,7 @@ The value must be an UUID. ```yaml Type: System.String[] -Parameter Sets: Get, List, List1 +Parameter Sets: List1, Get, List Aliases: Required: False @@ -155,4 +175,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLinkMember.md index 823f226b49b0..eb51c76b3500 100644 --- a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLinkMember.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkapplinkmember schema: 2.0.0 @@ -21,47 +21,53 @@ Get-AzAppNetworkAppLinkMember -AppLinkName -ResourceGroupName ### Get ``` Get-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzAppNetworkAppLinkMember -InputObject [-DefaultProfile ] + [-SubscriptionId ] [-DefaultProfile ] [] ``` ### GetViaIdentityAppLink ``` -Get-AzAppNetworkAppLinkMember -AppLinkInputObject -Name +Get-AzAppNetworkAppLinkMember -Name -AppLinkInputObject [-DefaultProfile ] [] ``` +### GetViaIdentity +``` +Get-AzAppNetworkAppLinkMember -InputObject [-DefaultProfile ] + [] +``` + ## DESCRIPTION Get an AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List members of an Application Network resource ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLinkMember -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg +member-02 AKS Succeeded test_rg ``` -{{ Add description here }} +Lists all members of the `appnet-test-01` Application Network resource. -### Example 2: {{ Add title here }} +### Example 2: Get a member of an Application Network resource ```powershell -{{ Add code here }} +Get-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Gets the `member-01` member of the `appnet-test-01` Application Network resource. ## PARAMETERS @@ -85,7 +91,7 @@ The name of the AppLink ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -147,7 +153,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -163,7 +169,7 @@ The value must be an UUID. ```yaml Type: System.String[] -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: False @@ -187,4 +193,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md index 8312ed430c72..0efbd4ecdc6c 100644 --- a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkavailableversion schema: 2.0.0 @@ -22,27 +22,19 @@ List AvailableVersion resources by location. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List available Application Network versions in a location ```powershell -{{ Add code here }} +Get-AzAppNetworkAvailableVersion -Location westus2 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Version Support +------- ------- +1.4 Supported +1.3 Supported ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Lists the Application Network versions available in the `westus2` location. ## PARAMETERS @@ -120,4 +112,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md index ff2bbbcbde2f..3c18f2968e85 100644 --- a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/get-azappnetworkupgradehistory schema: 2.0.0 @@ -14,7 +14,8 @@ List UpgradeHistory resources by AppLinkMember. ``` Get-AzAppNetworkUpgradeHistory -AppLinkMemberName -AppLinkName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -22,27 +23,18 @@ List UpgradeHistory resources by AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: List the upgrade history of an Application Network member ```powershell -{{ Add code here }} +Get-AzAppNetworkUpgradeHistory -AppLinkMemberName member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +FromVersion ToVersion InitiatedBy StartTimestamp EndTimestamp +----------- --------- ----------- -------------- ------------ +1.3 1.4 Admin 2025-09-24T10:30:00Z 2025-09-25T00:00:00Z ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Lists the upgrade history of the `member-01` member of the `appnet-test-01` Application Network resource. ## PARAMETERS @@ -136,4 +128,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md index 57f6a7613166..a155cbb9701a 100644 --- a/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/new-azappnetworkapplink schema: 2.0.0 @@ -14,24 +14,24 @@ Create an AppLink. ### CreateExpanded (Default) ``` -New-AzAppNetworkAppLink -Name -ResourceGroupName -Location - [-SubscriptionId ] [-EnableSystemAssignedIdentity] [-Tag ] - [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] +New-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + -Location [-EnableSystemAssignedIdentity] [-Tag ] [-UserAssignedIdentity ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` -New-AzAppNetworkAppLink -Name -ResourceGroupName -JsonFilePath - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] +New-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` -New-AzAppNetworkAppLink -Name -ResourceGroupName -JsonString - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] +New-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,27 +39,31 @@ Create an AppLink. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Create an Application Network resource ```powershell -{{ Add code here }} +New-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Location westus2 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg ``` -{{ Add description here }} +Creates an Azure Kubernetes Application Network resource named `appnet-test-01` in the `test_rg` resource group. -### Example 2: {{ Add title here }} +### Example 2: Create an Application Network resource with a system-assigned identity ```powershell -{{ Add code here }} +New-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Location westus2 -EnableSystemAssignedIdentity ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState IdentityType ResourceGroupName +---- -------- ----------------- ------------ ----------------- +appnet-test-01 westus2 Succeeded SystemAssigned test_rg ``` -{{ Add description here }} +Creates an Application Network resource with a system-assigned managed identity enabled. ## PARAMETERS @@ -290,4 +294,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md index f5562d1d1353..6f4d04f0a705 100644 --- a/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/new-azappnetworkapplinkmember schema: 2.0.0 @@ -14,36 +14,36 @@ Create an AppLinkMember. ### CreateExpanded (Default) ``` -New-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName - -Location [-SubscriptionId ] [-ClusterType ] [-EastWestGatewayVisibility ] +New-AzAppNetworkAppLinkMember -Name -AppLinkName -ResourceGroupName + [-SubscriptionId ] -Location [-ClusterType ] [-EastWestGatewayVisibility ] [-FullyManagedUpgradeProfileReleaseChannel ] [-MetadataResourceId ] [-PrivateConnectSubnetResourceId ] [-SelfManagedUpgradeProfileVersion ] [-Tag ] - [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] + [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` -### CreateViaIdentityAppLinkExpanded +### CreateViaJsonString ``` -New-AzAppNetworkAppLinkMember -AppLinkInputObject -Name -Location - [-ClusterType ] [-EastWestGatewayVisibility ] - [-FullyManagedUpgradeProfileReleaseChannel ] [-MetadataResourceId ] - [-PrivateConnectSubnetResourceId ] [-SelfManagedUpgradeProfileVersion ] [-Tag ] - [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] +New-AzAppNetworkAppLinkMember -Name -AppLinkName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` -New-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName - -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] +New-AzAppNetworkAppLinkMember -Name -AppLinkName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` -### CreateViaJsonString +### CreateViaIdentityAppLinkExpanded ``` -New-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName - -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] +New-AzAppNetworkAppLinkMember -Name -AppLinkInputObject -Location + [-ClusterType ] [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-MetadataResourceId ] + [-PrivateConnectSubnetResourceId ] [-SelfManagedUpgradeProfileVersion ] [-Tag ] + [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -51,27 +51,37 @@ Create an AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Join an AKS cluster to an Application Network using fully managed upgrades ```powershell -{{ Add code here }} +New-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -Location westus2 ` + -ClusterType AKS ` + -MetadataResourceId '/subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/test-rg/providers/Microsoft.ContainerService/managedClusters/test-member1' ` + -UpgradeProfileMode FullyManaged -FullyManagedUpgradeProfileReleaseChannel Stable ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Joins an AKS cluster to the `appnet-test-01` Application Network as member `member-01`, using the fully managed upgrade mode on the `Stable` release channel. -### Example 2: {{ Add title here }} +### Example 2: Join an AKS cluster to an Application Network using self managed upgrades ```powershell -{{ Add code here }} +New-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -Location westus2 ` + -ClusterType AKS ` + -MetadataResourceId '/subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/test-rg/providers/Microsoft.ContainerService/managedClusters/test-member1' ` + -UpgradeProfileMode SelfManaged -SelfManagedUpgradeProfileVersion 1.4 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Joins an AKS cluster to the `appnet-test-01` Application Network as member `member-01`, using the self managed upgrade mode pinned to Application Network version `1.4`. ## PARAMETERS @@ -95,7 +105,7 @@ The name of the AppLink ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -292,7 +302,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -323,7 +333,7 @@ The value must be an UUID. ```yaml Type: System.String -Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -408,4 +418,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLink.md index b678ac0063d4..4bab582c9200 100644 --- a/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLink.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/remove-azappnetworkapplink schema: 2.0.0 @@ -15,13 +15,14 @@ Delete an AppLink. ### Delete (Default) ``` Remove-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzAppNetworkAppLink -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-Confirm] [-WhatIf] [] + [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,27 +30,12 @@ Delete an AppLink. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Delete an Application Network resource ```powershell -{{ Add code here }} +Remove-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg ``` -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Deletes the Application Network resource named `appnet-test-01` from the `test_rg` resource group. ## PARAMETERS @@ -221,4 +207,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md index 4dbf87cafcc7..ff5475e27f4c 100644 --- a/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/remove-azappnetworkapplinkmember schema: 2.0.0 @@ -15,20 +15,21 @@ Delete an AppLinkMember. ### Delete (Default) ``` Remove-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] ``` -### DeleteViaIdentity +### DeleteViaIdentityAppLink ``` -Remove-AzAppNetworkAppLinkMember -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +Remove-AzAppNetworkAppLinkMember -Name -AppLinkInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] ``` -### DeleteViaIdentityAppLink +### DeleteViaIdentity ``` -Remove-AzAppNetworkAppLinkMember -AppLinkInputObject -Name - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +Remove-AzAppNetworkAppLinkMember -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,27 +37,12 @@ Delete an AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Remove a member from an Application Network ```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Remove-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Removes the `member-01` member from the `appnet-test-01` Application Network resource. ## PARAMETERS @@ -258,4 +244,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md index 42f7dbe6c5a5..79c30eb6232b 100644 --- a/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/set-azappnetworkapplink schema: 2.0.0 @@ -14,24 +14,24 @@ Update an AppLink. ### UpdateExpanded (Default) ``` -Set-AzAppNetworkAppLink -Name -ResourceGroupName -Location - [-SubscriptionId ] [-EnableSystemAssignedIdentity ] [-Tag ] - [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] +Set-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + -Location [-EnableSystemAssignedIdentity ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaJsonFilePath ``` -Set-AzAppNetworkAppLink -Name -ResourceGroupName -JsonFilePath - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] +Set-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaJsonString ``` -Set-AzAppNetworkAppLink -Name -ResourceGroupName -JsonString - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] +Set-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,27 +39,18 @@ Update an AppLink. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Replace an Application Network resource ```powershell -{{ Add code here }} +Set-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Location westus2 -EnableSystemAssignedIdentity -Tag @{ key2913 = 'test_tag' } ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState IdentityType ResourceGroupName +---- -------- ----------------- ------------ ----------------- +appnet-test-01 westus2 Succeeded SystemAssigned test_rg ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Creates or replaces the Application Network resource named `appnet-test-01` with the specified location, identity, and tags. ## PARAMETERS @@ -98,7 +89,7 @@ Accept wildcard characters: False Determines whether to enable a system-assigned identity for the resource. ```yaml -Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Nullable`1[System.Boolean] Parameter Sets: UpdateExpanded Aliases: @@ -290,4 +281,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md index a017fe906dcb..c1300b514e49 100644 --- a/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/set-azappnetworkapplinkmember schema: 2.0.0 @@ -15,25 +15,25 @@ Update an AppLinkMember. ### UpdateExpanded (Default) ``` Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName - -Location [-SubscriptionId ] [-ClusterType ] [-EastWestGatewayVisibility ] + [-SubscriptionId ] -Location [-ClusterType ] [-EastWestGatewayVisibility ] [-FullyManagedUpgradeProfileReleaseChannel ] [-MetadataResourceId ] [-PrivateConnectSubnetResourceId ] [-SelfManagedUpgradeProfileVersion ] [-Tag ] - [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] + [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaJsonFilePath ``` Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName - -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaJsonString ``` Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName - -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,27 +41,21 @@ Update an AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Create or replace an Application Network member ```powershell -{{ Add code here }} +Set-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -Location westus2 ` + -ClusterType AKS ` + -MetadataResourceId '/subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/test-rg/providers/Microsoft.ContainerService/managedClusters/test-member1' ` + -UpgradeProfileMode FullyManaged -FullyManagedUpgradeProfileReleaseChannel Stable ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Creates or replaces the `member-01` member of the `appnet-test-01` Application Network resource with the fully managed upgrade profile. ## PARAMETERS @@ -381,4 +375,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md index 4a47098562d4..a997ecb54ff0 100644 --- a/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/update-azappnetworkapplink schema: 2.0.0 @@ -15,15 +15,16 @@ Update an AppLink. ### UpdateExpanded (Default) ``` Update-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] - [-EnableSystemAssignedIdentity ] [-Tag ] [-UserAssignedIdentity ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] + [-EnableSystemAssignedIdentity ] [-Tag ] [-UserAssignedIdentity ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzAppNetworkAppLink -InputObject [-EnableSystemAssignedIdentity ] +Update-AzAppNetworkAppLink -InputObject [-EnableSystemAssignedIdentity ] [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-Confirm] [-WhatIf] [] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,27 +32,18 @@ Update an AppLink. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Update the tags of an Application Network resource ```powershell -{{ Add code here }} +Update-AzAppNetworkAppLink -Name appnet-test-01 -ResourceGroupName test_rg -Tag @{ key2913 = 'test_tag' } ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name Location ProvisioningState ResourceGroupName +---- -------- ----------------- ----------------- +appnet-test-01 westus2 Succeeded test_rg ``` -{{ Add description here }} - -### Example 2: {{ Add title here }} -```powershell -{{ Add code here }} -``` - -```output -{{ Add output here (remove the output block if the example doesn't have an output) }} -``` - -{{ Add description here }} +Updates the tags of the Application Network resource named `appnet-test-01`. ## PARAMETERS @@ -90,7 +82,7 @@ Accept wildcard characters: False Determines whether to enable a system-assigned identity for the resource. ```yaml -Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Type: System.Nullable`1[System.Boolean] Parameter Sets: (All) Aliases: @@ -254,4 +246,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md index 71bc87913f9e..794e06aba602 100644 --- a/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.AppNetwork-help.xml Module Name: Az.AppNetwork online version: https://learn.microsoft.com/powershell/module/az.appnetwork/update-azappnetworkapplinkmember schema: 2.0.0 @@ -17,38 +17,39 @@ Update an AppLinkMember. Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName [-SubscriptionId ] [-EastWestGatewayVisibility ] [-FullyManagedUpgradeProfileReleaseChannel ] [-SelfManagedUpgradeProfileVersion ] - [-Tag ] [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] + [-Tag ] [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` -### UpdateViaIdentityAppLinkExpanded +### UpdateViaJsonString ``` -Update-AzAppNetworkAppLinkMember -AppLinkInputObject -Name - [-EastWestGatewayVisibility ] [-FullyManagedUpgradeProfileReleaseChannel ] - [-SelfManagedUpgradeProfileVersion ] [-Tag ] [-UpgradeProfileMode ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` -### UpdateViaIdentityExpanded +### UpdateViaJsonFilePath ``` -Update-AzAppNetworkAppLinkMember -InputObject [-EastWestGatewayVisibility ] - [-FullyManagedUpgradeProfileReleaseChannel ] [-SelfManagedUpgradeProfileVersion ] - [-Tag ] [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] +Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` -### UpdateViaJsonFilePath +### UpdateViaIdentityAppLinkExpanded ``` -Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName - -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] +Update-AzAppNetworkAppLinkMember -Name -AppLinkInputObject + [-EastWestGatewayVisibility ] [-FullyManagedUpgradeProfileReleaseChannel ] + [-SelfManagedUpgradeProfileVersion ] [-Tag ] [-UpgradeProfileMode ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] ``` -### UpdateViaJsonString +### UpdateViaIdentityExpanded ``` -Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName - -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] - [-WhatIf] [] +Update-AzAppNetworkAppLinkMember -InputObject [-EastWestGatewayVisibility ] + [-FullyManagedUpgradeProfileReleaseChannel ] [-SelfManagedUpgradeProfileVersion ] + [-Tag ] [-UpgradeProfileMode ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -56,27 +57,31 @@ Update an AppLinkMember. ## EXAMPLES -### Example 1: {{ Add title here }} +### Example 1: Update the release channel of an Application Network member ```powershell -{{ Add code here }} +Update-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -FullyManagedUpgradeProfileReleaseChannel Stable ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Updates the fully managed release channel of the `member-01` Application Network member to `Stable`. -### Example 2: {{ Add title here }} +### Example 2: Update the Application Network version of a self managed member ```powershell -{{ Add code here }} +Update-AzAppNetworkAppLinkMember -Name member-01 -AppLinkName appnet-test-01 -ResourceGroupName test_rg -SelfManagedUpgradeProfileVersion 1.4 ``` ```output -{{ Add output here (remove the output block if the example doesn't have an output) }} +Name ClusterType ProvisioningState ResourceGroupName +---- ----------- ----------------- ----------------- +member-01 AKS Succeeded test_rg ``` -{{ Add description here }} +Updates the self managed Application Network version of the `member-01` member to `1.4`. ## PARAMETERS @@ -100,7 +105,7 @@ The name of the AppLink ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -221,7 +226,7 @@ The name of the AppLinkMember ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityAppLinkExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityAppLinkExpanded Aliases: AppLinkMemberName Required: True @@ -252,7 +257,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -283,7 +288,7 @@ The value must be an UUID. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: False @@ -368,4 +373,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - From ed1c1f31fb0eb3e0efb3d4f513164577eab086b0 Mon Sep 17 00:00:00 2001 From: German Robayo Paz Date: Wed, 12 Aug 2026 19:50:59 +0000 Subject: [PATCH 5/6] docs: regenerate Az.AppNetwork help and UX from updated AppLink @doc Regenerate cmdlet help synopses and portal UX metadata to pick up the improved "Azure Kubernetes Application Network" descriptions from the AppLink TypeSpec. Set-* parameter-set names reflect the createOrReplace operation (Replace* variants). Co-Authored-By: Claude Opus 4 (1M context) --- .../appLinks-appLinkMembers.json | 8 +-- .../UX/Microsoft.AppLink/appLinks.json | 8 +-- .../help/Get-AzAppNetworkAppLink.md | 4 +- .../help/Get-AzAppNetworkAppLinkMember.md | 4 +- .../help/Get-AzAppNetworkAvailableVersion.md | 4 +- .../help/Get-AzAppNetworkUpgradeHistory.md | 4 +- .../help/New-AzAppNetworkAppLink.md | 4 +- .../help/New-AzAppNetworkAppLinkMember.md | 4 +- .../help/Remove-AzAppNetworkAppLink.md | 4 +- .../help/Remove-AzAppNetworkAppLinkMember.md | 4 +- .../help/Set-AzAppNetworkAppLink.md | 50 ++++++++++++---- .../help/Set-AzAppNetworkAppLinkMember.md | 60 +++++++++++++------ .../help/Update-AzAppNetworkAppLink.md | 4 +- .../help/Update-AzAppNetworkAppLinkMember.md | 4 +- 14 files changed, 107 insertions(+), 59 deletions(-) diff --git a/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks-appLinkMembers.json b/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks-appLinkMembers.json index cf31cfc38f88..219c85d48a34 100644 --- a/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks-appLinkMembers.json +++ b/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks-appLinkMembers.json @@ -7,7 +7,7 @@ "commands": [ { "name": "Get-AzAppNetworkAppLinkMember", - "description": "Get an AppLinkMember.", + "description": "Get a member of an Azure Kubernetes Application Network resource.", "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/appLinks/{appLinkName}/appLinkMembers/{appLinkMemberName}", "help": { "learnMore": { @@ -26,7 +26,7 @@ }, "examples": [ { - "description": "Get an AppLinkMember.", + "description": "Get a member of an Azure Kubernetes Application Network resource.", "parameters": [ { "name": "-AppLinkName", @@ -50,7 +50,7 @@ }, { "name": "Remove-AzAppNetworkAppLinkMember", - "description": "Delete an AppLinkMember.", + "description": "Remove a member from an Azure Kubernetes Application Network resource.", "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/appLinks/{appLinkName}/appLinkMembers/{appLinkMemberName}", "help": { "learnMore": { @@ -69,7 +69,7 @@ }, "examples": [ { - "description": "Delete an AppLinkMember.", + "description": "Remove a member from an Azure Kubernetes Application Network resource.", "parameters": [ { "name": "-AppLinkName", diff --git a/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks.json b/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks.json index 79fd62a559c3..55923c28ae05 100644 --- a/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks.json +++ b/src/AppNetwork/AppNetwork.Autorest/UX/Microsoft.AppLink/appLinks.json @@ -7,7 +7,7 @@ "commands": [ { "name": "Get-AzAppNetworkAppLink", - "description": "Get an AppLink.", + "description": "Get the details of an Azure Kubernetes Application Network.", "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/appLinks/{appLinkName}", "help": { "learnMore": { @@ -25,7 +25,7 @@ }, "examples": [ { - "description": "Get an AppLink.", + "description": "Get the details of an Azure Kubernetes Application Network.", "parameters": [ { "name": "-Name", @@ -45,7 +45,7 @@ }, { "name": "Remove-AzAppNetworkAppLink", - "description": "Delete an AppLink.", + "description": "Delete an Azure Kubernetes Application Network resource.", "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/appLinks/{appLinkName}", "help": { "learnMore": { @@ -63,7 +63,7 @@ }, "examples": [ { - "description": "Delete an AppLink.", + "description": "Delete an Azure Kubernetes Application Network resource.", "parameters": [ { "name": "-Name", diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md index faba88167517..0e412dbbc17c 100644 --- a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAppLink.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzAppNetworkAppLink ## SYNOPSIS -Get an AppLink. +Get the details of an Azure Kubernetes Application Network. ## SYNTAX @@ -37,7 +37,7 @@ Get-AzAppNetworkAppLink -InputObject [-DefaultProfile [-DefaultProfil ``` ## DESCRIPTION -Get an AppLinkMember. +Get a member of an Azure Kubernetes Application Network resource. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md index 0efbd4ecdc6c..9c1d88aacf00 100644 --- a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkAvailableVersion.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzAppNetworkAvailableVersion ## SYNOPSIS -List AvailableVersion resources by location. +List the Azure Kubernetes Application Network versions available in a location. ## SYNTAX @@ -18,7 +18,7 @@ Get-AzAppNetworkAvailableVersion -Location [-SubscriptionId ] ``` ## DESCRIPTION -List AvailableVersion resources by location. +List the Azure Kubernetes Application Network versions available in a location. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md index 3c18f2968e85..a092c6417b39 100644 --- a/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md +++ b/src/AppNetwork/AppNetwork/help/Get-AzAppNetworkUpgradeHistory.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzAppNetworkUpgradeHistory ## SYNOPSIS -List UpgradeHistory resources by AppLinkMember. +List the upgrade history of an Azure Kubernetes Application Network member. ## SYNTAX @@ -19,7 +19,7 @@ Get-AzAppNetworkUpgradeHistory -AppLinkMemberName -AppLinkName ``` ## DESCRIPTION -List UpgradeHistory resources by AppLinkMember. +List the upgrade history of an Azure Kubernetes Application Network member. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md index a155cbb9701a..9e815d3d751b 100644 --- a/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLink.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzAppNetworkAppLink ## SYNOPSIS -Create an AppLink. +Create an Azure Kubernetes Application Network resource. ## SYNTAX @@ -35,7 +35,7 @@ New-AzAppNetworkAppLink -Name -ResourceGroupName [-Subscriptio ``` ## DESCRIPTION -Create an AppLink. +Create an Azure Kubernetes Application Network resource. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md index 6f4d04f0a705..6626265d2b72 100644 --- a/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork/help/New-AzAppNetworkAppLinkMember.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzAppNetworkAppLinkMember ## SYNOPSIS -Create an AppLinkMember. +Create a member of an Azure Kubernetes Application Network resource. ## SYNTAX @@ -47,7 +47,7 @@ New-AzAppNetworkAppLinkMember -Name -AppLinkInputObject [-DefaultProfile < ``` ## DESCRIPTION -Delete an AppLink. +Delete an Azure Kubernetes Application Network resource. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md index ff5475e27f4c..ba650f0428b7 100644 --- a/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork/help/Remove-AzAppNetworkAppLinkMember.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-AzAppNetworkAppLinkMember ## SYNOPSIS -Delete an AppLinkMember. +Remove a member from an Azure Kubernetes Application Network resource. ## SYNTAX @@ -33,7 +33,7 @@ Remove-AzAppNetworkAppLinkMember -InputObject [-DefaultPro ``` ## DESCRIPTION -Delete an AppLinkMember. +Remove a member from an Azure Kubernetes Application Network resource. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md index 79c30eb6232b..148c4058eb82 100644 --- a/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLink.md @@ -8,11 +8,11 @@ schema: 2.0.0 # Set-AzAppNetworkAppLink ## SYNOPSIS -Update an AppLink. +Replace an Azure Kubernetes Application Network resource. ## SYNTAX -### UpdateExpanded (Default) +### ReplaceExpanded (Default) ``` Set-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] -Location [-EnableSystemAssignedIdentity ] [-Tag ] @@ -20,14 +20,21 @@ Set-AzAppNetworkAppLink -Name -ResourceGroupName [-Subscriptio [-WhatIf] [-Confirm] [] ``` -### UpdateViaJsonFilePath +### Replace +``` +Set-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] + -Resource [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### ReplaceViaJsonFilePath ``` Set-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` -### UpdateViaJsonString +### ReplaceViaJsonString ``` Set-AzAppNetworkAppLink -Name -ResourceGroupName [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] @@ -35,7 +42,7 @@ Set-AzAppNetworkAppLink -Name -ResourceGroupName [-Subscriptio ``` ## DESCRIPTION -Update an AppLink. +Replace an Azure Kubernetes Application Network resource. ## EXAMPLES @@ -90,7 +97,7 @@ Determines whether to enable a system-assigned identity for the resource. ```yaml Type: System.Nullable`1[System.Boolean] -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -101,11 +108,11 @@ Accept wildcard characters: False ``` ### -JsonFilePath -Path of Json file supplied to the Update operation +Path of Json file supplied to the Replace operation ```yaml Type: System.String -Parameter Sets: UpdateViaJsonFilePath +Parameter Sets: ReplaceViaJsonFilePath Aliases: Required: True @@ -116,11 +123,11 @@ Accept wildcard characters: False ``` ### -JsonString -Json string supplied to the Update operation +Json string supplied to the Replace operation ```yaml Type: System.String -Parameter Sets: UpdateViaJsonString +Parameter Sets: ReplaceViaJsonString Aliases: Required: True @@ -135,7 +142,7 @@ The geo-location where the resource lives ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: True @@ -175,6 +182,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Resource +An Azure Kubernetes Application Network resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink +Parameter Sets: Replace +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -212,7 +234,7 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -228,7 +250,7 @@ The elements in array will be ARM resource ids in the form: '/subscriptions/{sub ```yaml Type: System.String[] -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -274,6 +296,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink diff --git a/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md index c1300b514e49..c4cec842a96d 100644 --- a/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork/help/Set-AzAppNetworkAppLinkMember.md @@ -8,11 +8,11 @@ schema: 2.0.0 # Set-AzAppNetworkAppLinkMember ## SYNOPSIS -Update an AppLinkMember. +Replace a member of an Azure Kubernetes Application Network resource. ## SYNTAX -### UpdateExpanded (Default) +### ReplaceExpanded (Default) ``` Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName [-SubscriptionId ] -Location [-ClusterType ] [-EastWestGatewayVisibility ] @@ -22,14 +22,21 @@ Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGrou [-WhatIf] [-Confirm] [] ``` -### UpdateViaJsonFilePath +### Replace +``` +Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + [-SubscriptionId ] -Resource [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### ReplaceViaJsonFilePath ``` Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` -### UpdateViaJsonString +### ReplaceViaJsonString ``` Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] @@ -37,7 +44,7 @@ Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGrou ``` ## DESCRIPTION -Update an AppLinkMember. +Replace a member of an Azure Kubernetes Application Network resource. ## EXAMPLES @@ -94,7 +101,7 @@ Cluster type ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -125,7 +132,7 @@ East-West gateway visibility. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -140,7 +147,7 @@ Release channel ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -151,11 +158,11 @@ Accept wildcard characters: False ``` ### -JsonFilePath -Path of Json file supplied to the Update operation +Path of Json file supplied to the Replace operation ```yaml Type: System.String -Parameter Sets: UpdateViaJsonFilePath +Parameter Sets: ReplaceViaJsonFilePath Aliases: Required: True @@ -166,11 +173,11 @@ Accept wildcard characters: False ``` ### -JsonString -Json string supplied to the Update operation +Json string supplied to the Replace operation ```yaml Type: System.String -Parameter Sets: UpdateViaJsonString +Parameter Sets: ReplaceViaJsonString Aliases: Required: True @@ -185,7 +192,7 @@ The geo-location where the resource lives ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: True @@ -200,7 +207,7 @@ Resource ID ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -245,7 +252,7 @@ Delegated Subnet to AppLink. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -255,6 +262,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Resource +A member of an Azure Kubernetes Application Network resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember +Parameter Sets: Replace +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -276,7 +298,7 @@ Istio version ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -307,7 +329,7 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -322,7 +344,7 @@ Upgrade mode. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -368,6 +390,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember diff --git a/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md index a997ecb54ff0..11055f5ce9d0 100644 --- a/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLink.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzAppNetworkAppLink ## SYNOPSIS -Update an AppLink. +Replace an Azure Kubernetes Application Network resource. ## SYNTAX @@ -28,7 +28,7 @@ Update-AzAppNetworkAppLink -InputObject [-EnableSystemAssi ``` ## DESCRIPTION -Update an AppLink. +Replace an Azure Kubernetes Application Network resource. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md index 794e06aba602..d5a03c332f7b 100644 --- a/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork/help/Update-AzAppNetworkAppLinkMember.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzAppNetworkAppLinkMember ## SYNOPSIS -Update an AppLinkMember. +Update a member of an Azure Kubernetes Application Network resource. ## SYNTAX @@ -53,7 +53,7 @@ Update-AzAppNetworkAppLinkMember -InputObject [-EastWestGa ``` ## DESCRIPTION -Update an AppLinkMember. +Update a member of an Azure Kubernetes Application Network resource. ## EXAMPLES From 9a2c8ca046d097dd9a1b72f89b6f85dfe7704665 Mon Sep 17 00:00:00 2001 From: German Robayo Paz Date: Wed, 12 Aug 2026 19:59:09 +0000 Subject: [PATCH 6/6] docs: sync AppNetwork.Autorest/docs synopses with updated @doc Regenerate the AutoRest reference docs so their synopses match the updated help/ markdown and the AppLink TypeSpec wording. Fixes stale "Get an AppLink." style descriptions that were left behind. Co-Authored-By: Claude Opus 4 (1M context) --- .../AppNetwork.Autorest/docs/Az.AppNetwork.md | 24 ++++---- .../docs/Get-AzAppNetworkAppLink.md | 4 +- .../docs/Get-AzAppNetworkAppLinkMember.md | 4 +- .../docs/Get-AzAppNetworkAvailableVersion.md | 4 +- .../docs/Get-AzAppNetworkUpgradeHistory.md | 4 +- .../docs/New-AzAppNetworkAppLink.md | 4 +- .../docs/New-AzAppNetworkAppLinkMember.md | 4 +- .../docs/Remove-AzAppNetworkAppLink.md | 4 +- .../docs/Remove-AzAppNetworkAppLinkMember.md | 4 +- .../docs/Set-AzAppNetworkAppLink.md | 50 ++++++++++++---- .../docs/Set-AzAppNetworkAppLinkMember.md | 60 +++++++++++++------ .../docs/Update-AzAppNetworkAppLink.md | 4 +- .../docs/Update-AzAppNetworkAppLinkMember.md | 4 +- 13 files changed, 111 insertions(+), 63 deletions(-) diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Az.AppNetwork.md b/src/AppNetwork/AppNetwork.Autorest/docs/Az.AppNetwork.md index b8615d0720e4..b329128a75ba 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Az.AppNetwork.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Az.AppNetwork.md @@ -12,38 +12,38 @@ Microsoft Azure PowerShell: AppNetwork cmdlets ## Az.AppNetwork Cmdlets ### [Get-AzAppNetworkAppLink](Get-AzAppNetworkAppLink.md) -Get an AppLink. +Get the details of an Azure Kubernetes Application Network. ### [Get-AzAppNetworkAppLinkMember](Get-AzAppNetworkAppLinkMember.md) -Get an AppLinkMember. +Get a member of an Azure Kubernetes Application Network resource. ### [Get-AzAppNetworkAvailableVersion](Get-AzAppNetworkAvailableVersion.md) -List AvailableVersion resources by location. +List the Azure Kubernetes Application Network versions available in a location. ### [Get-AzAppNetworkUpgradeHistory](Get-AzAppNetworkUpgradeHistory.md) -List UpgradeHistory resources by AppLinkMember. +List the upgrade history of an Azure Kubernetes Application Network member. ### [New-AzAppNetworkAppLink](New-AzAppNetworkAppLink.md) -Create an AppLink. +Create an Azure Kubernetes Application Network resource. ### [New-AzAppNetworkAppLinkMember](New-AzAppNetworkAppLinkMember.md) -Create an AppLinkMember. +Create a member of an Azure Kubernetes Application Network resource. ### [Remove-AzAppNetworkAppLink](Remove-AzAppNetworkAppLink.md) -Delete an AppLink. +Delete an Azure Kubernetes Application Network resource. ### [Remove-AzAppNetworkAppLinkMember](Remove-AzAppNetworkAppLinkMember.md) -Delete an AppLinkMember. +Remove a member from an Azure Kubernetes Application Network resource. ### [Set-AzAppNetworkAppLink](Set-AzAppNetworkAppLink.md) -Update an AppLink. +Replace an Azure Kubernetes Application Network resource. ### [Set-AzAppNetworkAppLinkMember](Set-AzAppNetworkAppLinkMember.md) -Update an AppLinkMember. +Replace a member of an Azure Kubernetes Application Network resource. ### [Update-AzAppNetworkAppLink](Update-AzAppNetworkAppLink.md) -Update an AppLink. +Replace an Azure Kubernetes Application Network resource. ### [Update-AzAppNetworkAppLinkMember](Update-AzAppNetworkAppLinkMember.md) -Update an AppLinkMember. +Update a member of an Azure Kubernetes Application Network resource. diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md index e6fbc528c5d9..9c3516ed141c 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLink.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzAppNetworkAppLink ## SYNOPSIS -Get an AppLink. +Get the details of an Azure Kubernetes Application Network. ## SYNTAX @@ -35,7 +35,7 @@ Get-AzAppNetworkAppLink -ResourceGroupName [-SubscriptionId ] ``` ## DESCRIPTION -Get an AppLink. +Get the details of an Azure Kubernetes Application Network. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md index 7167489caf49..e4e3befa6b95 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkAppLinkMember.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzAppNetworkAppLinkMember ## SYNOPSIS -Get an AppLinkMember. +Get a member of an Azure Kubernetes Application Network resource. ## SYNTAX @@ -37,7 +37,7 @@ Get-AzAppNetworkAppLinkMember -AppLinkInputObject -Name [-SubscriptionId ] ``` ## DESCRIPTION -List AvailableVersion resources by location. +List the Azure Kubernetes Application Network versions available in a location. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md index 0868f969cd4f..057bfad76182 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Get-AzAppNetworkUpgradeHistory.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzAppNetworkUpgradeHistory ## SYNOPSIS -List UpgradeHistory resources by AppLinkMember. +List the upgrade history of an Azure Kubernetes Application Network member. ## SYNTAX @@ -18,7 +18,7 @@ Get-AzAppNetworkUpgradeHistory -AppLinkMemberName -AppLinkName ``` ## DESCRIPTION -List UpgradeHistory resources by AppLinkMember. +List the upgrade history of an Azure Kubernetes Application Network member. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md index 35a13a1de489..92ca882f44ae 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLink.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzAppNetworkAppLink ## SYNOPSIS -Create an AppLink. +Create an Azure Kubernetes Application Network resource. ## SYNTAX @@ -35,7 +35,7 @@ New-AzAppNetworkAppLink -Name -ResourceGroupName -JsonString < ``` ## DESCRIPTION -Create an AppLink. +Create an Azure Kubernetes Application Network resource. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md index a7774ee44155..bf2da56e1c49 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/New-AzAppNetworkAppLinkMember.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzAppNetworkAppLinkMember ## SYNOPSIS -Create an AppLinkMember. +Create a member of an Azure Kubernetes Application Network resource. ## SYNTAX @@ -47,7 +47,7 @@ New-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGrou ``` ## DESCRIPTION -Create an AppLinkMember. +Create a member of an Azure Kubernetes Application Network resource. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md index e0f4a8fb3b59..aca43af833bf 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLink.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-AzAppNetworkAppLink ## SYNOPSIS -Delete an AppLink. +Delete an Azure Kubernetes Application Network resource. ## SYNTAX @@ -25,7 +25,7 @@ Remove-AzAppNetworkAppLink -InputObject [-DefaultProfile < ``` ## DESCRIPTION -Delete an AppLink. +Delete an Azure Kubernetes Application Network resource. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md index 389a8b9e02a9..40e3cbdbd5bc 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Remove-AzAppNetworkAppLinkMember.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-AzAppNetworkAppLinkMember ## SYNOPSIS -Delete an AppLinkMember. +Remove a member from an Azure Kubernetes Application Network resource. ## SYNTAX @@ -32,7 +32,7 @@ Remove-AzAppNetworkAppLinkMember -AppLinkInputObject -Name ``` ## DESCRIPTION -Delete an AppLinkMember. +Remove a member from an Azure Kubernetes Application Network resource. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md index 241f9ecc60dc..49364505cff7 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLink.md @@ -8,11 +8,11 @@ schema: 2.0.0 # Set-AzAppNetworkAppLink ## SYNOPSIS -Update an AppLink. +Replace an Azure Kubernetes Application Network resource. ## SYNTAX -### UpdateExpanded (Default) +### ReplaceExpanded (Default) ``` Set-AzAppNetworkAppLink -Name -ResourceGroupName -Location [-SubscriptionId ] [-EnableSystemAssignedIdentity ] [-Tag ] @@ -20,14 +20,21 @@ Set-AzAppNetworkAppLink -Name -ResourceGroupName -Location ] ``` -### UpdateViaJsonFilePath +### Replace +``` +Set-AzAppNetworkAppLink -Name -ResourceGroupName -Resource + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### ReplaceViaJsonFilePath ``` Set-AzAppNetworkAppLink -Name -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` -### UpdateViaJsonString +### ReplaceViaJsonString ``` Set-AzAppNetworkAppLink -Name -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] @@ -35,7 +42,7 @@ Set-AzAppNetworkAppLink -Name -ResourceGroupName -JsonString < ``` ## DESCRIPTION -Update an AppLink. +Replace an Azure Kubernetes Application Network resource. ## EXAMPLES @@ -90,7 +97,7 @@ Determines whether to enable a system-assigned identity for the resource. ```yaml Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -101,11 +108,11 @@ Accept wildcard characters: False ``` ### -JsonFilePath -Path of Json file supplied to the Update operation +Path of Json file supplied to the Replace operation ```yaml Type: System.String -Parameter Sets: UpdateViaJsonFilePath +Parameter Sets: ReplaceViaJsonFilePath Aliases: Required: True @@ -116,11 +123,11 @@ Accept wildcard characters: False ``` ### -JsonString -Json string supplied to the Update operation +Json string supplied to the Replace operation ```yaml Type: System.String -Parameter Sets: UpdateViaJsonString +Parameter Sets: ReplaceViaJsonString Aliases: Required: True @@ -135,7 +142,7 @@ The geo-location where the resource lives ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: True @@ -175,6 +182,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Resource +An Azure Kubernetes Application Network resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink +Parameter Sets: Replace +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -212,7 +234,7 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -228,7 +250,7 @@ The elements in array will be ARM resource ids in the form: '/subscriptions/{sub ```yaml Type: System.String[] -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -274,6 +296,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLink diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md index 15de02fcc11e..d1c669080d0f 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Set-AzAppNetworkAppLinkMember.md @@ -8,11 +8,11 @@ schema: 2.0.0 # Set-AzAppNetworkAppLinkMember ## SYNOPSIS -Update an AppLinkMember. +Replace a member of an Azure Kubernetes Application Network resource. ## SYNTAX -### UpdateExpanded (Default) +### ReplaceExpanded (Default) ``` Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName -Location [-SubscriptionId ] [-ClusterType ] [-EastWestGatewayVisibility ] @@ -22,14 +22,21 @@ Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGrou [] ``` -### UpdateViaJsonFilePath +### Replace +``` +Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName + -Resource [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### ReplaceViaJsonFilePath ``` Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` -### UpdateViaJsonString +### ReplaceViaJsonString ``` Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] @@ -37,7 +44,7 @@ Set-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceGrou ``` ## DESCRIPTION -Update an AppLinkMember. +Replace a member of an Azure Kubernetes Application Network resource. ## EXAMPLES @@ -94,7 +101,7 @@ Cluster type ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -125,7 +132,7 @@ East-West gateway visibility. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -140,7 +147,7 @@ Release channel ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -151,11 +158,11 @@ Accept wildcard characters: False ``` ### -JsonFilePath -Path of Json file supplied to the Update operation +Path of Json file supplied to the Replace operation ```yaml Type: System.String -Parameter Sets: UpdateViaJsonFilePath +Parameter Sets: ReplaceViaJsonFilePath Aliases: Required: True @@ -166,11 +173,11 @@ Accept wildcard characters: False ``` ### -JsonString -Json string supplied to the Update operation +Json string supplied to the Replace operation ```yaml Type: System.String -Parameter Sets: UpdateViaJsonString +Parameter Sets: ReplaceViaJsonString Aliases: Required: True @@ -185,7 +192,7 @@ The geo-location where the resource lives ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: True @@ -200,7 +207,7 @@ Resource ID ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -245,7 +252,7 @@ Delegated Subnet to AppLink. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -255,6 +262,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Resource +A member of an Azure Kubernetes Application Network resource. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember +Parameter Sets: Replace +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -276,7 +298,7 @@ Istio version ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -307,7 +329,7 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -322,7 +344,7 @@ Upgrade mode. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: ReplaceExpanded Aliases: Required: False @@ -368,6 +390,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.AppNetwork.Models.IAppLinkMember diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md index 5f81dfc8526d..90361829a984 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLink.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzAppNetworkAppLink ## SYNOPSIS -Update an AppLink. +Replace an Azure Kubernetes Application Network resource. ## SYNTAX @@ -27,7 +27,7 @@ Update-AzAppNetworkAppLink -InputObject [-EnableSystemAssi ``` ## DESCRIPTION -Update an AppLink. +Replace an Azure Kubernetes Application Network resource. ## EXAMPLES diff --git a/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md index 01425f10f04b..a2afb9efea7e 100644 --- a/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md +++ b/src/AppNetwork/AppNetwork.Autorest/docs/Update-AzAppNetworkAppLinkMember.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzAppNetworkAppLinkMember ## SYNOPSIS -Update an AppLinkMember. +Update a member of an Azure Kubernetes Application Network resource. ## SYNTAX @@ -52,7 +52,7 @@ Update-AzAppNetworkAppLinkMember -AppLinkName -Name -ResourceG ``` ## DESCRIPTION -Update an AppLinkMember. +Update a member of an Azure Kubernetes Application Network resource. ## EXAMPLES