Get-AzAksMaintenanceConfiguration
Gets the specified maintenance configuration of a managed cluster.
Syntax
List (Default)
Get-AzAksMaintenanceConfiguration
-ResourceGroupName <String>
-ResourceName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentityManagedCluster
Get-AzAksMaintenanceConfiguration
-ConfigName <String>
-ManagedClusterInputObject <IAksIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzAksMaintenanceConfiguration
-ConfigName <String>
-ResourceGroupName <String>
-ResourceName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
Get-AzAksMaintenanceConfiguration
-InputObject <IAksIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Gets the specified maintenance configuration of a managed cluster.
Examples
Example 1: List all maintenance configurations for a managed cluster
Get-AzAksMaintenanceConfiguration -ResourceGroupName mygroup -ResourceName myCluster
Name
----
aks_maintenance_config1
aks_maintenance_config2
List all maintenance configurations for a managed cluster "myCluster".
Example 2: Get a maintenance configuration with its config name
Get-AzAksMaintenanceConfiguration -ResourceGroupName mygroup -ResourceName myCluster -ConfigName 'aks_maintenance_config'
Name
----
aks_maintenance_config1
Get a maintenance configuration with name "aks_maintenance_config" for a managed cluster "myCluster".
Example 3: Get a maintenance configuration via identity
$TimeSpan = New-AzAksTimeSpanObject -Start (Get-Date -Year 2023 -Month 3 -Day 1) -End (Get-Date -Year 2023 -Month 3 -Day 2)
$TimeInWeek = New-AzAksTimeInWeekObject -Day 'Sunday' -HourSlot 1,2
$MaintenanceConfig = New-AzAksMaintenanceConfiguration -ResourceGroupName mygroup -ResourceName myCluster -ConfigName 'aks_maintenance_config' -TimeInWeek $TimeInWeek -NotAllowedTime $TimeSpan
$MaintenanceConfig | Get-AzAksMaintenanceConfiguration
Name
----
aks_maintenance_config
Get a maintenance configuration via identity for a managed cluster "myCluster".
Parameters
-ConfigName
The name of the maintenance configuration.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
GetViaIdentityManagedCluster
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Get
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None
Supports wildcards: False
DontShow: False
Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Identity Parameter
Type: IAksIdentity
Default value: None
Supports wildcards: False
DontShow: False
GetViaIdentity
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
Identity Parameter
Type: IAksIdentity
Default value: None
Supports wildcards: False
DontShow: False
GetViaIdentityManagedCluster
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
List
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Get
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ResourceName
The name of the managed cluster resource.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
List
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Get
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String [ ]
Default value: (Get-AzContext).Subscription.Id
Supports wildcards: False
DontShow: False
Parameter sets
List
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Get
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs