Share via


Microsoft.Azure.PowerShell.Cmdlets.Aks.Models Namespace

Classes

Name Description
AbsoluteMonthlySchedule

For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.

AccessProfile

Profile for enabling a user to access a managed cluster.

AdvancedNetworking

Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking.

AdvancedNetworkingObservability

Observability profile to enable advanced network metrics and flow logs with historical contexts.

AdvancedNetworkingSecurity

Security profile to enable security features on cilium based cluster.

AgentPool

Agent Pool.

AgentPoolAvailableVersions

The list of available versions for an agent pool.

AgentPoolAvailableVersionsProperties

The list of available agent pool versions.

AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem
AgentPoolDeleteMachinesParameter

Specifies a list of machine names from the agent pool to be deleted.

AgentPoolGatewayProfile

Profile of the managed cluster gateway agent pool.

AgentPoolListResult

The response from the List Agent Pools operation.

AgentPoolNetworkProfile

Network settings of an agent pool.

AgentPoolsAbortLatestOperationAcceptedResponseHeaders
AgentPoolSecurityProfile

The security settings of an agent pool.

AgentPoolStatus

Contains read-only information about the Agent Pool.

AgentPoolUpgradeProfile

The list of available upgrades for an agent pool.

AgentPoolUpgradeProfileProperties

The list of available upgrade versions.

AgentPoolUpgradeProfilePropertiesUpgradesItem
AgentPoolUpgradeSettings

Settings for upgrading an agentpool

AgentPoolWindowsProfile

The Windows agent pool's specific profile.

AksIdentity
Any

Anything

AzureKeyVaultKms

Azure Key Vault key management service settings for the security profile.

ClusterUpgradeSettings

Settings for upgrading a cluster.

CommandResultProperties

The results of a run command

CompatibleVersions

Version information about a product/service that is compatible with a service mesh revision.

ContainerServiceLinuxProfile

Profile for Linux VMs in the container service cluster.

ContainerServiceNetworkProfile

Profile of network configuration.

ContainerServiceSshConfiguration

SSH configuration for Linux-based VMs running on Azure.

ContainerServiceSshPublicKey

Contains information about SSH certificate public key data.

CreationData

Data used when creating a target resource from a source resource.

CredentialResult

The credential result response.

CredentialResults

The list credential result response.

DailySchedule

For schedules like: 'recur every day' or 'recur every 3 days'.

DateSpan

A date range. For example, between '2022-12-23' and '2023-01-05'.

DelegatedResource

Delegated resource properties - internal use only.

DelegatedResources

The set of delegated resources. The delegated resources dictionary keys will be source resource internal ids - internal use only.

EndpointDependency

A domain name that AKS agent nodes are reaching at.

EndpointDetail

connect information from the AKS agent nodes to a single endpoint.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

ExtendedLocation

The complex type of the extended location.

GpuProfile

GPU settings for the Agent Pool.

IPTag

Contains the IPTag associated with the object.

IstioCertificateAuthority

Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca

IstioComponents

Istio components configuration.

IstioEgressGateway

Istio egress gateway configuration.

IstioIngressGateway

Istio ingress gateway configuration. For now, we support up to one external ingress gateway named aks-istio-ingressgateway-external and one internal ingress gateway named aks-istio-ingressgateway-internal.

IstioPluginCertificateAuthority

Plugin certificates information for Service Mesh.

IstioServiceMesh

Istio service mesh configuration.

KubeletConfig

Kubelet configurations of agent nodes. See AKS custom node configuration for more details.

KubernetesPatchVersion

Kubernetes patch version profile

KubernetesVersion

Kubernetes version profile for given major.minor release.

KubernetesVersionCapabilities

Capabilities on this Kubernetes version.

KubernetesVersionListResult

Hold values properties, which is array of KubernetesVersion

KubernetesVersionPatchVersions

Patch versions of Kubernetes release

LinuxOSConfig

OS configurations of Linux agent nodes. See AKS custom node configuration for more details.

Machine

A machine. Contains details about the underlying virtual machine. A machine may be visible here but not in kubectl get nodes; if so it may be because the machine has not been registered with the Kubernetes API Server yet.

MachineIPAddress

The machine IP address details.

MachineListResult

The response from the List Machines operation.

MachineNetworkProperties

network properties of the machine

MachineProperties

The properties of the machine

MaintenanceConfiguration

Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster. See planned maintenance for more information about planned maintenance.

MaintenanceConfigurationListResult

The response from the List maintenance configurations operation.

MaintenanceConfigurationProperties

Properties used to configure planned maintenance for a Managed Cluster.

MaintenanceWindow

Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.

ManagedCluster

Managed cluster.

ManagedClusterAadProfile

AADProfile specifies attributes for Azure Active Directory integration. For more details see managed AAD on AKS.

ManagedClusterAccessProfile

Managed cluster Access Profile.

ManagedClusterAddonProfile

A Kubernetes add-on profile for a managed cluster.

ManagedClusterAddonProfileConfig

Key-value pairs for configuring an add-on.

ManagedClusterAddonProfileIdentity

Information of user assigned identity used by this add-on.

ManagedClusterAgentPoolProfile

Profile for the container service agent pool.

ManagedClusterAgentPoolProfileProperties

Properties for the container service agent pool profile.

ManagedClusterAgentPoolProfilePropertiesNodeLabels

The node labels to be persisted across all nodes in agent pool.

ManagedClusterAgentPoolProfilePropertiesTags

The tags to be persisted on the agent pool virtual machine scale set.

ManagedClusterAiToolchainOperatorProfile

When enabling the operator, a set of AKS managed CRDs and controllers will be installed in the cluster. The operator automates the deployment of OSS models for inference and/or training purposes. It provides a set of preset models and enables distributed inference against them.

ManagedClusterApiServerAccessProfile

Access profile for managed cluster API server.

ManagedClusterAutoUpgradeProfile

Auto upgrade profile for a managed cluster.

ManagedClusterAzureMonitorProfile

Azure Monitor addon profiles for monitoring the managed cluster.

ManagedClusterAzureMonitorProfileKubeStateMetrics

Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details.

ManagedClusterAzureMonitorProfileMetrics

Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview.

ManagedClusterBootstrapProfile

The bootstrap profile.

ManagedClusterCostAnalysis

The cost analysis configuration for the cluster

ManagedClusterHttpProxyConfig

Cluster HTTP proxy configuration.

ManagedClusterIdentity

Identity for the managed cluster.

ManagedClusterIdentityUserAssignedIdentities

The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed. The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedClusterIngressProfile

Ingress profile for the container service cluster.

ManagedClusterIngressProfileNginx
ManagedClusterIngressProfileWebAppRouting

Application Routing add-on settings for the ingress profile.

ManagedClusterListResult

The response from the List Managed Clusters operation.

ManagedClusterLoadBalancerProfile

Profile of the managed cluster load balancer.

ManagedClusterLoadBalancerProfileManagedOutboundIPs

Desired managed outbound IPs for the cluster load balancer.

ManagedClusterLoadBalancerProfileOutboundIPPrefixes

Desired outbound IP Prefix resources for the cluster load balancer.

ManagedClusterLoadBalancerProfileOutboundIPs

Desired outbound IP resources for the cluster load balancer.

ManagedClusterManagedOutboundIPProfile

Profile of the managed outbound IP resources of the managed cluster.

ManagedClusterMetricsProfile

The metrics profile for the ManagedCluster.

ManagedClusterNatGatewayProfile

Profile of the managed cluster NAT gateway.

ManagedClusterNodeProvisioningProfile
ManagedClusterNodeResourceGroupProfile

Node resource group lockdown profile for a managed cluster.

ManagedClusterOidcIssuerProfile

The OIDC issuer profile of the Managed Cluster.

ManagedClusterPodIdentity

Details about the pod identity assigned to the Managed Cluster.

ManagedClusterPodIdentityException

A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server. See disable AAD Pod Identity for a specific Pod/Application for more details.

ManagedClusterPodIdentityExceptionPodLabels

The pod labels to match.

ManagedClusterPodIdentityProfile

The pod identity profile of the Managed Cluster. See use AAD pod identity for more details on pod identity integration.

ManagedClusterPodIdentityProvisioningError

An error response from the pod identity provisioning.

ManagedClusterPodIdentityProvisioningErrorBody

An error response from the pod identity provisioning.

ManagedClusterPodIdentityProvisioningInfo
ManagedClusterPoolUpgradeProfile

The list of available upgrade versions.

ManagedClusterPoolUpgradeProfileUpgradesItem
ManagedClusterProperties

Properties of the managed cluster.

ManagedClusterPropertiesAddonProfiles

The profile of managed cluster add-on.

ManagedClusterPropertiesAutoScalerProfile

Parameters to be applied to the cluster-autoscaler when enabled

ManagedClusterPropertiesIdentityProfile

The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ManagedClustersAbortLatestOperationAcceptedResponseHeaders
ManagedClusterSecurityProfile

Security profile for the container service cluster.

ManagedClusterSecurityProfileDefender

Microsoft Defender settings for the security profile.

ManagedClusterSecurityProfileDefenderSecurityMonitoring

Microsoft Defender settings for the security profile threat detection.

ManagedClusterSecurityProfileImageCleaner

Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile.

ManagedClusterSecurityProfileWorkloadIdentity

Workload identity settings for the security profile.

ManagedClusterServicePrincipalProfile

Information about a service principal identity for the cluster to use for manipulating Azure APIs.

ManagedClusterSku

The SKU of a Managed Cluster.

ManagedClusterStaticEgressGatewayProfile

The Static Egress Gateway addon configuration for the cluster.

ManagedClusterStatus

Contains read-only information about the Managed Cluster.

ManagedClusterStorageProfile

Storage profile for the container service cluster.

ManagedClusterStorageProfileBlobCsiDriver

AzureBlob CSI Driver settings for the storage profile.

ManagedClusterStorageProfileDiskCsiDriver

AzureDisk CSI Driver settings for the storage profile.

ManagedClusterStorageProfileFileCsiDriver

AzureFile CSI Driver settings for the storage profile.

ManagedClusterStorageProfileSnapshotController

Snapshot Controller settings for the storage profile.

ManagedClusterUpgradeProfile

The list of available upgrades for compute pools.

ManagedClusterUpgradeProfileProperties

Control plane and agent pool upgrade profiles.

ManagedClusterWindowsProfile

Profile for Windows VMs in the managed cluster.

ManagedClusterWorkloadAutoScalerProfile

Workload Auto-scaler profile for the managed cluster.

ManagedClusterWorkloadAutoScalerProfileKeda

KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.

ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler

VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile.

ManagedServiceIdentityUserAssignedIdentitiesValue
ManualScaleProfile

Specifications on number of machines.

MeshRevision

Holds information on upgrades and compatibility for given major.minor mesh release.

MeshRevisionProfile

Mesh revision profile for a mesh.

MeshRevisionProfileList

Holds an array of MeshRevisionsProfiles

MeshRevisionProfileProperties

Mesh revision profile properties for a mesh

MeshUpgradeProfile

Upgrade profile for given mesh.

MeshUpgradeProfileList

Holds an array of MeshUpgradeProfiles

MeshUpgradeProfileProperties

Mesh upgrade profile properties for a major.minor release.

OperationListResult

The List Operation response.

OperationValue

Describes the properties of a Operation value.

OperationValueDisplay

Describes the properties of a Operation Value Display.

OrchestratorProfile

Contains information about orchestrator.

OrchestratorVersionProfile

The profile of an orchestrator and its available versions.

OrchestratorVersionProfileListResult

The list of versions for supported orchestrators.

OrchestratorVersionProfileProperties

The properties of an orchestrator version profile.

OutboundEnvironmentEndpoint

Egress endpoints which AKS agent nodes connect to for common purpose.

OutboundEnvironmentEndpointCollection

Collection of OutboundEnvironmentEndpoint

PortRange

The port range.

PowerState

Describes the Power State of the cluster

PrivateEndpoint

Private endpoint which a connection belongs to.

PrivateEndpointConnection

A private endpoint connection

PrivateEndpointConnectionListResult

A list of private endpoint connections

PrivateEndpointConnectionProperties

Properties of a private endpoint connection.

PrivateLinkResource

A private link resource

PrivateLinkResourcesListResult

A list of private link resources

PrivateLinkServiceConnectionState

The state of a private link service connection.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

RelativeMonthlySchedule

For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceReference

A reference to an Azure resource.

RunCommandRequest

A run command request

RunCommandResult

run command result.

ScaleProfile

Specifications on how to scale a VirtualMachines agent pool.

Schedule

One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule.

ServiceMeshProfile

Service mesh profile for a managed cluster.

Snapshot

A node pool snapshot resource.

SnapshotListResult

The response from the List Snapshots operation.

SnapshotProperties

Properties used to configure a node pool snapshot.

SubResource

Reference to another subresource.

SysctlConfig

Sysctl settings for Linux agent nodes.

SystemData

Metadata pertaining to creation and last modification of the resource.

TagsObject

Tags object for patch operations.

TagsObjectTags

Resource tags.

TimeInWeek

Time in a week.

TimeSpan

A time range. For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

TrackedResourceTags

Resource tags.

TrustedAccessRole

Trusted access role definition.

TrustedAccessRoleBinding

Defines binding between a resource and role

TrustedAccessRoleBindingListResult

List of trusted access role bindings

TrustedAccessRoleBindingProperties

Properties for trusted access role binding

TrustedAccessRoleListResult

List of trusted access roles

TrustedAccessRoleRule

Rule for trusted access role

UpgradeOverrideSettings

Settings for overrides when upgrading a cluster.

UserAssignedIdentity

Details about a user assigned identity.

VirtualMachineNodes

Current status on a group of nodes of the same vm size.

VirtualMachinesProfile

Specifications on VirtualMachines agent pool.

WeeklySchedule

For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.

WindowsGmsaProfile

Windows gMSA Profile in the managed cluster.

Interfaces

Name Description
IAbsoluteMonthlySchedule
IAccessProfile
IAdvancedNetworking
IAdvancedNetworkingObservability
IAdvancedNetworkingSecurity
IAgentPool
IAgentPoolAvailableVersions
IAgentPoolAvailableVersionsProperties
IAgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem
IAgentPoolDeleteMachinesParameter
IAgentPoolGatewayProfile
IAgentPoolListResult
IAgentPoolNetworkProfile
IAgentPoolsAbortLatestOperationAcceptedResponseHeaders
IAgentPoolSecurityProfile
IAgentPoolStatus
IAgentPoolUpgradeProfile
IAgentPoolUpgradeProfileProperties
IAgentPoolUpgradeProfilePropertiesUpgradesItem
IAgentPoolUpgradeSettings
IAgentPoolWindowsProfile
IAksIdentity
IAny
IAzureKeyVaultKms
IClusterUpgradeSettings
ICommandResultProperties
ICompatibleVersions
IContainerServiceLinuxProfile
IContainerServiceNetworkProfile
IContainerServiceSshConfiguration
IContainerServiceSshPublicKey
ICreationData
ICredentialResult
ICredentialResults
IDailySchedule
IDateSpan
IDelegatedResource
IDelegatedResources
IEndpointDependency
IEndpointDetail
IErrorAdditionalInfo
IErrorDetail
IErrorResponse
IExtendedLocation
IGpuProfile
IIPTag
IIstioCertificateAuthority
IIstioComponents
IIstioEgressGateway
IIstioIngressGateway
IIstioPluginCertificateAuthority
IIstioServiceMesh
IKubeletConfig
IKubernetesPatchVersion
IKubernetesVersion
IKubernetesVersionCapabilities
IKubernetesVersionListResult
IKubernetesVersionPatchVersions
ILinuxOSConfig
IMachine
IMachineIPAddress
IMachineListResult
IMachineNetworkProperties
IMachineProperties
IMaintenanceConfiguration
IMaintenanceConfigurationListResult
IMaintenanceConfigurationProperties
IMaintenanceWindow
IManagedCluster
IManagedClusterAadProfile
IManagedClusterAccessProfile
IManagedClusterAddonProfile
IManagedClusterAddonProfileConfig
IManagedClusterAddonProfileIdentity
IManagedClusterAgentPoolProfile
IManagedClusterAgentPoolProfileProperties
IManagedClusterAgentPoolProfilePropertiesNodeLabels
IManagedClusterAgentPoolProfilePropertiesTags
IManagedClusterAiToolchainOperatorProfile
IManagedClusterApiServerAccessProfile
IManagedClusterAutoUpgradeProfile
IManagedClusterAzureMonitorProfile
IManagedClusterAzureMonitorProfileKubeStateMetrics
IManagedClusterAzureMonitorProfileMetrics
IManagedClusterBootstrapProfile
IManagedClusterCostAnalysis
IManagedClusterHttpProxyConfig
IManagedClusterIdentity
IManagedClusterIdentityUserAssignedIdentities
IManagedClusterIngressProfile
IManagedClusterIngressProfileNginx
IManagedClusterIngressProfileWebAppRouting
IManagedClusterListResult
IManagedClusterLoadBalancerProfile
IManagedClusterLoadBalancerProfileManagedOutboundIPs
IManagedClusterLoadBalancerProfileOutboundIPPrefixes
IManagedClusterLoadBalancerProfileOutboundIPs
IManagedClusterManagedOutboundIPProfile
IManagedClusterMetricsProfile
IManagedClusterNatGatewayProfile
IManagedClusterNodeProvisioningProfile
IManagedClusterNodeResourceGroupProfile
IManagedClusterOidcIssuerProfile
IManagedClusterPodIdentity
IManagedClusterPodIdentityException
IManagedClusterPodIdentityExceptionPodLabels
IManagedClusterPodIdentityProfile
IManagedClusterPodIdentityProvisioningError
IManagedClusterPodIdentityProvisioningErrorBody
IManagedClusterPodIdentityProvisioningInfo
IManagedClusterPoolUpgradeProfile
IManagedClusterPoolUpgradeProfileUpgradesItem
IManagedClusterProperties
IManagedClusterPropertiesAddonProfiles
IManagedClusterPropertiesAutoScalerProfile
IManagedClusterPropertiesIdentityProfile
IManagedClustersAbortLatestOperationAcceptedResponseHeaders
IManagedClusterSecurityProfile
IManagedClusterSecurityProfileDefender
IManagedClusterSecurityProfileDefenderSecurityMonitoring
IManagedClusterSecurityProfileImageCleaner
IManagedClusterSecurityProfileWorkloadIdentity
IManagedClusterServicePrincipalProfile
IManagedClusterSku
IManagedClusterStaticEgressGatewayProfile
IManagedClusterStatus
IManagedClusterStorageProfile
IManagedClusterStorageProfileBlobCsiDriver
IManagedClusterStorageProfileDiskCsiDriver
IManagedClusterStorageProfileFileCsiDriver
IManagedClusterStorageProfileSnapshotController
IManagedClusterUpgradeProfile
IManagedClusterUpgradeProfileProperties
IManagedClusterWindowsProfile
IManagedClusterWorkloadAutoScalerProfile
IManagedClusterWorkloadAutoScalerProfileKeda
IManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler
IManagedServiceIdentityUserAssignedIdentitiesValue
IManualScaleProfile
IMeshRevision
IMeshRevisionProfile
IMeshRevisionProfileList
IMeshRevisionProfileProperties
IMeshUpgradeProfile
IMeshUpgradeProfileList
IMeshUpgradeProfileProperties
IOperationListResult
IOperationValue
IOperationValueDisplay
IOrchestratorProfile
IOrchestratorVersionProfile
IOrchestratorVersionProfileListResult
IOrchestratorVersionProfileProperties
IOutboundEnvironmentEndpoint
IOutboundEnvironmentEndpointCollection
IPortRange
IPowerState
IPrivateEndpoint
IPrivateEndpointConnection
IPrivateEndpointConnectionListResult
IPrivateEndpointConnectionProperties
IPrivateLinkResource
IPrivateLinkResourcesListResult
IPrivateLinkServiceConnectionState
IProxyResource
IRelativeMonthlySchedule
IResource
IResourceReference
IRunCommandRequest
IRunCommandResult
IScaleProfile
ISchedule
IServiceMeshProfile
ISnapshot
ISnapshotListResult
ISnapshotProperties
ISubResource
ISysctlConfig
ISystemData
ITagsObject
ITagsObjectTags
ITimeInWeek
ITimeSpan
ITrackedResource
ITrackedResourceTags
ITrustedAccessRole
ITrustedAccessRoleBinding
ITrustedAccessRoleBindingListResult
ITrustedAccessRoleBindingProperties
ITrustedAccessRoleListResult
ITrustedAccessRoleRule
IUpgradeOverrideSettings
IUserAssignedIdentity
IVirtualMachineNodes
IVirtualMachinesProfile
IWeeklySchedule
IWindowsGmsaProfile