diff --git a/src/Aks/Aks.Autorest/Properties/AssemblyInfo.cs b/src/Aks/Aks.Autorest/Properties/AssemblyInfo.cs index 771d12e2fbb0..be154a2603d3 100644 --- a/src/Aks/Aks.Autorest/Properties/AssemblyInfo.cs +++ b/src/Aks/Aks.Autorest/Properties/AssemblyInfo.cs @@ -20,7 +20,7 @@ [assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] [assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] [assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - Aks")] -[assembly: System.Reflection.AssemblyFileVersionAttribute("7.0.0")] -[assembly: System.Reflection.AssemblyVersionAttribute("7.0.0")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("7.1.2")] +[assembly: System.Reflection.AssemblyVersionAttribute("7.1.2")] [assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] [assembly: System.CLSCompliantAttribute(false)] diff --git a/src/Aks/Aks.Autorest/README.md b/src/Aks/Aks.Autorest/README.md index 6125a2491b0a..7dc755fcc04e 100644 --- a/src/Aks/Aks.Autorest/README.md +++ b/src/Aks/Aks.Autorest/README.md @@ -27,11 +27,11 @@ For information on how to develop for `Az.Aks`, see [how-to.md](how-to.md). > see https://aka.ms/autorest ``` yaml -commit: c1a0abcedccb286ef44a03d6fb8363bc4e3dd560 +commit: 0e3000dfffe6c32c8ed124140dd972dafae67cfa require: - $(this-folder)/../../readme.azure.noprofile.md input-file: - - $(repo)/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-08-01/managedClusters.json + - $(repo)/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2026-03-01/managedClusters.json - $(repo)/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2019-08-01/location.json title: Aks diff --git a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/locations-meshRevisionProfiles.json b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/locations-meshRevisionProfiles.json index 999b0a818305..e985435689cd 100644 --- a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/locations-meshRevisionProfiles.json +++ b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/locations-meshRevisionProfiles.json @@ -1,6 +1,6 @@ { "resourceType": "locations/meshRevisionProfiles", - "apiVersion": "2025-08-01", + "apiVersion": "2026-03-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks" }, diff --git a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-agentPools-machines.json b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-agentPools-machines.json index 880b7099b820..7a2ecadaa01d 100644 --- a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-agentPools-machines.json +++ b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-agentPools-machines.json @@ -1,6 +1,6 @@ { "resourceType": "managedClusters/agentPools/machines", - "apiVersion": "2025-08-01", + "apiVersion": "2026-03-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks" }, diff --git a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-agentPools.json b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-agentPools.json index 37f7feb311db..5c707c6047cd 100644 --- a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-agentPools.json +++ b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-agentPools.json @@ -1,6 +1,6 @@ { "resourceType": "managedClusters/agentPools", - "apiVersion": "2025-08-01", + "apiVersion": "2026-03-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks" }, @@ -51,7 +51,7 @@ { "name": "Invoke-AzAksAbortAgentPoolLatestOperation", "description": "Aborts the currently running operation on the agent pool.\nThe Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes.\nIf the operation completes before cancellation can take place, a 409 error code is returned.", - "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/abort", "help": { "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks/invoke-azaksabortagentpoollatestoperation" diff --git a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-commandResults.json b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-commandResults.json index 5295ceacd804..151ca55db1e9 100644 --- a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-commandResults.json +++ b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-commandResults.json @@ -1,6 +1,6 @@ { "resourceType": "managedClusters/commandResults", - "apiVersion": "2025-08-01", + "apiVersion": "2026-03-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks" }, diff --git a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-maintenanceConfigurations.json b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-maintenanceConfigurations.json index 1612d92b72f8..129adf65e5f7 100644 --- a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-maintenanceConfigurations.json +++ b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-maintenanceConfigurations.json @@ -1,6 +1,6 @@ { "resourceType": "managedClusters/maintenanceConfigurations", - "apiVersion": "2025-08-01", + "apiVersion": "2026-03-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks" }, diff --git a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-managedNamespaces.json b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-managedNamespaces.json new file mode 100644 index 000000000000..e51e829dcf07 --- /dev/null +++ b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-managedNamespaces.json @@ -0,0 +1,95 @@ +{ + "resourceType": "managedClusters/managedNamespaces", + "apiVersion": "2026-03-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.aks" + }, + "commands": [ + { + "name": "Get-AzAksManagedNamespace", + "description": "Gets the specified namespace of a managed cluster.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/managedNamespaces/{managedNamespaceName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.aks/get-azaksmanagednamespace" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ResourceName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets the specified namespace of a managed cluster.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.managedNamespaceName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ResourceName", + "value": "[Path.resourceName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzAksManagedNamespace", + "description": "Deletes a namespace.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/managedNamespaces/{managedNamespaceName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.aks/remove-azaksmanagednamespace" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ResourceName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Deletes a namespace.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.managedNamespaceName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ResourceName", + "value": "[Path.resourceName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-meshUpgradeProfiles.json b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-meshUpgradeProfiles.json index 8567273a139c..964b0fb877df 100644 --- a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-meshUpgradeProfiles.json +++ b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-meshUpgradeProfiles.json @@ -1,6 +1,6 @@ { "resourceType": "managedClusters/meshUpgradeProfiles", - "apiVersion": "2025-08-01", + "apiVersion": "2026-03-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks" }, diff --git a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-trustedAccessRoleBindings.json b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-trustedAccessRoleBindings.json index 6f45e17a5fba..910c9569d0fd 100644 --- a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-trustedAccessRoleBindings.json +++ b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters-trustedAccessRoleBindings.json @@ -1,6 +1,6 @@ { "resourceType": "managedClusters/trustedAccessRoleBindings", - "apiVersion": "2025-08-01", + "apiVersion": "2026-03-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks" }, diff --git a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters.json b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters.json index 546909e987c4..14bbfd7aea5d 100644 --- a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters.json +++ b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/managedClusters.json @@ -1,6 +1,6 @@ { "resourceType": "managedClusters", - "apiVersion": "2025-08-01", + "apiVersion": "2026-03-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks" }, @@ -46,7 +46,7 @@ { "name": "Invoke-AzAksAbortManagedClusterLatestOperation", "description": "Aborts the currently running operation on the managed cluster.\nThe Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes.\nIf the operation completes before cancellation can take place, a 409 error code is returned.", - "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/abort", "help": { "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks/invoke-azaksabortmanagedclusterlatestoperation" diff --git a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/snapshots.json b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/snapshots.json index de4f05ba981c..9c497eaf2a4e 100644 --- a/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/snapshots.json +++ b/src/Aks/Aks.Autorest/UX/Microsoft.ContainerService/snapshots.json @@ -1,6 +1,6 @@ { "resourceType": "snapshots", - "apiVersion": "2025-08-01", + "apiVersion": "2026-03-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.aks" }, diff --git a/src/Aks/Aks.Autorest/docs/Az.Aks.md b/src/Aks/Aks.Autorest/docs/Az.Aks.md index 97efcec7bc15..b1ec5bb044a5 100644 --- a/src/Aks/Aks.Autorest/docs/Az.Aks.md +++ b/src/Aks/Aks.Autorest/docs/Az.Aks.md @@ -1,6 +1,6 @@ --- Module Name: Az.Aks -Module Guid: 112e4bfd-f43c-4da3-9371-7e602ad45e83 +Module Guid: 927b3fff-9908-4a82-aac9-9d00b896919c Download Help Link: https://learn.microsoft.com/powershell/module/az.aks Help Version: 1.0.0.0 Locale: en-US @@ -33,6 +33,12 @@ Gets available upgrades for a service mesh in a cluster. Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint. +### [Get-AzAksManagedNamespace](Get-AzAksManagedNamespace.md) +Gets the specified namespace of a managed cluster. + +### [Get-AzAksManagedNamespaceCredential](Get-AzAksManagedNamespaceCredential.md) +Lists the credentials of a namespace. + ### [Get-AzAksNodePoolUpgradeProfile](Get-AzAksNodePoolUpgradeProfile.md) Gets the upgrade profile for an agent pool. @@ -71,6 +77,11 @@ Rotates the service account signing keys of a managed cluster. ### [New-AzAksMaintenanceConfiguration](New-AzAksMaintenanceConfiguration.md) Create a maintenance configuration in the specified managed cluster. +### [New-AzAksManagedNamespace](New-AzAksManagedNamespace.md) +Create a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + ### [New-AzAksSnapshot](New-AzAksSnapshot.md) Create a snapshot. @@ -89,12 +100,20 @@ Deletes specific machines in an agent pool. ### [Remove-AzAksMaintenanceConfiguration](Remove-AzAksMaintenanceConfiguration.md) Deletes a maintenance configuration. +### [Remove-AzAksManagedNamespace](Remove-AzAksManagedNamespace.md) +Deletes a namespace. + ### [Remove-AzAksSnapshot](Remove-AzAksSnapshot.md) Deletes a snapshot. ### [Remove-AzAksTrustedAccessRoleBinding](Remove-AzAksTrustedAccessRoleBinding.md) Delete a trusted access role binding. +### [Set-AzAksManagedNamespace](Set-AzAksManagedNamespace.md) +Update a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + ### [Start-AzAksCluster](Start-AzAksCluster.md) See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster. @@ -112,6 +131,9 @@ See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster ### [Update-AzAksMaintenanceConfiguration](Update-AzAksMaintenanceConfiguration.md) Update a maintenance configuration in the specified managed cluster. +### [Update-AzAksManagedNamespace](Update-AzAksManagedNamespace.md) +Update tags on a managed namespace. + ### [Update-AzAksTrustedAccessRoleBinding](Update-AzAksTrustedAccessRoleBinding.md) Update a trusted access role binding diff --git a/src/Aks/Aks.Autorest/docs/Get-AzAksMachine.md b/src/Aks/Aks.Autorest/docs/Get-AzAksMachine.md index bacef8bdba5b..c3283281767f 100644 --- a/src/Aks/Aks.Autorest/docs/Get-AzAksMachine.md +++ b/src/Aks/Aks.Autorest/docs/Get-AzAksMachine.md @@ -146,7 +146,7 @@ Accept wildcard characters: False ``` ### -Name -host name of the machine +Host name of the machine. ```yaml Type: System.String diff --git a/src/Aks/Aks.Autorest/docs/Get-AzAksMaintenanceConfiguration.md b/src/Aks/Aks.Autorest/docs/Get-AzAksMaintenanceConfiguration.md index d53db8ba7eb5..f458b856367a 100644 --- a/src/Aks/Aks.Autorest/docs/Get-AzAksMaintenanceConfiguration.md +++ b/src/Aks/Aks.Autorest/docs/Get-AzAksMaintenanceConfiguration.md @@ -88,6 +88,7 @@ Get a maintenance configuration via identity for a managed cluster "myCluster". ### -ConfigName The name of the maintenance configuration. +Supported values are 'default', 'aksManagedAutoUpgradeSchedule', or 'aksManagedNodeOSUpgradeSchedule'. ```yaml Type: System.String diff --git a/src/Aks/Aks.Autorest/docs/Get-AzAksManagedNamespace.md b/src/Aks/Aks.Autorest/docs/Get-AzAksManagedNamespace.md new file mode 100644 index 000000000000..72744b444faf --- /dev/null +++ b/src/Aks/Aks.Autorest/docs/Get-AzAksManagedNamespace.md @@ -0,0 +1,189 @@ +--- +external help file: +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksmanagednamespace +schema: 2.0.0 +--- + +# Get-AzAksManagedNamespace + +## SYNOPSIS +Gets the specified namespace of a managed cluster. + +## SYNTAX + +### List (Default) +``` +Get-AzAksManagedNamespace -ResourceGroupName -ResourceName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAksManagedNamespace -InputObject [-DefaultProfile ] [] +``` + +### GetViaIdentityManagedCluster +``` +Get-AzAksManagedNamespace -ManagedClusterInputObject -Name + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the specified namespace of a managed cluster. + +## 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.Aks.Models.IAksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: GetViaIdentityManagedCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed namespace. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityManagedCluster +Aliases: ManagedNamespaceName + +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 +``` + +### -ResourceName +The name of the managed cluster resource. + +```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.Aks.Models.IAksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace + +## NOTES + +## RELATED LINKS + diff --git a/src/Aks/Aks.Autorest/docs/Get-AzAksManagedNamespaceCredential.md b/src/Aks/Aks.Autorest/docs/Get-AzAksManagedNamespaceCredential.md new file mode 100644 index 000000000000..ac2f376565e6 --- /dev/null +++ b/src/Aks/Aks.Autorest/docs/Get-AzAksManagedNamespaceCredential.md @@ -0,0 +1,171 @@ +--- +external help file: +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksmanagednamespacecredential +schema: 2.0.0 +--- + +# Get-AzAksManagedNamespaceCredential + +## SYNOPSIS +Lists the credentials of a namespace. + +## SYNTAX + +``` +Get-AzAksManagedNamespaceCredential -ManagedNamespaceName -ResourceGroupName + -ResourceName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Lists the credentials of a namespace. + +## 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 +``` + +### -ManagedNamespaceName +The name of the managed namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```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 +``` + +### -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.Aks.Models.ICredentialResults + +## NOTES + +## RELATED LINKS + diff --git a/src/Aks/Aks.Autorest/docs/Invoke-AzAksAbortAgentPoolLatestOperation.md b/src/Aks/Aks.Autorest/docs/Invoke-AzAksAbortAgentPoolLatestOperation.md index d2b1f85ea418..e73d9203f427 100644 --- a/src/Aks/Aks.Autorest/docs/Invoke-AzAksAbortAgentPoolLatestOperation.md +++ b/src/Aks/Aks.Autorest/docs/Invoke-AzAksAbortAgentPoolLatestOperation.md @@ -27,9 +27,9 @@ Invoke-AzAksAbortAgentPoolLatestOperation -InputObject [-DefaultP [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` -### AbortViaIdentityManagedcluster +### AbortViaIdentityManagedCluster ``` -Invoke-AzAksAbortAgentPoolLatestOperation -AgentPoolName -ManagedclusterInputObject +Invoke-AzAksAbortAgentPoolLatestOperation -AgentPoolName -ManagedClusterInputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` @@ -56,7 +56,7 @@ The name of the agent pool. ```yaml Type: System.String -Parameter Sets: Abort, AbortViaIdentityManagedcluster +Parameter Sets: Abort, AbortViaIdentityManagedCluster Aliases: Required: True @@ -112,12 +112,12 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -ManagedclusterInputObject +### -ManagedClusterInputObject Identity Parameter ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity -Parameter Sets: AbortViaIdentityManagedcluster +Parameter Sets: AbortViaIdentityManagedCluster Aliases: Required: True diff --git a/src/Aks/Aks.Autorest/docs/New-AzAksMaintenanceConfiguration.md b/src/Aks/Aks.Autorest/docs/New-AzAksMaintenanceConfiguration.md index 18e198b08c8d..b37016aff5f4 100644 --- a/src/Aks/Aks.Autorest/docs/New-AzAksMaintenanceConfiguration.md +++ b/src/Aks/Aks.Autorest/docs/New-AzAksMaintenanceConfiguration.md @@ -108,6 +108,7 @@ Accept wildcard characters: False ### -ConfigName The name of the maintenance configuration. +Supported values are 'default', 'aksManagedAutoUpgradeSchedule', or 'aksManagedNodeOSUpgradeSchedule'. ```yaml Type: System.String diff --git a/src/Aks/Aks.Autorest/docs/New-AzAksManagedNamespace.md b/src/Aks/Aks.Autorest/docs/New-AzAksManagedNamespace.md new file mode 100644 index 000000000000..4ba033ced1af --- /dev/null +++ b/src/Aks/Aks.Autorest/docs/New-AzAksManagedNamespace.md @@ -0,0 +1,527 @@ +--- +external help file: +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/new-azaksmanagednamespace +schema: 2.0.0 +--- + +# New-AzAksManagedNamespace + +## SYNOPSIS +Create a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName -Location + [-SubscriptionId ] [-AdoptionPolicy ] [-Annotation ] + [-DefaultNetworkPolicyEgress ] [-DefaultNetworkPolicyIngress ] + [-DefaultResourceQuotaCpuLimit ] [-DefaultResourceQuotaCpuRequest ] + [-DefaultResourceQuotaMemoryLimit ] [-DefaultResourceQuotaMemoryRequest ] + [-DeletePolicy ] [-Label ] [-Tag ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentity +``` +New-AzAksManagedNamespace -InputObject -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityExpanded +``` +New-AzAksManagedNamespace -InputObject -Location [-AdoptionPolicy ] + [-Annotation ] [-DefaultNetworkPolicyEgress ] [-DefaultNetworkPolicyIngress ] + [-DefaultResourceQuotaCpuLimit ] [-DefaultResourceQuotaCpuRequest ] + [-DefaultResourceQuotaMemoryLimit ] [-DefaultResourceQuotaMemoryRequest ] + [-DeletePolicy ] [-Label ] [-Tag ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityManagedCluster +``` +New-AzAksManagedNamespace -ManagedClusterInputObject -Name + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityManagedClusterExpanded +``` +New-AzAksManagedNamespace -ManagedClusterInputObject -Name -Location + [-AdoptionPolicy ] [-Annotation ] [-DefaultNetworkPolicyEgress ] + [-DefaultNetworkPolicyIngress ] [-DefaultResourceQuotaCpuLimit ] + [-DefaultResourceQuotaCpuRequest ] [-DefaultResourceQuotaMemoryLimit ] + [-DefaultResourceQuotaMemoryRequest ] [-DeletePolicy ] [-Label ] + [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + +## 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 + +### -AdoptionPolicy +Action if Kubernetes namespace with same name already exists. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Annotation +The annotations of managed namespace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +Aliases: + +Required: False +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 +``` + +### -DefaultNetworkPolicyEgress +Enum representing different network policy rules. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultNetworkPolicyIngress +Enum representing different network policy rules. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +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 +``` + +### -DefaultResourceQuotaCpuLimit +CPU limit of the namespace in one-thousandth CPU form. +See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaCpuRequest +CPU request of the namespace in one-thousandth CPU form. +See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaMemoryLimit +Memory limit of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. +See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaMemoryRequest +Memory request of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. +See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletePolicy +Delete options of a namespace. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +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.Aks.Models.IAksIdentity +Parameter Sets: CreateViaIdentity, CreateViaIdentityExpanded +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 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 +``` + +### -Label +The labels of managed namespace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +Aliases: + +Required: False +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, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: CreateViaIdentityManagedCluster, CreateViaIdentityManagedClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed namespace. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded, CreateViaIdentityManagedCluster, CreateViaIdentityManagedClusterExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: ManagedNamespaceName + +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 +``` + +### -Parameter +Namespace managed by ARM. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace +Parameter Sets: Create, CreateViaIdentity, CreateViaIdentityManagedCluster +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. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +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: Create, 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, CreateViaIdentityExpanded, CreateViaIdentityManagedClusterExpanded +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.Aks.Models.IAksIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace + +## NOTES + +## RELATED LINKS + diff --git a/src/Aks/Aks.Autorest/docs/Remove-AzAksMaintenanceConfiguration.md b/src/Aks/Aks.Autorest/docs/Remove-AzAksMaintenanceConfiguration.md index 0948271b0f65..defbdb7c60af 100644 --- a/src/Aks/Aks.Autorest/docs/Remove-AzAksMaintenanceConfiguration.md +++ b/src/Aks/Aks.Autorest/docs/Remove-AzAksMaintenanceConfiguration.md @@ -54,6 +54,7 @@ $MaintenanceConfig | Remove-AzAksMaintenanceConfiguration ### -ConfigName The name of the maintenance configuration. +Supported values are 'default', 'aksManagedAutoUpgradeSchedule', or 'aksManagedNodeOSUpgradeSchedule'. ```yaml Type: System.String diff --git a/src/Aks/Aks.Autorest/docs/Remove-AzAksManagedNamespace.md b/src/Aks/Aks.Autorest/docs/Remove-AzAksManagedNamespace.md new file mode 100644 index 000000000000..5e665daf42af --- /dev/null +++ b/src/Aks/Aks.Autorest/docs/Remove-AzAksManagedNamespace.md @@ -0,0 +1,261 @@ +--- +external help file: +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/remove-azaksmanagednamespace +schema: 2.0.0 +--- + +# Remove-AzAksManagedNamespace + +## SYNOPSIS +Deletes a namespace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzAksManagedNamespace -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityManagedCluster +``` +Remove-AzAksManagedNamespace -ManagedClusterInputObject -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a namespace. + +## 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.Aks.Models.IAksIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: DeleteViaIdentityManagedCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed namespace. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityManagedCluster +Aliases: ManagedNamespaceName + +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 +``` + +### -ResourceName +The name of the managed cluster resource. + +```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.Aks.Models.IAksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/Aks/Aks.Autorest/docs/Set-AzAksManagedNamespace.md b/src/Aks/Aks.Autorest/docs/Set-AzAksManagedNamespace.md new file mode 100644 index 000000000000..3bb818e1a779 --- /dev/null +++ b/src/Aks/Aks.Autorest/docs/Set-AzAksManagedNamespace.md @@ -0,0 +1,462 @@ +--- +external help file: +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/set-azaksmanagednamespace +schema: 2.0.0 +--- + +# Set-AzAksManagedNamespace + +## SYNOPSIS +Update a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName -Location + [-SubscriptionId ] [-AdoptionPolicy ] [-Annotation ] + [-DefaultNetworkPolicyEgress ] [-DefaultNetworkPolicyIngress ] + [-DefaultResourceQuotaCpuLimit ] [-DefaultResourceQuotaCpuRequest ] + [-DefaultResourceQuotaMemoryLimit ] [-DefaultResourceQuotaMemoryRequest ] + [-DeletePolicy ] [-Label ] [-Tag ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### Update +``` +Set-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Set-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Set-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Update a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + +## 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 + +### -AdoptionPolicy +Action if Kubernetes namespace with same name already exists. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Annotation +The annotations of managed namespace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +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 +``` + +### -DefaultNetworkPolicyEgress +Enum representing different network policy rules. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultNetworkPolicyIngress +Enum representing different network policy rules. + +```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 +``` + +### -DefaultResourceQuotaCpuLimit +CPU limit of the namespace in one-thousandth CPU form. +See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaCpuRequest +CPU request of the namespace in one-thousandth CPU form. +See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaMemoryLimit +Memory limit of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. +See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaMemoryRequest +Memory request of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. +See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletePolicy +Delete options of a namespace. + +```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 +``` + +### -Label +The labels of managed namespace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +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 managed namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ManagedNamespaceName + +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 +``` + +### -Parameter +Namespace managed by ARM. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace +Parameter Sets: Update +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```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 +``` + +### -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.Aks.Models.IManagedNamespace + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace + +## NOTES + +## RELATED LINKS + diff --git a/src/Aks/Aks.Autorest/docs/Update-AzAksMaintenanceConfiguration.md b/src/Aks/Aks.Autorest/docs/Update-AzAksMaintenanceConfiguration.md index 68ba0a7a5ede..5e0a7a5bda37 100644 --- a/src/Aks/Aks.Autorest/docs/Update-AzAksMaintenanceConfiguration.md +++ b/src/Aks/Aks.Autorest/docs/Update-AzAksMaintenanceConfiguration.md @@ -105,6 +105,7 @@ Accept wildcard characters: False ### -ConfigName The name of the maintenance configuration. +Supported values are 'default', 'aksManagedAutoUpgradeSchedule', or 'aksManagedNodeOSUpgradeSchedule'. ```yaml Type: System.String diff --git a/src/Aks/Aks.Autorest/docs/Update-AzAksManagedNamespace.md b/src/Aks/Aks.Autorest/docs/Update-AzAksManagedNamespace.md new file mode 100644 index 000000000000..69c937dc479b --- /dev/null +++ b/src/Aks/Aks.Autorest/docs/Update-AzAksManagedNamespace.md @@ -0,0 +1,311 @@ +--- +external help file: +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/update-azaksmanagednamespace +schema: 2.0.0 +--- + +# Update-AzAksManagedNamespace + +## SYNOPSIS +Update tags on a managed namespace. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Update +``` +Update-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentity +``` +Update-AzAksManagedNamespace -InputObject -Parameter [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAksManagedNamespace -InputObject [-Tag ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityManagedCluster +``` +Update-AzAksManagedNamespace -ManagedClusterInputObject -Name -Parameter + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityManagedClusterExpanded +``` +Update-AzAksManagedNamespace -ManagedClusterInputObject -Name [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonString +``` +Update-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update tags on a managed namespace. + +## 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.Aks.Models.IAksIdentity +Parameter Sets: UpdateViaIdentity, 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 +``` + +### -ManagedClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: UpdateViaIdentityManagedCluster, UpdateViaIdentityManagedClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed namespace. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded, UpdateViaIdentityManagedCluster, UpdateViaIdentityManagedClusterExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: ManagedNamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Tags object for patch operations. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.ITagsObject +Parameter Sets: Update, UpdateViaIdentity, UpdateViaIdentityManagedCluster +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. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +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: Update, 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, UpdateViaIdentityExpanded, UpdateViaIdentityManagedClusterExpanded +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.Aks.Models.IAksIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.ITagsObject + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace + +## NOTES + +## RELATED LINKS + diff --git a/src/Aks/Aks.Autorest/examples/Get-AzAksManagedNamespace.md b/src/Aks/Aks.Autorest/examples/Get-AzAksManagedNamespace.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/Aks/Aks.Autorest/examples/Get-AzAksManagedNamespace.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/Aks/Aks.Autorest/examples/Get-AzAksManagedNamespaceCredential.md b/src/Aks/Aks.Autorest/examples/Get-AzAksManagedNamespaceCredential.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/Aks/Aks.Autorest/examples/Get-AzAksManagedNamespaceCredential.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/Aks/Aks.Autorest/examples/New-AzAksManagedNamespace.md b/src/Aks/Aks.Autorest/examples/New-AzAksManagedNamespace.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/Aks/Aks.Autorest/examples/New-AzAksManagedNamespace.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/Aks/Aks.Autorest/examples/Remove-AzAksManagedNamespace.md b/src/Aks/Aks.Autorest/examples/Remove-AzAksManagedNamespace.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/Aks/Aks.Autorest/examples/Remove-AzAksManagedNamespace.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/Aks/Aks.Autorest/examples/Set-AzAksManagedNamespace.md b/src/Aks/Aks.Autorest/examples/Set-AzAksManagedNamespace.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/Aks/Aks.Autorest/examples/Set-AzAksManagedNamespace.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/Aks/Aks.Autorest/examples/Update-AzAksManagedNamespace.md b/src/Aks/Aks.Autorest/examples/Update-AzAksManagedNamespace.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/Aks/Aks.Autorest/examples/Update-AzAksManagedNamespace.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/Aks/Aks.Autorest/generate-info.json b/src/Aks/Aks.Autorest/generate-info.json index b7172d37d38c..08196a732245 100644 --- a/src/Aks/Aks.Autorest/generate-info.json +++ b/src/Aks/Aks.Autorest/generate-info.json @@ -1,3 +1,3 @@ { - "generate_Id": "e74c13e0-6230-4cd6-b053-899caeabf7fd" + "generate_Id": "02f54522-cab5-47a5-8ec3-3bca9a43ced8" } diff --git a/src/Aks/Aks.Autorest/test/Get-AzAksManagedNamespace.Tests.ps1 b/src/Aks/Aks.Autorest/test/Get-AzAksManagedNamespace.Tests.ps1 new file mode 100644 index 000000000000..618105c6390b --- /dev/null +++ b/src/Aks/Aks.Autorest/test/Get-AzAksManagedNamespace.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzAksManagedNamespace')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzAksManagedNamespace.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-AzAksManagedNamespace' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityManagedCluster' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Aks/Aks.Autorest/test/Get-AzAksManagedNamespaceCredential.Tests.ps1 b/src/Aks/Aks.Autorest/test/Get-AzAksManagedNamespaceCredential.Tests.ps1 new file mode 100644 index 000000000000..4925ef59d036 --- /dev/null +++ b/src/Aks/Aks.Autorest/test/Get-AzAksManagedNamespaceCredential.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzAksManagedNamespaceCredential')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzAksManagedNamespaceCredential.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-AzAksManagedNamespaceCredential' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Aks/Aks.Autorest/test/New-AzAksManagedNamespace.Tests.ps1 b/src/Aks/Aks.Autorest/test/New-AzAksManagedNamespace.Tests.ps1 new file mode 100644 index 000000000000..7333f91a534c --- /dev/null +++ b/src/Aks/Aks.Autorest/test/New-AzAksManagedNamespace.Tests.ps1 @@ -0,0 +1,49 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzAksManagedNamespace')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzAksManagedNamespace.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-AzAksManagedNamespace' { + 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 'CreateViaIdentityManagedClusterExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityManagedCluster' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Create' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Aks/Aks.Autorest/test/Remove-AzAksManagedNamespace.Tests.ps1 b/src/Aks/Aks.Autorest/test/Remove-AzAksManagedNamespace.Tests.ps1 new file mode 100644 index 000000000000..1cf2b2452f86 --- /dev/null +++ b/src/Aks/Aks.Autorest/test/Remove-AzAksManagedNamespace.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzAksManagedNamespace')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzAksManagedNamespace.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-AzAksManagedNamespace' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityManagedCluster' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Aks/Aks.Autorest/test/Set-AzAksManagedNamespace.Tests.ps1 b/src/Aks/Aks.Autorest/test/Set-AzAksManagedNamespace.Tests.ps1 new file mode 100644 index 000000000000..daa224ec0a76 --- /dev/null +++ b/src/Aks/Aks.Autorest/test/Set-AzAksManagedNamespace.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Set-AzAksManagedNamespace')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Set-AzAksManagedNamespace.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-AzAksManagedNamespace' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Update' -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/Aks/Aks.Autorest/test/Update-AzAksManagedNamespace.Tests.ps1 b/src/Aks/Aks.Autorest/test/Update-AzAksManagedNamespace.Tests.ps1 new file mode 100644 index 000000000000..70e2b9b77d62 --- /dev/null +++ b/src/Aks/Aks.Autorest/test/Update-AzAksManagedNamespace.Tests.ps1 @@ -0,0 +1,49 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzAksManagedNamespace')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzAksManagedNamespace.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-AzAksManagedNamespace' { + 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 'UpdateViaIdentityManagedClusterExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityManagedCluster' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Update' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Aks/Aks.sln b/src/Aks/Aks.sln index ff6717f46b05..44a2ac5753de 100644 --- a/src/Aks/Aks.sln +++ b/src/Aks/Aks.sln @@ -29,7 +29,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Aks.Management.Sdk", "Aks.M EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Aks.Autorest", "Aks.Autorest", "{16EC2DC2-EB7B-325E-770F-D562EF2F68D3}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Aks", "..\..\generated\Aks\Aks.Autorest\Az.Aks.csproj", "{28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Aks", "..\..\generated\Aks\Aks.Autorest\Az.Aks.csproj", "{3FAFD86A-1048-49C6-907C-DE1DF14B90A4}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -161,18 +161,18 @@ Global {3CB53E47-87C1-41C9-BD57-19E7B07C63FB}.Release|x64.Build.0 = Release|Any CPU {3CB53E47-87C1-41C9-BD57-19E7B07C63FB}.Release|x86.ActiveCfg = Release|Any CPU {3CB53E47-87C1-41C9-BD57-19E7B07C63FB}.Release|x86.Build.0 = Release|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Debug|Any CPU.Build.0 = Debug|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Debug|x64.ActiveCfg = Debug|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Debug|x64.Build.0 = Debug|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Debug|x86.ActiveCfg = Debug|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Debug|x86.Build.0 = Debug|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Release|Any CPU.ActiveCfg = Release|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Release|Any CPU.Build.0 = Release|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Release|x64.ActiveCfg = Release|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Release|x64.Build.0 = Release|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Release|x86.ActiveCfg = Release|Any CPU - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1}.Release|x86.Build.0 = Release|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Debug|Any CPU.Build.0 = Debug|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Debug|x64.ActiveCfg = Debug|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Debug|x64.Build.0 = Debug|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Debug|x86.ActiveCfg = Debug|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Debug|x86.Build.0 = Debug|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Release|Any CPU.ActiveCfg = Release|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Release|Any CPU.Build.0 = Release|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Release|x64.ActiveCfg = Release|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Release|x64.Build.0 = Release|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Release|x86.ActiveCfg = Release|Any CPU + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -186,7 +186,7 @@ Global {3087729D-E16D-4A31-BAF7-E115A50F719B} = {7F7F3C8C-B80E-4823-B2E5-20AF86A219FA} {A7EEA531-0AD2-43CD-ACCB-9DC7E8DB86BF} = {3FD20327-1C9F-4940-A96B-AD3B05FC2185} {135EE24A-A2A6-494D-B82F-2167FC3A298E} = {3FD20327-1C9F-4940-A96B-AD3B05FC2185} - {28A3CF47-CDDF-44DC-8D4F-09E80A9312F1} = {16EC2DC2-EB7B-325E-770F-D562EF2F68D3} + {3FAFD86A-1048-49C6-907C-DE1DF14B90A4} = {16EC2DC2-EB7B-325E-770F-D562EF2F68D3} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {35B1D5ED-BE63-4E38-8FFE-7ADAA7A764CA} diff --git a/src/Aks/Aks/Az.Aks.psd1 b/src/Aks/Aks/Az.Aks.psd1 index 6ce74d9612b2..50d8b53e4d19 100644 --- a/src/Aks/Aks/Az.Aks.psd1 +++ b/src/Aks/Aks/Az.Aks.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 4/29/2026 +# Generated on: 5/21/2026 # @{ @@ -61,10 +61,10 @@ RequiredAssemblies = 'Aks.Autorest/bin/Az.Aks.private.dll', 'YamlDotNet.dll' # Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() +ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() +TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module FormatsToProcess = 'Aks.Autorest/Az.Aks.format.ps1xml' @@ -80,19 +80,23 @@ FunctionsToExport = 'Get-AzAksMachine', 'Get-AzAksMaintenanceConfiguration', 'Get-AzAksManagedClusterMeshRevisionProfile', 'Get-AzAksManagedClusterMeshUpgradeProfile', 'Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint', + 'Get-AzAksManagedNamespace', 'Get-AzAksManagedNamespaceCredential', 'Get-AzAksNodePoolUpgradeProfile', 'Get-AzAksSnapshot', 'Get-AzAksTrustedAccessRole', 'Get-AzAksTrustedAccessRoleBinding', 'Get-AzAksUpgradeProfile', 'Get-AzAksVersion', 'Install-AzAksCliTool', 'Invoke-AzAksAbortAgentPoolLatestOperation', 'Invoke-AzAksAbortManagedClusterLatestOperation', 'Invoke-AzAksRotateManagedClusterServiceAccountSigningKey', - 'New-AzAksMaintenanceConfiguration', 'New-AzAksSnapshot', - 'New-AzAksTimeInWeekObject', 'New-AzAksTimeSpanObject', - 'New-AzAksTrustedAccessRoleBinding', 'Remove-AzAksAgentPoolMachine', - 'Remove-AzAksMaintenanceConfiguration', 'Remove-AzAksSnapshot', - 'Remove-AzAksTrustedAccessRoleBinding', 'Start-AzAksCluster', - 'Start-AzAksManagedClusterCommand', 'Stop-AzAksCluster', - 'Update-AzAksMaintenanceConfiguration', + 'New-AzAksMaintenanceConfiguration', 'New-AzAksManagedNamespace', + 'New-AzAksSnapshot', 'New-AzAksTimeInWeekObject', + 'New-AzAksTimeSpanObject', 'New-AzAksTrustedAccessRoleBinding', + 'Remove-AzAksAgentPoolMachine', + 'Remove-AzAksMaintenanceConfiguration', + 'Remove-AzAksManagedNamespace', 'Remove-AzAksSnapshot', + 'Remove-AzAksTrustedAccessRoleBinding', 'Set-AzAksManagedNamespace', + 'Start-AzAksCluster', 'Start-AzAksManagedClusterCommand', + 'Stop-AzAksCluster', 'Update-AzAksMaintenanceConfiguration', + 'Update-AzAksManagedNamespace', 'Update-AzAksTrustedAccessRoleBinding' # 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. @@ -124,7 +128,8 @@ PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'Azure','ResourceManager','ARM','AKS','Kubernetes','Container','Orchestrator','Containers','Docker' + Tags = 'Azure', 'ResourceManager', 'ARM', 'AKS', 'Kubernetes', 'Container', + 'Orchestrator', 'Containers', 'Docker' # A URL to the license for this module. LicenseUri = 'https://aka.ms/azps-license' @@ -150,7 +155,7 @@ PrivateData = @{ } # End of PSData hashtable - } # End of PrivateData hashtable +} # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' diff --git a/src/Aks/Aks/ChangeLog.md b/src/Aks/Aks/ChangeLog.md index 2b345d8789e5..e830d5f94c5d 100644 --- a/src/Aks/Aks/ChangeLog.md +++ b/src/Aks/Aks/ChangeLog.md @@ -18,6 +18,7 @@ - Additional information about change #1 --> ## Upcoming Release +* Bumped API version to 2026-03-01 ## Version 7.1.2 * Set `useAADAuth` to `true` by default in the omsagent addon profile when enabling the Monitoring addon via `Enable-AzAksAddOn` and `New-AzAksCluster` diff --git a/src/Aks/Aks/help/Az.Aks.md b/src/Aks/Aks/help/Az.Aks.md index 85c8a9ed7443..064264142bb4 100644 --- a/src/Aks/Aks/help/Az.Aks.md +++ b/src/Aks/Aks/help/Az.Aks.md @@ -20,16 +20,34 @@ Enable the addons for aks. ### [Get-AzAksCluster](Get-AzAksCluster.md) List Kubernetes managed clusters. +### [Get-AzAksMachine](Get-AzAksMachine.md) +Get a specific machine in the specified agent pool. + ### [Get-AzAksMaintenanceConfiguration](Get-AzAksMaintenanceConfiguration.md) Gets the specified maintenance configuration of a managed cluster. ### [Get-AzAksManagedClusterCommandResult](Get-AzAksManagedClusterCommandResult.md) Gets the results of a command which has been run on the Managed Cluster. +### [Get-AzAksManagedClusterKuberneteVersion](Get-AzAksManagedClusterKuberneteVersion.md) +Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version + +### [Get-AzAksManagedClusterMeshRevisionProfile](Get-AzAksManagedClusterMeshRevisionProfile.md) +Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades + +### [Get-AzAksManagedClusterMeshUpgradeProfile](Get-AzAksManagedClusterMeshUpgradeProfile.md) +Gets available upgrades for a service mesh in a cluster. + ### [Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint](Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md) Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint. +### [Get-AzAksManagedNamespace](Get-AzAksManagedNamespace.md) +Gets the specified namespace of a managed cluster. + +### [Get-AzAksManagedNamespaceCredential](Get-AzAksManagedNamespaceCredential.md) +Lists the credentials of a namespace. + ### [Get-AzAksNodePool](Get-AzAksNodePool.md) List node pools in specified cluster. @@ -39,6 +57,12 @@ Gets the upgrade profile for an agent pool. ### [Get-AzAksSnapshot](Get-AzAksSnapshot.md) Gets a snapshot. +### [Get-AzAksTrustedAccessRole](Get-AzAksTrustedAccessRole.md) +List supported trusted access roles. + +### [Get-AzAksTrustedAccessRoleBinding](Get-AzAksTrustedAccessRoleBinding.md) +Get a trusted access role binding. + ### [Get-AzAksUpgradeProfile](Get-AzAksUpgradeProfile.md) Gets the upgrade profile of a managed cluster. @@ -78,6 +102,11 @@ The cmdlet may call below Microsoft Graph API according to input parameters: ### [New-AzAksMaintenanceConfiguration](New-AzAksMaintenanceConfiguration.md) Create a maintenance configuration in the specified managed cluster. +### [New-AzAksManagedNamespace](New-AzAksManagedNamespace.md) +Create a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + ### [New-AzAksNodePool](New-AzAksNodePool.md) Create a new node pool in specified cluster. @@ -90,24 +119,41 @@ Create an in-memory object for TimeInWeek. ### [New-AzAksTimeSpanObject](New-AzAksTimeSpanObject.md) Create an in-memory object for TimeSpan. +### [New-AzAksTrustedAccessRoleBinding](New-AzAksTrustedAccessRoleBinding.md) +Create a trusted access role binding + +### [Remove-AzAksAgentPoolMachine](Remove-AzAksAgentPoolMachine.md) +Deletes specific machines in an agent pool. + ### [Remove-AzAksCluster](Remove-AzAksCluster.md) Delete a managed Kubernetes cluster. ### [Remove-AzAksMaintenanceConfiguration](Remove-AzAksMaintenanceConfiguration.md) Deletes a maintenance configuration. +### [Remove-AzAksManagedNamespace](Remove-AzAksManagedNamespace.md) +Deletes a namespace. + ### [Remove-AzAksNodePool](Remove-AzAksNodePool.md) Delete node pool from managed cluster. ### [Remove-AzAksSnapshot](Remove-AzAksSnapshot.md) Deletes a snapshot. +### [Remove-AzAksTrustedAccessRoleBinding](Remove-AzAksTrustedAccessRoleBinding.md) +Delete a trusted access role binding. + ### [Set-AzAksCluster](Set-AzAksCluster.md) Update or create a managed Kubernetes cluster. ### [Set-AzAksClusterCredential](Set-AzAksClusterCredential.md) Reset the ServicePrincipal of an existing AKS cluster. +### [Set-AzAksManagedNamespace](Set-AzAksManagedNamespace.md) +Update a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + ### [Start-AzAksCluster](Start-AzAksCluster.md) See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster. @@ -131,6 +177,12 @@ Stop the Kubectl SSH tunnel created in Start-AzKubernetesDashboard. ### [Update-AzAksMaintenanceConfiguration](Update-AzAksMaintenanceConfiguration.md) Update a maintenance configuration in the specified managed cluster. +### [Update-AzAksManagedNamespace](Update-AzAksManagedNamespace.md) +Update tags on a managed namespace. + ### [Update-AzAksNodePool](Update-AzAksNodePool.md) Update node pool in a managed cluster. +### [Update-AzAksTrustedAccessRoleBinding](Update-AzAksTrustedAccessRoleBinding.md) +Update a trusted access role binding + diff --git a/src/Aks/Aks/help/Disable-AzAksAddOn.md b/src/Aks/Aks/help/Disable-AzAksAddOn.md index 4a505c8ad310..b7af12355505 100644 --- a/src/Aks/Aks/help/Disable-AzAksAddOn.md +++ b/src/Aks/Aks/help/Disable-AzAksAddOn.md @@ -16,14 +16,14 @@ Disable the addons for aks. ``` Disable-AzAksAddOn [-ResourceGroupName] [-ClusterName] [-Name ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### InputObjectParameterSet ``` Disable-AzAksAddOn -ClusterObject [-Name ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -40,6 +40,36 @@ Disable the addons `HttpApplicationRouting`, `Monitoring`, `AzurePolicy`, `Virtu ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ClusterName Kubernetes managed cluster Name. diff --git a/src/Aks/Aks/help/Enable-AzAksAddOn.md b/src/Aks/Aks/help/Enable-AzAksAddOn.md index 21ddbcfc90f8..fb2a199bfc6d 100644 --- a/src/Aks/Aks/help/Enable-AzAksAddOn.md +++ b/src/Aks/Aks/help/Enable-AzAksAddOn.md @@ -16,14 +16,15 @@ Enable the addons for aks. ``` Enable-AzAksAddOn [-WorkspaceResourceId ] [-SubnetName ] [-ResourceGroupName] [-ClusterName] [-Name ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] + [-SubscriptionId ] [] ``` ### InputObjectParameterSet ``` Enable-AzAksAddOn [-WorkspaceResourceId ] [-SubnetName ] -ClusterObject [-Name ] [-DefaultProfile ] [-WhatIf] - [-Confirm] [-SubscriptionId ] [] + [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -40,6 +41,36 @@ Enable the addons `HttpApplicationRouting`, `Monitoring`, `AzurePolicy`, `Virtua ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ClusterName Kubernetes managed cluster Name. diff --git a/src/Aks/Aks/help/Get-AzAksMachine.md b/src/Aks/Aks/help/Get-AzAksMachine.md index cfb1eb8eed26..707e81a9515a 100644 --- a/src/Aks/Aks/help/Get-AzAksMachine.md +++ b/src/Aks/Aks/help/Get-AzAksMachine.md @@ -148,7 +148,7 @@ Accept wildcard characters: False ``` ### -Name -host name of the machine +Host name of the machine. ```yaml Type: System.String diff --git a/src/Aks/Aks/help/Get-AzAksMaintenanceConfiguration.md b/src/Aks/Aks/help/Get-AzAksMaintenanceConfiguration.md index 81fe6e2242f5..5d8e4a6963e7 100644 --- a/src/Aks/Aks/help/Get-AzAksMaintenanceConfiguration.md +++ b/src/Aks/Aks/help/Get-AzAksMaintenanceConfiguration.md @@ -15,32 +15,26 @@ Gets the specified maintenance configuration of a managed cluster. ### List (Default) ``` Get-AzAksMaintenanceConfiguration -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] + [] ``` ### GetViaIdentityManagedCluster ``` Get-AzAksMaintenanceConfiguration -ConfigName -ManagedClusterInputObject - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [] ``` ### Get ``` Get-AzAksMaintenanceConfiguration -ConfigName -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] + [] ``` ### GetViaIdentity ``` -Get-AzAksMaintenanceConfiguration -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] +Get-AzAksMaintenanceConfiguration -InputObject [-DefaultProfile ] [] ``` @@ -94,23 +88,9 @@ Get a maintenance configuration via identity for a managed cluster "myCluster". ## PARAMETERS -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ConfigName The name of the maintenance configuration. +Supported values are 'default', 'aksManagedAutoUpgradeSchedule', or 'aksManagedNodeOSUpgradeSchedule'. ```yaml Type: System.String @@ -140,36 +120,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -200,51 +150,6 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Get-AzAksManagedClusterCommandResult.md b/src/Aks/Aks/help/Get-AzAksManagedClusterCommandResult.md index 54b53515bdfb..7bf31539668c 100644 --- a/src/Aks/Aks/help/Get-AzAksManagedClusterCommandResult.md +++ b/src/Aks/Aks/help/Get-AzAksManagedClusterCommandResult.md @@ -15,24 +15,19 @@ Gets the results of a command which has been run on the Managed Cluster. ### Get (Default) ``` Get-AzAksManagedClusterCommandResult -CommandId -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [] ``` ### GetViaIdentityManagedCluster ``` Get-AzAksManagedClusterCommandResult -CommandId -ManagedClusterInputObject - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-PassThru] [] ``` ### GetViaIdentity ``` -Get-AzAksManagedClusterCommandResult -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] +Get-AzAksManagedClusterCommandResult -InputObject [-DefaultProfile ] [-PassThru] [] ``` @@ -61,21 +56,6 @@ StartedAt : 3/31/2023 9:14:38 AM ## PARAMETERS -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -CommandId Id of the command. @@ -107,36 +87,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -182,51 +132,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md b/src/Aks/Aks/help/Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md index 907faf85b1d7..27746d9b12df 100644 --- a/src/Aks/Aks/help/Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md +++ b/src/Aks/Aks/help/Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint.md @@ -15,9 +15,8 @@ The operation returns properties of each egress endpoint. ``` Get-AzAksManagedClusterOutboundNetworkDependencyEndpoint -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -45,21 +44,6 @@ apiserver {aks0b1f-idb7vuoi.hcp.eastus.azmk8s.io} ## PARAMETERS -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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. @@ -76,81 +60,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Get-AzAksManagedNamespace.md b/src/Aks/Aks/help/Get-AzAksManagedNamespace.md new file mode 100644 index 000000000000..f24dba800b54 --- /dev/null +++ b/src/Aks/Aks/help/Get-AzAksManagedNamespace.md @@ -0,0 +1,190 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksmanagednamespace +schema: 2.0.0 +--- + +# Get-AzAksManagedNamespace + +## SYNOPSIS +Gets the specified namespace of a managed cluster. + +## SYNTAX + +### List (Default) +``` +Get-AzAksManagedNamespace -ResourceGroupName -ResourceName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentityManagedCluster +``` +Get-AzAksManagedNamespace -Name -ManagedClusterInputObject [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzAksManagedNamespace -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the specified namespace of a managed cluster. + +## 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.Aks.Models.IAksIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: GetViaIdentityManagedCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed namespace. + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityManagedCluster, Get +Aliases: ManagedNamespaceName + +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: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: List, Get +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: List, Get +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.Aks.Models.IAksIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace + +## NOTES + +## RELATED LINKS diff --git a/src/Aks/Aks/help/Get-AzAksManagedNamespaceCredential.md b/src/Aks/Aks/help/Get-AzAksManagedNamespaceCredential.md new file mode 100644 index 000000000000..1b629b779b83 --- /dev/null +++ b/src/Aks/Aks/help/Get-AzAksManagedNamespaceCredential.md @@ -0,0 +1,170 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/get-azaksmanagednamespacecredential +schema: 2.0.0 +--- + +# Get-AzAksManagedNamespaceCredential + +## SYNOPSIS +Lists the credentials of a namespace. + +## SYNTAX + +``` +Get-AzAksManagedNamespaceCredential -ManagedNamespaceName -ResourceGroupName + -ResourceName [-SubscriptionId ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Lists the credentials of a namespace. + +## 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 +``` + +### -ManagedNamespaceName +The name of the managed namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```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 +``` + +### -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.Aks.Models.ICredentialResults + +## NOTES + +## RELATED LINKS diff --git a/src/Aks/Aks/help/Get-AzAksNodePoolUpgradeProfile.md b/src/Aks/Aks/help/Get-AzAksNodePoolUpgradeProfile.md index f049250f569b..e577f35604b1 100644 --- a/src/Aks/Aks/help/Get-AzAksNodePoolUpgradeProfile.md +++ b/src/Aks/Aks/help/Get-AzAksNodePoolUpgradeProfile.md @@ -15,24 +15,19 @@ Gets the upgrade profile for an agent pool. ### Get (Default) ``` Get-AzAksNodePoolUpgradeProfile -ClusterName -NodePoolName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] + [] ``` ### GetViaIdentityManagedCluster ``` Get-AzAksNodePoolUpgradeProfile -NodePoolName -ManagedClusterInputObject - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [] ``` ### GetViaIdentity ``` -Get-AzAksNodePoolUpgradeProfile -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] +Get-AzAksNodePoolUpgradeProfile -InputObject [-DefaultProfile ] [] ``` @@ -56,21 +51,6 @@ Get Aks node pool upgrade profile with resource group name and cluster name. ## PARAMETERS -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ClusterName The name of the managed cluster resource. @@ -102,36 +82,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -177,51 +127,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Get-AzAksSnapshot.md b/src/Aks/Aks/help/Get-AzAksSnapshot.md index 1bfb07dbbae0..926a319a6487 100644 --- a/src/Aks/Aks/help/Get-AzAksSnapshot.md +++ b/src/Aks/Aks/help/Get-AzAksSnapshot.md @@ -14,33 +14,25 @@ Gets a snapshot. ### List (Default) ``` -Get-AzAksSnapshot [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] +Get-AzAksSnapshot [-SubscriptionId ] [-DefaultProfile ] [] ``` ### List1 ``` Get-AzAksSnapshot -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] ``` ### Get ``` Get-AzAksSnapshot -ResourceGroupName -ResourceName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [] ``` ### GetViaIdentity ``` -Get-AzAksSnapshot -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] +Get-AzAksSnapshot -InputObject [-DefaultProfile ] [] ``` @@ -100,21 +92,6 @@ eastus snapshot1 3/30/2023 10:09:35 AM user1@microsoft.com User ## PARAMETERS -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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. @@ -131,36 +108,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -176,51 +123,6 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Get-AzAksUpgradeProfile.md b/src/Aks/Aks/help/Get-AzAksUpgradeProfile.md index f91d3b9a0b77..dc8707b37bbf 100644 --- a/src/Aks/Aks/help/Get-AzAksUpgradeProfile.md +++ b/src/Aks/Aks/help/Get-AzAksUpgradeProfile.md @@ -15,16 +15,12 @@ Gets the upgrade profile of a managed cluster. ### Get (Default) ``` Get-AzAksUpgradeProfile -ClusterName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [] ``` ### GetViaIdentity ``` -Get-AzAksUpgradeProfile -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] +Get-AzAksUpgradeProfile -InputObject [-DefaultProfile ] [] ``` @@ -48,21 +44,6 @@ Get Aks upgrade profile with resource group name and cluster name. ## PARAMETERS -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ClusterName The name of the managed cluster resource. @@ -94,36 +75,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -139,51 +90,6 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Get-AzAksVersion.md b/src/Aks/Aks/help/Get-AzAksVersion.md index 149e48c482ef..837577cc79fb 100644 --- a/src/Aks/Aks/help/Get-AzAksVersion.md +++ b/src/Aks/Aks/help/Get-AzAksVersion.md @@ -14,9 +14,7 @@ The operation returns properties of each orchestrator including version, availab ## SYNTAX ``` -Get-AzAksVersion -Location [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] +Get-AzAksVersion -Location [-SubscriptionId ] [-DefaultProfile ] [] ``` @@ -48,21 +46,6 @@ List available version for creating managed Kubernetes cluster. ## PARAMETERS -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with Azure. @@ -78,36 +61,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Location The name of a supported Azure region. @@ -123,51 +76,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -SubscriptionId Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. diff --git a/src/Aks/Aks/help/Import-AzAksCredential.md b/src/Aks/Aks/help/Import-AzAksCredential.md index f52c35b1de35..4b4ac2b731dc 100644 --- a/src/Aks/Aks/help/Import-AzAksCredential.md +++ b/src/Aks/Aks/help/Import-AzAksCredential.md @@ -16,21 +16,22 @@ Import and merge Kubectl config for a managed Kubernetes Cluster. ``` Import-AzAksCredential [-ResourceGroupName] [-Name] [-Admin] [-ConfigPath ] [-PublicFqdn] [-Force] [-PassThru] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] + [-SubscriptionId ] [] ``` ### InputObjectParameterSet ``` Import-AzAksCredential -InputObject [-Admin] [-ConfigPath ] [-PublicFqdn] [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] - [-Confirm] [-SubscriptionId ] [] + [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### IdParameterSet ``` Import-AzAksCredential [-Id] [-Admin] [-ConfigPath ] [-PublicFqdn] [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -45,6 +46,21 @@ Import-AzAksCredential -ResourceGroupName group -Name myCluster ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + ### -Admin Get the 'clusterAdmin' kubectl config instead of the default 'clusterUser'. @@ -60,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ConfigPath A kubectl config file to create or update. Use '-' to print YAML to stdout instead. diff --git a/src/Aks/Aks/help/Invoke-AzAksAbortAgentPoolLatestOperation.md b/src/Aks/Aks/help/Invoke-AzAksAbortAgentPoolLatestOperation.md index 3d6f00963938..7d5e21bccae6 100644 --- a/src/Aks/Aks/help/Invoke-AzAksAbortAgentPoolLatestOperation.md +++ b/src/Aks/Aks/help/Invoke-AzAksAbortAgentPoolLatestOperation.md @@ -17,27 +17,21 @@ If the operation completes before cancellation can take place, a 409 error code ### Abort (Default) ``` Invoke-AzAksAbortAgentPoolLatestOperation -AgentPoolName -ResourceGroupName - -ResourceName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-PassThru] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] + -ResourceName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` -### AbortViaIdentityManagedcluster +### AbortViaIdentityManagedCluster ``` -Invoke-AzAksAbortAgentPoolLatestOperation -AgentPoolName -ManagedclusterInputObject - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] +Invoke-AzAksAbortAgentPoolLatestOperation -AgentPoolName -ManagedClusterInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### AbortViaIdentity ``` Invoke-AzAksAbortAgentPoolLatestOperation -InputObject [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-PassThru] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] - [-WhatIf] [-Confirm] [] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -63,7 +57,7 @@ The name of the agent pool. ```yaml Type: System.String -Parameter Sets: Abort, AbortViaIdentityManagedcluster +Parameter Sets: Abort, AbortViaIdentityManagedCluster Aliases: Required: True @@ -88,21 +82,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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. @@ -119,36 +98,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -164,12 +113,12 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -ManagedclusterInputObject +### -ManagedClusterInputObject Identity Parameter ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity -Parameter Sets: AbortViaIdentityManagedcluster +Parameter Sets: AbortViaIdentityManagedCluster Aliases: Required: True @@ -209,51 +158,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Invoke-AzAksAbortManagedClusterLatestOperation.md b/src/Aks/Aks/help/Invoke-AzAksAbortManagedClusterLatestOperation.md index 2a726f46ee93..fb432b4284bb 100644 --- a/src/Aks/Aks/help/Invoke-AzAksAbortManagedClusterLatestOperation.md +++ b/src/Aks/Aks/help/Invoke-AzAksAbortManagedClusterLatestOperation.md @@ -17,18 +17,14 @@ If the operation completes before cancellation can take place, a 409 error code ### Abort (Default) ``` Invoke-AzAksAbortManagedClusterLatestOperation -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-PassThru] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### AbortViaIdentity ``` Invoke-AzAksAbortManagedClusterLatestOperation -InputObject [-DefaultProfile ] - [-AsJob] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-PassThru] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] - [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -64,21 +60,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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. @@ -95,36 +76,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -170,51 +121,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Invoke-AzAksRotateManagedClusterServiceAccountSigningKey.md b/src/Aks/Aks/help/Invoke-AzAksRotateManagedClusterServiceAccountSigningKey.md index 131fd561133c..b18118ef38ed 100644 --- a/src/Aks/Aks/help/Invoke-AzAksRotateManagedClusterServiceAccountSigningKey.md +++ b/src/Aks/Aks/help/Invoke-AzAksRotateManagedClusterServiceAccountSigningKey.md @@ -15,18 +15,14 @@ Rotates the service account signing keys of a managed cluster. ### Rotate (Default) ``` Invoke-AzAksRotateManagedClusterServiceAccountSigningKey -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-PassThru] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### RotateViaIdentity ``` Invoke-AzAksRotateManagedClusterServiceAccountSigningKey -InputObject - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` @@ -57,21 +53,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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. @@ -88,36 +69,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -163,51 +114,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Invoke-AzAksRunCommand.md b/src/Aks/Aks/help/Invoke-AzAksRunCommand.md index 76b5fb0c2fdc..4f05b5d37a85 100644 --- a/src/Aks/Aks/help/Invoke-AzAksRunCommand.md +++ b/src/Aks/Aks/help/Invoke-AzAksRunCommand.md @@ -17,7 +17,7 @@ Run a shell command (with kubectl, helm) on your aks cluster, support attaching Invoke-AzAksRunCommand [-ResourceGroupName] [-Name] -Command [-CommandContextAttachment ] [-CommandContextAttachmentZip ] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### InputObjectParameterSet @@ -25,14 +25,15 @@ Invoke-AzAksRunCommand [-ResourceGroupName] [-Name] -Command < Invoke-AzAksRunCommand -InputObject -Command [-CommandContextAttachment ] [-CommandContextAttachmentZip ] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### IdParameterSet ``` Invoke-AzAksRunCommand [-Id] -Command [-CommandContextAttachment ] [-CommandContextAttachmentZip ] [-AsJob] [-Force] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] + [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -60,6 +61,21 @@ Get the pods in Aks cluster. ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + ### -AsJob Run cmdlet in the background @@ -75,6 +91,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Command Gets or sets the command to run. diff --git a/src/Aks/Aks/help/New-AzAksCluster.md b/src/Aks/Aks/help/New-AzAksCluster.md index c427dfb6a73a..f9bfb7f835a8 100644 --- a/src/Aks/Aks/help/New-AzAksCluster.md +++ b/src/Aks/Aks/help/New-AzAksCluster.md @@ -62,7 +62,8 @@ New-AzAksCluster [-EdgeZone ] [-AddOnNameToBeEnabled ] [-Subne [-Tag ] [-EnableBlobCSIDriver] [-EnableDiskCSIDriver] [-EnableFileCSIDriver] [-EnableSnapshotCSIDriver] [-AksCustomHeader ] [-IfMatch ] [-IfNoneMatch ] [-AcrNameToAttach ] [-AsJob] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] + [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -160,6 +161,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + ### -AcrNameToAttach Grant the 'acrpull' role of the specified ACR to AKS Service Principal, e.g. myacr @@ -415,6 +431,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CustomCaTrustCertificate The list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority). diff --git a/src/Aks/Aks/help/New-AzAksMaintenanceConfiguration.md b/src/Aks/Aks/help/New-AzAksMaintenanceConfiguration.md index f432a269a27b..8836bac7b7a6 100644 --- a/src/Aks/Aks/help/New-AzAksMaintenanceConfiguration.md +++ b/src/Aks/Aks/help/New-AzAksMaintenanceConfiguration.md @@ -15,28 +15,28 @@ Create a maintenance configuration in the specified managed cluster. ### CreateExpanded (Default) ``` New-AzAksMaintenanceConfiguration -ConfigName -ResourceGroupName -ResourceName - [-SubscriptionId ] [-NotAllowedTime ] [-TimeInWeek ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] [-AbsoluteMonthlyDayOfMonth ] [-AbsoluteMonthlyIntervalMonth ] + [-DailyIntervalDay ] [-MaintenanceWindowDurationHour ] + [-MaintenanceWindowNotAllowedDate ] [-MaintenanceWindowStartDate ] + [-MaintenanceWindowStartTime ] [-MaintenanceWindowUtcOffset ] [-NotAllowedTime ] + [-RelativeMonthlyDayOfWeek ] [-RelativeMonthlyIntervalMonth ] + [-RelativeMonthlyWeekIndex ] [-TimeInWeek ] [-WeeklyDayOfWeek ] + [-WeeklyIntervalWeek ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzAksMaintenanceConfiguration -ConfigName -ResourceGroupName -ResourceName - [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzAksMaintenanceConfiguration -ConfigName -ResourceGroupName -ResourceName - [-SubscriptionId ] -JsonString [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -77,23 +77,39 @@ Create a maintenance configuration "aks_maintenance_config" in a managed cluster ## PARAMETERS -### -Break -Wait for .NET debugger to attach +### -AbsoluteMonthlyDayOfMonth +The date of the month. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Type: System.Int32 +Parameter Sets: CreateExpanded Aliases: Required: False Position: Named -Default value: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AbsoluteMonthlyIntervalMonth +Specifies the number of months between each set of occurrences. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ConfigName The name of the maintenance configuration. +Supported values are 'default', 'aksManagedAutoUpgradeSchedule', or 'aksManagedNodeOSUpgradeSchedule'. ```yaml Type: System.String @@ -107,6 +123,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DailyIntervalDay +Specifies the number of days between each set of occurrences. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +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. @@ -123,12 +154,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -JsonFilePath +Path of Json file supplied to the Create operation ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) +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 +``` + +### -MaintenanceWindowDurationHour +Length of maintenance window range from 4 to 24 hours. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded Aliases: Required: False @@ -138,12 +199,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -MaintenanceWindowNotAllowedDate +Date ranges on which upgrade is not allowed. +'utcOffset' applies to this field. +For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IDateSpan[] +Parameter Sets: CreateExpanded Aliases: Required: False @@ -153,30 +216,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -JsonFilePath -Path of Json file supplied to the Create operation +### -MaintenanceWindowStartDate +The date the maintenance window activates. +If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. +If not specified, the maintenance window will be active right away. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowStartTime +The start time of the maintenance window. +Accepted values are from '00:00' to '23:59'. +'utcOffset' applies to this field. +For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'. ```yaml Type: System.String -Parameter Sets: CreateViaJsonFilePath +Parameter Sets: CreateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -JsonString -Json string supplied to the Create operation +### -MaintenanceWindowUtcOffset +The UTC offset in format +/-HH:mm. +For example, '+05:30' for IST and '-07:00' for PST. +If not specified, the default is '+00:00'. ```yaml Type: System.String -Parameter Sets: CreateViaJsonString +Parameter Sets: CreateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -198,12 +283,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -RelativeMonthlyDayOfWeek +Specifies on which day of the week the maintenance occurs. ```yaml -Type: System.Uri -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -213,12 +298,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -RelativeMonthlyIntervalMonth +Specifies the number of months between each set of occurrences. ```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) +Type: System.Int32 +Parameter Sets: CreateExpanded Aliases: Required: False @@ -228,17 +313,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy +### -RelativeMonthlyWeekIndex +The week index. +Specifies on which week of the month the dayOfWeek applies. ```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -306,6 +392,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WeeklyDayOfWeek +Specifies on which day of the week the maintenance occurs. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeeklyIntervalWeek +Specifies the number of weeks between each set of occurrences. + +```yaml +Type: System.Int32 +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. diff --git a/src/Aks/Aks/help/New-AzAksManagedNamespace.md b/src/Aks/Aks/help/New-AzAksManagedNamespace.md new file mode 100644 index 000000000000..4f27012ff5a2 --- /dev/null +++ b/src/Aks/Aks/help/New-AzAksManagedNamespace.md @@ -0,0 +1,528 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/new-azaksmanagednamespace +schema: 2.0.0 +--- + +# New-AzAksManagedNamespace + +## SYNOPSIS +Create a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -Location [-AdoptionPolicy ] [-Annotation ] + [-DefaultNetworkPolicyEgress ] [-DefaultNetworkPolicyIngress ] + [-DefaultResourceQuotaCpuLimit ] [-DefaultResourceQuotaCpuRequest ] + [-DefaultResourceQuotaMemoryLimit ] [-DefaultResourceQuotaMemoryRequest ] + [-DeletePolicy ] [-Label ] [-Tag ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityManagedClusterExpanded +``` +New-AzAksManagedNamespace -Name -ManagedClusterInputObject -Location + [-AdoptionPolicy ] [-Annotation ] [-DefaultNetworkPolicyEgress ] + [-DefaultNetworkPolicyIngress ] [-DefaultResourceQuotaCpuLimit ] + [-DefaultResourceQuotaCpuRequest ] [-DefaultResourceQuotaMemoryLimit ] + [-DefaultResourceQuotaMemoryRequest ] [-DeletePolicy ] [-Label ] [-Tag ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaIdentityManagedCluster +``` +New-AzAksManagedNamespace -Name -ManagedClusterInputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### Create +``` +New-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityExpanded +``` +New-AzAksManagedNamespace -InputObject -Location [-AdoptionPolicy ] + [-Annotation ] [-DefaultNetworkPolicyEgress ] [-DefaultNetworkPolicyIngress ] + [-DefaultResourceQuotaCpuLimit ] [-DefaultResourceQuotaCpuRequest ] + [-DefaultResourceQuotaMemoryLimit ] [-DefaultResourceQuotaMemoryRequest ] + [-DeletePolicy ] [-Label ] [-Tag ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentity +``` +New-AzAksManagedNamespace -InputObject -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Create a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + +## 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 + +### -AdoptionPolicy +Action if Kubernetes namespace with same name already exists. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Annotation +The annotations of managed namespace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +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 +``` + +### -DefaultNetworkPolicyEgress +Enum representing different network policy rules. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultNetworkPolicyIngress +Enum representing different network policy rules. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +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 +``` + +### -DefaultResourceQuotaCpuLimit +CPU limit of the namespace in one-thousandth CPU form. +See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaCpuRequest +CPU request of the namespace in one-thousandth CPU form. +See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaMemoryLimit +Memory limit of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. +See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaMemoryRequest +Memory request of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. +See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletePolicy +Delete options of a namespace. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +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.Aks.Models.IAksIdentity +Parameter Sets: CreateViaIdentityExpanded, CreateViaIdentity +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 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 +``` + +### -Label +The labels of managed namespace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +Aliases: + +Required: False +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, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: CreateViaIdentityManagedClusterExpanded, CreateViaIdentityManagedCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed namespace. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityManagedCluster, Create +Aliases: ManagedNamespaceName + +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 +``` + +### -Parameter +Namespace managed by ARM. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace +Parameter Sets: CreateViaIdentityManagedCluster, Create, CreateViaIdentity +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. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create +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: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create +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, CreateViaIdentityManagedClusterExpanded, CreateViaIdentityExpanded +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.Aks.Models.IAksIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace + +## NOTES + +## RELATED LINKS diff --git a/src/Aks/Aks/help/New-AzAksNodePool.md b/src/Aks/Aks/help/New-AzAksNodePool.md index 17418ed65429..5ff80bf880bc 100644 --- a/src/Aks/Aks/help/New-AzAksNodePool.md +++ b/src/Aks/Aks/help/New-AzAksNodePool.md @@ -29,7 +29,7 @@ New-AzAksNodePool -ResourceGroupName -ClusterName -Name ] [-MaxSurge ] [-MaxUnavailable ] [-DrainTimeoutInMinute ] [-NodeSoakDurationInMinute ] [-UndrainableNodeBehavior ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### ParentObjectParameterSet @@ -48,7 +48,8 @@ New-AzAksNodePool -Name -ClusterObject [-Count ] [-EnableSecureBoot] [-EnableVtpm] [-SshAccess ] [-MaxSurge ] [-MaxUnavailable ] [-DrainTimeoutInMinute ] [-NodeSoakDurationInMinute ] [-UndrainableNodeBehavior ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] + [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -98,6 +99,21 @@ New-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myAKSCluster - ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + ### -AksCustomHeader Aks custom headers @@ -128,6 +144,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ClusterName The name of the managed cluster resource. diff --git a/src/Aks/Aks/help/New-AzAksSnapshot.md b/src/Aks/Aks/help/New-AzAksSnapshot.md index cc10ae5709ac..98b8ebe040fa 100644 --- a/src/Aks/Aks/help/New-AzAksSnapshot.md +++ b/src/Aks/Aks/help/New-AzAksSnapshot.md @@ -16,25 +16,21 @@ Create a snapshot. ``` New-AzAksSnapshot -ResourceGroupName -ResourceName [-SubscriptionId ] -Location [-CreationDataSourceResourceId ] [-SnapshotType ] [-Tag ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzAksSnapshot -ResourceGroupName -ResourceName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaJsonString ``` New-AzAksSnapshot -ResourceGroupName -ResourceName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -58,21 +54,6 @@ Creates or updates a snapshot for a nodepool "default" of a managed cluster "myc ## PARAMETERS -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -CreationDataSourceResourceId This is the ARM ID of the source object to be used to create the target object. @@ -104,36 +85,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -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 @@ -179,51 +130,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Remove-AzAksCluster.md b/src/Aks/Aks/help/Remove-AzAksCluster.md index 159851ce7ed7..342258678438 100644 --- a/src/Aks/Aks/help/Remove-AzAksCluster.md +++ b/src/Aks/Aks/help/Remove-AzAksCluster.md @@ -16,20 +16,21 @@ Delete a managed Kubernetes cluster. ``` Remove-AzAksCluster [-ResourceGroupName] [-Name] [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### InputObjectParameterSet ``` Remove-AzAksCluster -InputObject [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### IdParameterSet ``` Remove-AzAksCluster [-Id] [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] + [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -44,6 +45,21 @@ Remove-AzAksCluster -ResourceGroupName group -Name myCluster ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + ### -AsJob Run cmdlet in the background @@ -59,6 +75,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with Azure. diff --git a/src/Aks/Aks/help/Remove-AzAksMaintenanceConfiguration.md b/src/Aks/Aks/help/Remove-AzAksMaintenanceConfiguration.md index 1f67249c0913..f2bd3fb1b4af 100644 --- a/src/Aks/Aks/help/Remove-AzAksMaintenanceConfiguration.md +++ b/src/Aks/Aks/help/Remove-AzAksMaintenanceConfiguration.md @@ -15,25 +15,21 @@ Deletes a maintenance configuration. ### Delete (Default) ``` Remove-AzAksMaintenanceConfiguration -ConfigName -ResourceGroupName -ResourceName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityManagedCluster ``` Remove-AzAksMaintenanceConfiguration -ConfigName -ManagedClusterInputObject - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] ``` ### DeleteViaIdentity ``` -Remove-AzAksMaintenanceConfiguration -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] - [-Confirm] [] +Remove-AzAksMaintenanceConfiguration -InputObject [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -54,23 +50,9 @@ $MaintenanceConfig | Remove-AzAksMaintenanceConfiguration ## PARAMETERS -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ConfigName The name of the maintenance configuration. +Supported values are 'default', 'aksManagedAutoUpgradeSchedule', or 'aksManagedNodeOSUpgradeSchedule'. ```yaml Type: System.String @@ -100,36 +82,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -175,51 +127,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Remove-AzAksManagedNamespace.md b/src/Aks/Aks/help/Remove-AzAksManagedNamespace.md new file mode 100644 index 000000000000..1c6fa41bb6e7 --- /dev/null +++ b/src/Aks/Aks/help/Remove-AzAksManagedNamespace.md @@ -0,0 +1,261 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/remove-azaksmanagednamespace +schema: 2.0.0 +--- + +# Remove-AzAksManagedNamespace + +## SYNOPSIS +Deletes a namespace. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityManagedCluster +``` +Remove-AzAksManagedNamespace -Name -ManagedClusterInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAksManagedNamespace -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a namespace. + +## 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.Aks.Models.IAksIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ManagedClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: DeleteViaIdentityManagedCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed namespace. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityManagedCluster +Aliases: ManagedNamespaceName + +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 +``` + +### -ResourceName +The name of the managed cluster resource. + +```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.Aks.Models.IAksIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/Aks/Aks/help/Remove-AzAksNodePool.md b/src/Aks/Aks/help/Remove-AzAksNodePool.md index 7d79c647e89f..3e6718d6d8b3 100644 --- a/src/Aks/Aks/help/Remove-AzAksNodePool.md +++ b/src/Aks/Aks/help/Remove-AzAksNodePool.md @@ -16,27 +16,28 @@ Delete node pool from managed cluster. ``` Remove-AzAksNodePool [-ResourceGroupName] [-ClusterName] [-Name] [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] - [-Confirm] [-SubscriptionId ] [] + [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### InputObjectParameterSet ``` Remove-AzAksNodePool -InputObject [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### IdParameterSet ``` Remove-AzAksNodePool [-Id] [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] + [-SubscriptionId ] [] ``` ### ParentObjectParameterSet ``` Remove-AzAksNodePool [-Name] -ClusterObject [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -51,6 +52,21 @@ Remove-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster - ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + ### -AsJob Run cmdlet in the background @@ -66,6 +82,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ClusterName Name of your managed Kubernetes cluster diff --git a/src/Aks/Aks/help/Remove-AzAksSnapshot.md b/src/Aks/Aks/help/Remove-AzAksSnapshot.md index 5ba968d327e7..dddf175f933d 100644 --- a/src/Aks/Aks/help/Remove-AzAksSnapshot.md +++ b/src/Aks/Aks/help/Remove-AzAksSnapshot.md @@ -15,17 +15,14 @@ Deletes a snapshot. ### Delete (Default) ``` Remove-AzAksSnapshot -ResourceGroupName -ResourceName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] ``` ### DeleteViaIdentity ``` -Remove-AzAksSnapshot -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] - [-Confirm] [] +Remove-AzAksSnapshot -InputObject [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -46,21 +43,6 @@ $Snapshot | Remove-AzAksSnapshot ## PARAMETERS -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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. @@ -77,36 +59,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -137,51 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Set-AzAksCluster.md b/src/Aks/Aks/help/Set-AzAksCluster.md index 901dbd014f4c..afbc1208b9e7 100644 --- a/src/Aks/Aks/help/Set-AzAksCluster.md +++ b/src/Aks/Aks/help/Set-AzAksCluster.md @@ -48,7 +48,8 @@ Set-AzAksCluster [-NodePoolMode ] [-AcrNameToDetach ] [-NodeImag [-Tag ] [-EnableBlobCSIDriver] [-EnableDiskCSIDriver] [-EnableFileCSIDriver] [-EnableSnapshotCSIDriver] [-AksCustomHeader ] [-IfMatch ] [-IfNoneMatch ] [-AcrNameToAttach ] [-AsJob] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] + [-SubscriptionId ] [] ``` ### InputObjectParameterSet @@ -87,7 +88,7 @@ Set-AzAksCluster -InputObject [-NodePoolMode ] [-A [-EnableDiskCSIDriver] [-EnableFileCSIDriver] [-EnableSnapshotCSIDriver] [-AksCustomHeader ] [-IfMatch ] [-IfNoneMatch ] [-AcrNameToAttach ] [-AsJob] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### IdParameterSet @@ -125,7 +126,7 @@ Set-AzAksCluster [-NodePoolMode ] [-AcrNameToDetach ] [-NodeImag [-EnableDiskCSIDriver] [-EnableFileCSIDriver] [-EnableSnapshotCSIDriver] [-AksCustomHeader ] [-IfMatch ] [-IfNoneMatch ] [-AcrNameToAttach ] [-AsJob] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -185,6 +186,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + ### -AcrNameToAttach Grant the 'acrpull' role of the specified ACR to AKS Service Principal, e.g. myacr @@ -425,6 +441,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ControlPlaneOnly Will only upgrade control plane to target version. diff --git a/src/Aks/Aks/help/Set-AzAksClusterCredential.md b/src/Aks/Aks/help/Set-AzAksClusterCredential.md index a940b095869f..8dd57772d5eb 100644 --- a/src/Aks/Aks/help/Set-AzAksClusterCredential.md +++ b/src/Aks/Aks/help/Set-AzAksClusterCredential.md @@ -17,21 +17,22 @@ Reset the ServicePrincipal of an existing AKS cluster. Set-AzAksClusterCredential [-ResourceGroupName] [-Name] -ServicePrincipalIdAndSecret [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### InputObjectParameterSet ``` Set-AzAksClusterCredential -InputObject -ServicePrincipalIdAndSecret [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] + [] ``` ### IdParameterSet ``` Set-AzAksClusterCredential [-Id] -ServicePrincipalIdAndSecret [-PassThru] [-AsJob] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -50,6 +51,21 @@ Set the service principal of a existing kubernetes cluster with resource group n ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + ### -AsJob Run cmdlet in the background @@ -65,6 +81,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with Azure. diff --git a/src/Aks/Aks/help/Set-AzAksManagedNamespace.md b/src/Aks/Aks/help/Set-AzAksManagedNamespace.md new file mode 100644 index 000000000000..566a980f1f24 --- /dev/null +++ b/src/Aks/Aks/help/Set-AzAksManagedNamespace.md @@ -0,0 +1,461 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/set-azaksmanagednamespace +schema: 2.0.0 +--- + +# Set-AzAksManagedNamespace + +## SYNOPSIS +Update a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -Location [-AdoptionPolicy ] [-Annotation ] + [-DefaultNetworkPolicyEgress ] [-DefaultNetworkPolicyIngress ] + [-DefaultResourceQuotaCpuLimit ] [-DefaultResourceQuotaCpuRequest ] + [-DefaultResourceQuotaMemoryLimit ] [-DefaultResourceQuotaMemoryRequest ] + [-DeletePolicy ] [-Label ] [-Tag ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### Update +``` +Set-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Set-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonString +``` +Set-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a namespace managed by ARM for the specified managed cluster. +Users can configure aspects like resource quotas, network ingress/egress policies, and more. +See aka.ms/aks/managed-namespaces for more details. + +## 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 + +### -AdoptionPolicy +Action if Kubernetes namespace with same name already exists. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Annotation +The annotations of managed namespace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +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 +``` + +### -DefaultNetworkPolicyEgress +Enum representing different network policy rules. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultNetworkPolicyIngress +Enum representing different network policy rules. + +```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 +``` + +### -DefaultResourceQuotaCpuLimit +CPU limit of the namespace in one-thousandth CPU form. +See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaCpuRequest +CPU request of the namespace in one-thousandth CPU form. +See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaMemoryLimit +Memory limit of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. +See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultResourceQuotaMemoryRequest +Memory request of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. +See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletePolicy +Delete options of a namespace. + +```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 +``` + +### -Label +The labels of managed namespace. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +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 managed namespace. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ManagedNamespaceName + +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 +``` + +### -Parameter +Namespace managed by ARM. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace +Parameter Sets: Update +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```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 +``` + +### -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.Aks.Models.IManagedNamespace + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace + +## NOTES + +## RELATED LINKS diff --git a/src/Aks/Aks/help/Start-AzAksCluster.md b/src/Aks/Aks/help/Start-AzAksCluster.md index 324cf230f537..729a6157730c 100644 --- a/src/Aks/Aks/help/Start-AzAksCluster.md +++ b/src/Aks/Aks/help/Start-AzAksCluster.md @@ -15,17 +15,13 @@ See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster ### Start (Default) ``` Start-AzAksCluster -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### StartViaIdentity ``` -Start-AzAksCluster -InputObject [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-PassThru] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] +Start-AzAksCluster -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` @@ -65,21 +61,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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. @@ -96,36 +77,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -186,51 +137,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Start-AzAksDashboard.md b/src/Aks/Aks/help/Start-AzAksDashboard.md index 99248daefff0..da6e01d012f3 100644 --- a/src/Aks/Aks/help/Start-AzAksDashboard.md +++ b/src/Aks/Aks/help/Start-AzAksDashboard.md @@ -16,21 +16,21 @@ Create a Kubectl SSH tunnel to the managed cluster's dashboard. ``` Start-AzAksDashboard [-ResourceGroupName] [-Name] [-DisableBrowser] [-ListenPort ] [-PassThru] [-DefaultProfile ] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### InputObjectParameterSet ``` Start-AzAksDashboard [-InputObject] [-DisableBrowser] [-ListenPort ] [-PassThru] - [-DefaultProfile ] [-SubscriptionId ] - [] + [-DefaultProfile ] [-AcquirePolicyToken] + [-ChangeReference ] [-SubscriptionId ] [] ``` ### IdParameterSet ``` Start-AzAksDashboard [-Id] [-DisableBrowser] [-ListenPort ] [-PassThru] - [-DefaultProfile ] [-SubscriptionId ] - [] + [-DefaultProfile ] [-AcquirePolicyToken] + [-ChangeReference ] [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -45,6 +45,36 @@ Start-AzAksDashboard -ResourceGroupName group -Name myCluster ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with Azure. diff --git a/src/Aks/Aks/help/Start-AzAksManagedClusterCommand.md b/src/Aks/Aks/help/Start-AzAksManagedClusterCommand.md index c9f7fe89f579..cebda1cf06ad 100644 --- a/src/Aks/Aks/help/Start-AzAksManagedClusterCommand.md +++ b/src/Aks/Aks/help/Start-AzAksManagedClusterCommand.md @@ -17,34 +17,29 @@ For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/ ### RunExpanded (Default) ``` Start-AzAksManagedClusterCommand -ResourceGroupName -ResourceName [-SubscriptionId ] - -Command [-ClusterToken ] [-Context ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] - [-Confirm] [] + -Command [-ClusterToken ] [-Context ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### RunViaJsonString ``` Start-AzAksManagedClusterCommand -ResourceGroupName -ResourceName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### RunViaJsonFilePath ``` Start-AzAksManagedClusterCommand -ResourceGroupName -ResourceName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### RunViaIdentityExpanded ``` Start-AzAksManagedClusterCommand -InputObject -Command [-ClusterToken ] - [-Context ] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-Context ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -111,21 +106,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ClusterToken AuthToken issued for AKS AAD Server App. @@ -187,36 +167,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -277,51 +227,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Stop-AzAksCluster.md b/src/Aks/Aks/help/Stop-AzAksCluster.md index 773c8d23fdde..f30dda237bda 100644 --- a/src/Aks/Aks/help/Stop-AzAksCluster.md +++ b/src/Aks/Aks/help/Stop-AzAksCluster.md @@ -18,17 +18,13 @@ See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster ### Stop (Default) ``` Stop-AzAksCluster -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### StopViaIdentity ``` -Stop-AzAksCluster -InputObject [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-PassThru] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] +Stop-AzAksCluster -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` @@ -71,21 +67,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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. @@ -102,36 +83,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter @@ -192,51 +143,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/Aks/Aks/help/Stop-AzAksDashboard.md b/src/Aks/Aks/help/Stop-AzAksDashboard.md index 02681ed30f9a..c66cbc837015 100644 --- a/src/Aks/Aks/help/Stop-AzAksDashboard.md +++ b/src/Aks/Aks/help/Stop-AzAksDashboard.md @@ -14,7 +14,7 @@ Stop the Kubectl SSH tunnel created in Start-AzKubernetesDashboard. ``` Stop-AzAksDashboard [-PassThru] [-DefaultProfile ] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -31,6 +31,36 @@ Stops the existing SSH tunnel setup by executing Start-AzKubernetesDashboard. ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with Azure. diff --git a/src/Aks/Aks/help/Update-AzAksMaintenanceConfiguration.md b/src/Aks/Aks/help/Update-AzAksMaintenanceConfiguration.md index bf3ea5ac0535..addcabed7a71 100644 --- a/src/Aks/Aks/help/Update-AzAksMaintenanceConfiguration.md +++ b/src/Aks/Aks/help/Update-AzAksMaintenanceConfiguration.md @@ -15,18 +15,26 @@ Update a maintenance configuration in the specified managed cluster. ### UpdateExpanded (Default) ``` Update-AzAksMaintenanceConfiguration -ConfigName -ResourceGroupName -ResourceName - [-SubscriptionId ] [-NotAllowedTime ] [-TimeInWeek ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] [-AbsoluteMonthlyDayOfMonth ] [-AbsoluteMonthlyIntervalMonth ] + [-DailyIntervalDay ] [-MaintenanceWindowDurationHour ] + [-MaintenanceWindowNotAllowedDate ] [-MaintenanceWindowStartDate ] + [-MaintenanceWindowStartTime ] [-MaintenanceWindowUtcOffset ] [-NotAllowedTime ] + [-RelativeMonthlyDayOfWeek ] [-RelativeMonthlyIntervalMonth ] + [-RelativeMonthlyWeekIndex ] [-TimeInWeek ] [-WeeklyDayOfWeek ] + [-WeeklyIntervalWeek ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzAksMaintenanceConfiguration -InputObject [-NotAllowedTime ] - [-TimeInWeek ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Update-AzAksMaintenanceConfiguration -InputObject [-AbsoluteMonthlyDayOfMonth ] + [-AbsoluteMonthlyIntervalMonth ] [-DailyIntervalDay ] [-MaintenanceWindowDurationHour ] + [-MaintenanceWindowNotAllowedDate ] [-MaintenanceWindowStartDate ] + [-MaintenanceWindowStartTime ] [-MaintenanceWindowUtcOffset ] [-NotAllowedTime ] + [-RelativeMonthlyDayOfWeek ] [-RelativeMonthlyIntervalMonth ] + [-RelativeMonthlyWeekIndex ] [-TimeInWeek ] [-WeeklyDayOfWeek ] + [-WeeklyIntervalWeek ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -67,23 +75,39 @@ Update a maintenance configuration "aks_maintenance_config" in a managed cluster ## PARAMETERS -### -Break -Wait for .NET debugger to attach +### -AbsoluteMonthlyDayOfMonth +The date of the month. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AbsoluteMonthlyIntervalMonth +Specifies the number of months between each set of occurrences. + +```yaml +Type: System.Int32 Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ConfigName The name of the maintenance configuration. +Supported values are 'default', 'aksManagedAutoUpgradeSchedule', or 'aksManagedNodeOSUpgradeSchedule'. ```yaml Type: System.String @@ -97,6 +121,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DailyIntervalDay +Specifies the number of days between each set of occurrences. + +```yaml +Type: System.Int32 +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. @@ -113,11 +152,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaintenanceWindowDurationHour +Length of maintenance window range from 4 to 24 hours. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -128,11 +182,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -MaintenanceWindowNotAllowedDate +Date ranges on which upgrade is not allowed. +'utcOffset' applies to this field. +For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Runtime.SendAsyncStep[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IDateSpan[] Parameter Sets: (All) Aliases: @@ -143,18 +199,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter +### -MaintenanceWindowStartDate +The date the maintenance window activates. +If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. +If not specified, the maintenance window will be active right away. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity -Parameter Sets: UpdateViaIdentityExpanded +Type: System.DateTime +Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowStartTime +The start time of the maintenance window. +Accepted values are from '00:00' to '23:59'. +'utcOffset' applies to this field. +For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowUtcOffset +The UTC offset in format +/-HH:mm. +For example, '+05:30' for IST and '-07:00' for PST. +If not specified, the default is '+00:00'. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` @@ -173,11 +266,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -RelativeMonthlyDayOfWeek +Specifies on which day of the week the maintenance occurs. ```yaml -Type: System.Uri +Type: System.String Parameter Sets: (All) Aliases: @@ -188,11 +281,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -RelativeMonthlyIntervalMonth +Specifies the number of months between each set of occurrences. ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -203,17 +296,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy +### -RelativeMonthlyWeekIndex +The week index. +Specifies on which week of the month the dayOfWeek applies. ```yaml -Type: System.Management.Automation.SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -281,6 +375,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WeeklyDayOfWeek +Specifies on which day of the week the maintenance occurs. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WeeklyIntervalWeek +Specifies the number of weeks between each set of occurrences. + +```yaml +Type: System.Int32 +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. diff --git a/src/Aks/Aks/help/Update-AzAksManagedNamespace.md b/src/Aks/Aks/help/Update-AzAksManagedNamespace.md new file mode 100644 index 000000000000..7c0adfc3387b --- /dev/null +++ b/src/Aks/Aks/help/Update-AzAksManagedNamespace.md @@ -0,0 +1,310 @@ +--- +external help file: Az.Aks-help.xml +Module Name: Az.Aks +online version: https://learn.microsoft.com/powershell/module/az.aks/update-azaksmanagednamespace +schema: 2.0.0 +--- + +# Update-AzAksManagedNamespace + +## SYNOPSIS +Update tags on a managed namespace. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] [-Tag ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonString +``` +Update-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityManagedClusterExpanded +``` +Update-AzAksManagedNamespace -Name -ManagedClusterInputObject [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityManagedCluster +``` +Update-AzAksManagedNamespace -Name -ManagedClusterInputObject -Parameter + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Update +``` +Update-AzAksManagedNamespace -Name -ResourceGroupName -ResourceName + [-SubscriptionId ] -Parameter [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAksManagedNamespace -InputObject [-Tag ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentity +``` +Update-AzAksManagedNamespace -InputObject -Parameter [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update tags on a managed namespace. + +## 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.Aks.Models.IAksIdentity +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity +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 +``` + +### -ManagedClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IAksIdentity +Parameter Sets: UpdateViaIdentityManagedClusterExpanded, UpdateViaIdentityManagedCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the managed namespace. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityManagedClusterExpanded, UpdateViaIdentityManagedCluster, Update +Aliases: ManagedNamespaceName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Tags object for patch operations. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.ITagsObject +Parameter Sets: UpdateViaIdentityManagedCluster, Update, UpdateViaIdentity +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceName +The name of the managed cluster resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, Update +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, UpdateViaJsonString, UpdateViaJsonFilePath, Update +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, UpdateViaIdentityManagedClusterExpanded, 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.Aks.Models.IAksIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.ITagsObject + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Aks.Models.IManagedNamespace + +## NOTES + +## RELATED LINKS diff --git a/src/Aks/Aks/help/Update-AzAksNodePool.md b/src/Aks/Aks/help/Update-AzAksNodePool.md index 46d32b477599..ac293cdfca1f 100644 --- a/src/Aks/Aks/help/Update-AzAksNodePool.md +++ b/src/Aks/Aks/help/Update-AzAksNodePool.md @@ -22,7 +22,7 @@ Update-AzAksNodePool -ResourceGroupName -ClusterName -Name ] [-MaxSurge ] [-MaxUnavailable ] [-DrainTimeoutInMinute ] [-NodeSoakDurationInMinute ] [-UndrainableNodeBehavior ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### ParentObjectParameterSet @@ -35,7 +35,7 @@ Update-AzAksNodePool -Name -ClusterObject [-NodeC [-SshAccess ] [-MaxSurge ] [-MaxUnavailable ] [-DrainTimeoutInMinute ] [-NodeSoakDurationInMinute ] [-UndrainableNodeBehavior ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [-SubscriptionId ] [] + [-AcquirePolicyToken] [-ChangeReference ] [-SubscriptionId ] [] ``` ### InputObjectParameterSet @@ -47,7 +47,8 @@ Update-AzAksNodePool -InputObject [-NodeCount ] [-NodeImageO [-ScaleDownMode ] [-EnableSecureBoot] [-EnableVtpm] [-SshAccess ] [-MaxSurge ] [-MaxUnavailable ] [-DrainTimeoutInMinute ] [-NodeSoakDurationInMinute ] [-UndrainableNodeBehavior ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] + [-SubscriptionId ] [] ``` ### IdParameterSet @@ -59,7 +60,8 @@ Update-AzAksNodePool -Id [-NodeCount ] [-NodeImageOnly] [-AsJob] [-ScaleDownMode ] [-EnableSecureBoot] [-EnableVtpm] [-SshAccess ] [-MaxSurge ] [-MaxUnavailable ] [-DrainTimeoutInMinute ] [-NodeSoakDurationInMinute ] [-UndrainableNodeBehavior ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [-SubscriptionId ] [] + [-WhatIf] [-Confirm] [-AcquirePolicyToken] [-ChangeReference ] + [-SubscriptionId ] [] ``` ## DESCRIPTION @@ -74,6 +76,21 @@ Update-AzAksNodePool -ResourceGroupName myResourceGroup -ClusterName myCluster - ## PARAMETERS +### -AcquirePolicyToken +Acquire an Azure Policy token automatically for this resource operation. + +```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 +``` + ### -AksCustomHeader Aks custom headers @@ -104,6 +121,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ChangeReference +The change reference resource ID for this resource operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ClusterName The name of the managed cluster resource.