Package-level declarations

Types

Link copied to clipboard
data class AbsoluteMonthlyScheduleResponse(val dayOfMonth: Int, val intervalMonths: Int)

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

Link copied to clipboard
data class AdvancedNetworkingObservabilityResponse(val enabled: Boolean? = null)

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

Link copied to clipboard
data class AdvancedNetworkingResponse(val enabled: Boolean? = null, val observability: AdvancedNetworkingObservabilityResponse? = null, val security: AdvancedNetworkingSecurityResponse? = null)

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

Link copied to clipboard
data class AdvancedNetworkingSecurityResponse(val enabled: Boolean? = null)

Security profile to enable security features on cilium based cluster.

Link copied to clipboard
data class AgentPoolNetworkProfileResponse(val allowedHostPorts: List<PortRangeResponse>? = null, val applicationSecurityGroups: List<String>? = null, val nodePublicIPTags: List<IPTagResponse>? = null)

Network settings of an agent pool.

Link copied to clipboard
data class AgentPoolSecurityProfileResponse(val enableSecureBoot: Boolean? = null, val enableVTPM: Boolean? = null)

The security settings of an agent pool.

Link copied to clipboard
data class AgentPoolUpgradeSettingsResponse(val drainTimeoutInMinutes: Int? = null, val maxSurge: String? = null, val nodeSoakDurationInMinutes: Int? = null)

Settings for upgrading an agentpool

Link copied to clipboard
data class AgentPoolWindowsProfileResponse(val disableOutboundNat: Boolean? = null)

The Windows agent pool's specific profile.

Link copied to clipboard
data class AgentProfileResponse(val subnetId: String? = null, val vmSize: String? = null)

Agent profile for the Fleet hub.

Link copied to clipboard
data class APIServerAccessProfileResponse(val enablePrivateCluster: Boolean? = null, val enableVnetIntegration: Boolean? = null, val subnetId: String? = null)

Access profile for the Fleet hub API server.

Link copied to clipboard

The node image upgrade to be applied to the target clusters in auto upgrade.

Link copied to clipboard
data class AzureKeyVaultKmsResponse(val enabled: Boolean? = null, val keyId: String? = null, val keyVaultNetworkAccess: String? = null, val keyVaultResourceId: String? = null)

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

Link copied to clipboard
data class ClusterUpgradeSettingsResponse(val overrideSettings: UpgradeOverrideSettingsResponse? = null)

Settings for upgrading a cluster.

Link copied to clipboard

Profile for Linux VMs in the container service cluster.

Link copied to clipboard
data class ContainerServiceNetworkProfileResponse(val advancedNetworking: AdvancedNetworkingResponse? = null, val dnsServiceIP: String? = null, val ipFamilies: List<String>? = null, val loadBalancerProfile: ManagedClusterLoadBalancerProfileResponse? = null, val loadBalancerSku: String? = null, val natGatewayProfile: ManagedClusterNATGatewayProfileResponse? = null, val networkDataplane: String? = null, val networkMode: String? = null, val networkPlugin: String? = null, val networkPluginMode: String? = null, val networkPolicy: String? = null, val outboundType: String? = null, val podCidr: String? = null, val podCidrs: List<String>? = null, val serviceCidr: String? = null, val serviceCidrs: List<String>? = null)

Profile of network configuration.

Link copied to clipboard

SSH configuration for Linux-based VMs running on Azure.

Link copied to clipboard

Contains information about SSH certificate public key data.

Link copied to clipboard
data class CreationDataResponse(val sourceResourceId: String? = null)

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

Link copied to clipboard
data class CredentialResultResponse(val name: String, val value: String)

The credential result response.

Link copied to clipboard
data class DailyScheduleResponse(val intervalDays: Int)

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

Link copied to clipboard
data class DateSpanResponse(val end: String, val start: String)

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

Link copied to clipboard
data class DelegatedResourceResponse(val location: String? = null, val referralResource: String? = null, val resourceId: String? = null, val tenantId: String? = null)

Delegated resource properties - internal use only.

Link copied to clipboard
data class ErrorAdditionalInfoResponse(val info: Any, val type: String)

The resource management error additional info.

Link copied to clipboard
data class ErrorDetailResponse(val additionalInfo: List<ErrorAdditionalInfoResponse>, val code: String, val details: List<ErrorDetailResponse>, val message: String, val target: String)

The error detail.

Link copied to clipboard
data class ExtendedLocationResponse(val name: String? = null, val type: String? = null)

The complex type of the extended location.

Link copied to clipboard
data class FleetCredentialResultResponse(val name: String, val value: String)

One credential result item.

Link copied to clipboard
data class FleetHubProfileResponse(val agentProfile: AgentProfileResponse? = null, val apiServerAccessProfile: APIServerAccessProfileResponse? = null, val dnsPrefix: String? = null, val fqdn: String, val kubernetesVersion: String, val portalFqdn: String)

The FleetHubProfile configures the fleet hub.

Link copied to clipboard
data class GetAgentPoolResult(val availabilityZones: List<String>? = null, val azureApiVersion: String, val capacityReservationGroupID: String? = null, val count: Int? = null, val creationData: CreationDataResponse? = null, val currentOrchestratorVersion: String, val eTag: String, val enableAutoScaling: Boolean? = null, val enableEncryptionAtHost: Boolean? = null, val enableFIPS: Boolean? = null, val enableNodePublicIP: Boolean? = null, val enableUltraSSD: Boolean? = null, val gpuInstanceProfile: String? = null, val hostGroupID: String? = null, val id: String, val kubeletConfig: KubeletConfigResponse? = null, val kubeletDiskType: String? = null, val linuxOSConfig: LinuxOSConfigResponse? = null, val maxCount: Int? = null, val maxPods: Int? = null, val messageOfTheDay: String? = null, val minCount: Int? = null, val mode: String? = null, val name: String, val networkProfile: AgentPoolNetworkProfileResponse? = null, val nodeImageVersion: String, val nodeLabels: Map<String, String>? = null, val nodePublicIPPrefixID: String? = null, val nodeTaints: List<String>? = null, val orchestratorVersion: String? = null, val osDiskSizeGB: Int? = null, val osDiskType: String? = null, val osSKU: String? = null, val osType: String? = null, val podSubnetID: String? = null, val powerState: PowerStateResponse? = null, val provisioningState: String, val proximityPlacementGroupID: String? = null, val scaleDownMode: String? = null, val scaleSetEvictionPolicy: String? = null, val scaleSetPriority: String? = null, val securityProfile: AgentPoolSecurityProfileResponse? = null, val spotMaxPrice: Double? = null, val tags: Map<String, String>? = null, val type: String, val upgradeSettings: AgentPoolUpgradeSettingsResponse? = null, val vmSize: String? = null, val vnetSubnetID: String? = null, val windowsProfile: AgentPoolWindowsProfileResponse? = null, val workloadRuntime: String? = null)

Agent Pool.

Link copied to clipboard
data class GetAutoUpgradeProfileResult(val azureApiVersion: String, val channel: String, val disabled: Boolean? = null, val eTag: String, val id: String, val name: String, val nodeImageSelection: AutoUpgradeNodeImageSelectionResponse? = null, val provisioningState: String, val systemData: SystemDataResponse, val type: String, val updateStrategyId: String? = null)

The AutoUpgradeProfile resource.

Link copied to clipboard
data class GetFleetMemberResult(val azureApiVersion: String, val clusterResourceId: String, val eTag: String, val group: String? = null, val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.

Link copied to clipboard
data class GetFleetResult(val azureApiVersion: String, val eTag: String, val hubProfile: FleetHubProfileResponse? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The Fleet resource.

Link copied to clipboard
data class GetFleetUpdateStrategyResult(val azureApiVersion: String, val eTag: String, val id: String, val name: String, val provisioningState: String, val strategy: UpdateRunStrategyResponse, val systemData: SystemDataResponse, val type: String)

Defines a multi-stage process to perform update operations across members of a Fleet.

Link copied to clipboard
data class GetLoadBalancerResult(val allowServicePlacement: Boolean? = null, val azureApiVersion: String, val id: String, val name: String, val nodeSelector: LabelSelectorResponse? = null, val primaryAgentPoolName: String, val provisioningState: String, val serviceLabelSelector: LabelSelectorResponse? = null, val serviceNamespaceSelector: LabelSelectorResponse? = null, val systemData: SystemDataResponse, val type: String)

The configurations regarding multiple standard load balancers. If not supplied, single load balancer mode will be used. Multiple standard load balancers mode will be used if at lease one configuration is supplied. There has to be a configuration named kubernetes.

Link copied to clipboard
data class GetMaintenanceConfigurationResult(val azureApiVersion: String, val id: String, val maintenanceWindow: MaintenanceWindowResponse? = null, val name: String, val notAllowedTime: List<TimeSpanResponse>? = null, val systemData: SystemDataResponse, val timeInWeek: List<TimeInWeekResponse>? = null, val type: String)

See planned maintenance for more information about planned maintenance.

Link copied to clipboard
data class GetManagedClusterResult(val aadProfile: ManagedClusterAADProfileResponse? = null, val addonProfiles: Map<String, ManagedClusterAddonProfileResponse>? = null, val agentPoolProfiles: List<ManagedClusterAgentPoolProfileResponse>? = null, val apiServerAccessProfile: ManagedClusterAPIServerAccessProfileResponse? = null, val autoScalerProfile: ManagedClusterPropertiesResponseAutoScalerProfile? = null, val autoUpgradeProfile: ManagedClusterAutoUpgradeProfileResponse? = null, val azureApiVersion: String, val azureMonitorProfile: ManagedClusterAzureMonitorProfileResponse? = null, val azurePortalFQDN: String, val currentKubernetesVersion: String, val disableLocalAccounts: Boolean? = null, val diskEncryptionSetID: String? = null, val dnsPrefix: String? = null, val eTag: String, val enablePodSecurityPolicy: Boolean? = null, val enableRBAC: Boolean? = null, val extendedLocation: ExtendedLocationResponse? = null, val fqdn: String, val fqdnSubdomain: String? = null, val httpProxyConfig: ManagedClusterHTTPProxyConfigResponse? = null, val id: String, val identity: ManagedClusterIdentityResponse? = null, val identityProfile: Map<String, UserAssignedIdentityResponse>? = null, val ingressProfile: ManagedClusterIngressProfileResponse? = null, val kubernetesVersion: String? = null, val linuxProfile: ContainerServiceLinuxProfileResponse? = null, val location: String, val maxAgentPools: Int, val metricsProfile: ManagedClusterMetricsProfileResponse? = null, val name: String, val networkProfile: ContainerServiceNetworkProfileResponse? = null, val nodeResourceGroup: String? = null, val nodeResourceGroupProfile: ManagedClusterNodeResourceGroupProfileResponse? = null, val oidcIssuerProfile: ManagedClusterOIDCIssuerProfileResponse? = null, val podIdentityProfile: ManagedClusterPodIdentityProfileResponse? = null, val powerState: PowerStateResponse, val privateFQDN: String, val privateLinkResources: List<PrivateLinkResourceResponse>? = null, val provisioningState: String, val publicNetworkAccess: String? = null, val resourceUID: String, val securityProfile: ManagedClusterSecurityProfileResponse? = null, val serviceMeshProfile: ServiceMeshProfileResponse? = null, val servicePrincipalProfile: ManagedClusterServicePrincipalProfileResponse? = null, val sku: ManagedClusterSKUResponse? = null, val storageProfile: ManagedClusterStorageProfileResponse? = null, val supportPlan: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val upgradeSettings: ClusterUpgradeSettingsResponse? = null, val windowsProfile: ManagedClusterWindowsProfileResponse? = null, val workloadAutoScalerProfile: ManagedClusterWorkloadAutoScalerProfileResponse? = null)

Managed cluster.

Link copied to clipboard
data class GetManagedClusterSnapshotResult(val azureApiVersion: String, val creationData: CreationDataResponse? = null, val id: String, val location: String, val managedClusterPropertiesReadOnly: ManagedClusterPropertiesForSnapshotResponse, val name: String, val snapshotType: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A managed cluster snapshot resource.

Link copied to clipboard
data class GetNamespaceResult(val azureApiVersion: String, val eTag: String, val id: String, val location: String? = null, val name: String, val properties: NamespacePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Namespace managed by ARM.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val type: String)

A private endpoint connection

Link copied to clipboard
data class GetSnapshotResult(val azureApiVersion: String, val creationData: CreationDataResponse? = null, val enableFIPS: Boolean, val id: String, val kubernetesVersion: String, val location: String, val name: String, val nodeImageVersion: String, val osSku: String, val osType: String, val snapshotType: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vmSize: String)

A node pool snapshot resource.

Link copied to clipboard
data class GetTrustedAccessRoleBindingResult(val azureApiVersion: String, val id: String, val name: String, val provisioningState: String, val roles: List<String>, val sourceResourceId: String, val systemData: SystemDataResponse, val type: String)

Defines binding between a resource and role

Link copied to clipboard
data class GetUpdateRunResult(val azureApiVersion: String, val eTag: String, val id: String, val managedClusterUpdate: ManagedClusterUpdateResponse, val name: String, val provisioningState: String, val status: UpdateRunStatusResponse, val strategy: UpdateRunStrategyResponse? = null, val systemData: SystemDataResponse, val type: String, val updateStrategyId: String? = null)

A multi-stage process to perform update operations across members of a Fleet.

Link copied to clipboard
data class IPTagResponse(val ipTagType: String? = null, val tag: String? = null)

Contains the IPTag associated with the object.

Link copied to clipboard

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

Link copied to clipboard
data class IstioComponentsResponse(val egressGateways: List<IstioEgressGatewayResponse>? = null, val ingressGateways: List<IstioIngressGatewayResponse>? = null)

Istio components configuration.

Link copied to clipboard
data class IstioEgressGatewayResponse(val enabled: Boolean)

Istio egress gateway configuration.

Link copied to clipboard
data class IstioIngressGatewayResponse(val enabled: Boolean, val mode: String)

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.

Link copied to clipboard
data class IstioPluginCertificateAuthorityResponse(val certChainObjectName: String? = null, val certObjectName: String? = null, val keyObjectName: String? = null, val keyVaultId: String? = null, val rootCertObjectName: String? = null)

Plugin certificates information for Service Mesh.

Link copied to clipboard
data class IstioServiceMeshResponse(val certificateAuthority: IstioCertificateAuthorityResponse? = null, val components: IstioComponentsResponse? = null, val revisions: List<String>? = null)

Istio service mesh configuration.

Link copied to clipboard
data class KubeletConfigResponse(val allowedUnsafeSysctls: List<String>? = null, val containerLogMaxFiles: Int? = null, val containerLogMaxSizeMB: Int? = null, val cpuCfsQuota: Boolean? = null, val cpuCfsQuotaPeriod: String? = null, val cpuManagerPolicy: String? = null, val failSwapOn: Boolean? = null, val imageGcHighThreshold: Int? = null, val imageGcLowThreshold: Int? = null, val podMaxPids: Int? = null, val topologyManagerPolicy: String? = null)

See AKS custom node configuration for more details.

Link copied to clipboard
data class LabelSelectorRequirementResponse(val key: String? = null, val operator: String? = null, val values: List<String>? = null)

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Link copied to clipboard
data class LabelSelectorResponse(val matchExpressions: List<LabelSelectorRequirementResponse>? = null, val matchLabels: List<String>? = null)

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

Link copied to clipboard
data class LinuxOSConfigResponse(val swapFileSizeMB: Int? = null, val sysctls: SysctlConfigResponse? = null, val transparentHugePageDefrag: String? = null, val transparentHugePageEnabled: String? = null)

See AKS custom node configuration for more details.

Link copied to clipboard

The Credential results response.

Link copied to clipboard
data class ListManagedClusterAccessProfileResult(val id: String, val kubeConfig: String? = null, val location: String, val name: String, val tags: Map<String, String>? = null, val type: String)

Managed cluster Access Profile.

Link copied to clipboard

The list credential result response.

The list credential result response.

Link copied to clipboard

The list credential result response.

Link copied to clipboard

The list credential result response.

Link copied to clipboard
data class MaintenanceWindowResponse(val durationHours: Int, val notAllowedDates: List<DateSpanResponse>? = null, val schedule: ScheduleResponse, val startDate: String? = null, val startTime: String, val utcOffset: String? = null)

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

Link copied to clipboard
data class ManagedClusterAADProfileResponse(val adminGroupObjectIDs: List<String>? = null, val clientAppID: String? = null, val enableAzureRBAC: Boolean? = null, val managed: Boolean? = null, val serverAppID: String? = null, val serverAppSecret: String? = null, val tenantID: String? = null)

For more details see managed AAD on AKS.

Link copied to clipboard
data class ManagedClusterAddonProfileResponse(val config: Map<String, String>? = null, val enabled: Boolean, val identity: ManagedClusterAddonProfileResponseIdentity)

A Kubernetes add-on profile for a managed cluster.

data class ManagedClusterAddonProfileResponseIdentity(val clientId: String? = null, val objectId: String? = null, val resourceId: String? = null)

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

Link copied to clipboard
data class ManagedClusterAgentPoolProfileResponse(val availabilityZones: List<String>? = null, val capacityReservationGroupID: String? = null, val count: Int? = null, val creationData: CreationDataResponse? = null, val currentOrchestratorVersion: String, val eTag: String, val enableAutoScaling: Boolean? = null, val enableEncryptionAtHost: Boolean? = null, val enableFIPS: Boolean? = null, val enableNodePublicIP: Boolean? = null, val enableUltraSSD: Boolean? = null, val gpuInstanceProfile: String? = null, val hostGroupID: String? = null, val kubeletConfig: KubeletConfigResponse? = null, val kubeletDiskType: String? = null, val linuxOSConfig: LinuxOSConfigResponse? = null, val maxCount: Int? = null, val maxPods: Int? = null, val messageOfTheDay: String? = null, val minCount: Int? = null, val mode: String? = null, val name: String, val networkProfile: AgentPoolNetworkProfileResponse? = null, val nodeImageVersion: String, val nodeLabels: Map<String, String>? = null, val nodePublicIPPrefixID: String? = null, val nodeTaints: List<String>? = null, val orchestratorVersion: String? = null, val osDiskSizeGB: Int? = null, val osDiskType: String? = null, val osSKU: String? = null, val osType: String? = null, val podSubnetID: String? = null, val powerState: PowerStateResponse? = null, val provisioningState: String, val proximityPlacementGroupID: String? = null, val scaleDownMode: String? = null, val scaleSetEvictionPolicy: String? = null, val scaleSetPriority: String? = null, val securityProfile: AgentPoolSecurityProfileResponse? = null, val spotMaxPrice: Double? = null, val tags: Map<String, String>? = null, val type: String? = null, val upgradeSettings: AgentPoolUpgradeSettingsResponse? = null, val vmSize: String? = null, val vnetSubnetID: String? = null, val windowsProfile: AgentPoolWindowsProfileResponse? = null, val workloadRuntime: String? = null)

Profile for the container service agent pool.

data class ManagedClusterAPIServerAccessProfileResponse(val authorizedIPRanges: List<String>? = null, val disableRunCommand: Boolean? = null, val enablePrivateCluster: Boolean? = null, val enablePrivateClusterPublicFQDN: Boolean? = null, val privateDNSZone: String? = null)

Access profile for managed cluster API server.

Link copied to clipboard
data class ManagedClusterAutoUpgradeProfileResponse(val nodeOSUpgradeChannel: String? = null, val upgradeChannel: String? = null)

Auto upgrade profile for a managed cluster.

data class ManagedClusterAzureMonitorProfileKubeStateMetricsResponse(val metricAnnotationsAllowList: String? = null, val metricLabelsAllowlist: String? = null)

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.

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.

Azure Monitor addon profiles for monitoring the managed cluster.

Link copied to clipboard
data class ManagedClusterCostAnalysisResponse(val enabled: Boolean? = null)

The cost analysis configuration for the cluster

Link copied to clipboard
data class ManagedClusterHTTPProxyConfigResponse(val httpProxy: String? = null, val httpsProxy: String? = null, val noProxy: List<String>? = null, val trustedCa: String? = null)

Cluster HTTP proxy configuration.

Link copied to clipboard
data class ManagedClusterIdentityResponse(val delegatedResources: Map<String, DelegatedResourceResponse>? = null, val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, ManagedClusterIdentityResponseUserAssignedIdentities>? = null)

Identity for the managed cluster.

Link copied to clipboard

Ingress profile for the container service cluster.

data class ManagedClusterIngressProfileWebAppRoutingResponse(val dnsZoneResourceIds: List<String>? = null, val enabled: Boolean? = null, val identity: UserAssignedIdentityResponse)

Application Routing add-on settings for the ingress profile.

data class ManagedClusterLoadBalancerProfileResponse(val allocatedOutboundPorts: Int? = null, val backendPoolType: String? = null, val effectiveOutboundIPs: List<ResourceReferenceResponse>? = null, val enableMultipleStandardLoadBalancers: Boolean? = null, val idleTimeoutInMinutes: Int? = null, val managedOutboundIPs: ManagedClusterLoadBalancerProfileResponseManagedOutboundIPs? = null, val outboundIPPrefixes: ManagedClusterLoadBalancerProfileResponseOutboundIPPrefixes? = null, val outboundIPs: ManagedClusterLoadBalancerProfileResponseOutboundIPs? = null)

Profile of the managed cluster load balancer.

data class ManagedClusterLoadBalancerProfileResponseManagedOutboundIPs(val count: Int? = null, val countIPv6: Int? = null)

Desired managed outbound IPs for the cluster load balancer.

Desired outbound IP Prefix resources for the cluster load balancer.

Desired outbound IP resources for the cluster load balancer.

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

Link copied to clipboard

The metrics profile for the ManagedCluster.

Link copied to clipboard
data class ManagedClusterNATGatewayProfileResponse(val effectiveOutboundIPs: List<ResourceReferenceResponse>? = null, val idleTimeoutInMinutes: Int? = null, val managedOutboundIPProfile: ManagedClusterManagedOutboundIPProfileResponse? = null)

Profile of the managed cluster NAT gateway.

data class ManagedClusterNodeResourceGroupProfileResponse(val restrictionLevel: String? = null)

Node resource group lockdown profile for a managed cluster.

Link copied to clipboard
data class ManagedClusterOIDCIssuerProfileResponse(val enabled: Boolean? = null, val issuerURL: String)

The OIDC issuer profile of the Managed Cluster.

data class ManagedClusterPodIdentityExceptionResponse(val name: String, val namespace: String, val podLabels: Map<String, String>)
Link copied to clipboard
data class ManagedClusterPodIdentityProfileResponse(val allowNetworkPluginKubenet: Boolean? = null, val enabled: Boolean? = null, val userAssignedIdentities: List<ManagedClusterPodIdentityResponse>? = null, val userAssignedIdentityExceptions: List<ManagedClusterPodIdentityExceptionResponse>? = null)

See use AAD pod identity for more details on pod identity integration.

data class ManagedClusterPodIdentityProvisioningErrorBodyResponse(val code: String? = null, val details: List<ManagedClusterPodIdentityProvisioningErrorBodyResponse>? = null, val message: String? = null, val target: String? = null)

An error response from the pod identity provisioning.

An error response from the pod identity provisioning.

Link copied to clipboard
data class ManagedClusterPodIdentityResponse(val bindingSelector: String? = null, val identity: UserAssignedIdentityResponse, val name: String, val namespace: String, val provisioningInfo: ManagedClusterPodIdentityResponseProvisioningInfo, val provisioningState: String)

Details about the pod identity assigned to the Managed Cluster.

data class ManagedClusterPropertiesForSnapshotResponse(val enableRbac: Boolean? = null, val kubernetesVersion: String? = null, val networkProfile: NetworkProfileForSnapshotResponse, val sku: ManagedClusterSKUResponse? = null)

managed cluster properties for snapshot, these properties are read only.

data class ManagedClusterPropertiesResponseAutoScalerProfile(val balanceSimilarNodeGroups: String? = null, val daemonsetEvictionForEmptyNodes: Boolean? = null, val daemonsetEvictionForOccupiedNodes: Boolean? = null, val expander: String? = null, val ignoreDaemonsetsUtilization: Boolean? = null, val maxEmptyBulkDelete: String? = null, val maxGracefulTerminationSec: String? = null, val maxNodeProvisionTime: String? = null, val maxTotalUnreadyPercentage: String? = null, val newPodScaleUpDelay: String? = null, val okTotalUnreadyCount: String? = null, val scaleDownDelayAfterAdd: String? = null, val scaleDownDelayAfterDelete: String? = null, val scaleDownDelayAfterFailure: String? = null, val scaleDownUnneededTime: String? = null, val scaleDownUnreadyTime: String? = null, val scaleDownUtilizationThreshold: String? = null, val scanInterval: String? = null, val skipNodesWithLocalStorage: String? = null, val skipNodesWithSystemPods: String? = null)

Parameters to be applied to the cluster-autoscaler when enabled

data class ManagedClusterSecurityProfileDefenderResponse(val logAnalyticsWorkspaceResourceId: String? = null, val securityMonitoring: ManagedClusterSecurityProfileDefenderSecurityMonitoringResponse? = null)

Microsoft Defender settings for the security profile.

Microsoft Defender settings for the security profile threat detection.

data class ManagedClusterSecurityProfileImageCleanerResponse(val enabled: Boolean? = null, val intervalHours: Int? = null)

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.

Link copied to clipboard

Security profile for the container service cluster.

Workload identity settings for the security profile.

data class ManagedClusterServicePrincipalProfileResponse(val clientId: String, val secret: String? = null)

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

Link copied to clipboard
data class ManagedClusterSKUResponse(val name: String? = null, val tier: String? = null)

The SKU of a Managed Cluster.

AzureBlob CSI Driver settings for the storage profile.

AzureDisk CSI Driver settings for the storage profile.

AzureFile CSI Driver settings for the storage profile.

Link copied to clipboard

Storage profile for the container service cluster.

Snapshot Controller settings for the storage profile.

Link copied to clipboard
data class ManagedClusterUpdateResponse(val nodeImageSelection: NodeImageSelectionResponse? = null, val upgrade: ManagedClusterUpgradeSpecResponse)

The update to be applied to the ManagedClusters.

Link copied to clipboard
data class ManagedClusterUpgradeSpecResponse(val kubernetesVersion: String? = null, val type: String)

The upgrade to apply to a ManagedCluster.

Link copied to clipboard
data class ManagedClusterWindowsProfileResponse(val adminPassword: String? = null, val adminUsername: String, val enableCSIProxy: Boolean? = null, val gmsaProfile: WindowsGmsaProfileResponse? = null, val licenseType: String? = null)

Profile for Windows VMs in the managed cluster.

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

Workload Auto-scaler profile for the managed cluster.

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

Link copied to clipboard
data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Managed service identity (system assigned and/or user assigned identities)

Link copied to clipboard
data class MemberUpdateStatusResponse(val clusterResourceId: String, val message: String, val name: String, val operationId: String, val status: UpdateStatusResponse)

The status of a member update operation.

Link copied to clipboard
data class NamespacePropertiesResponse(val adoptionPolicy: String? = null, val annotations: Map<String, String>? = null, val defaultNetworkPolicy: NetworkPoliciesResponse? = null, val defaultResourceQuota: ResourceQuotaResponse? = null, val deletePolicy: String? = null, val labels: Map<String, String>? = null, val provisioningState: String)

Properties of a namespace managed by ARM

Link copied to clipboard
data class NetworkPoliciesResponse(val egress: String? = null, val ingress: String? = null)

Default network policy of the namespace, specifying ingress and egress rules.

Link copied to clipboard
data class NetworkProfileForSnapshotResponse(val loadBalancerSku: String? = null, val networkMode: String? = null, val networkPlugin: String? = null, val networkPluginMode: String? = null, val networkPolicy: String? = null)

network profile for managed cluster snapshot, these properties are read only.

Link copied to clipboard
data class NodeImageSelectionResponse(val customNodeImageVersions: List<NodeImageVersionResponse>? = null, val type: String)

The node image upgrade to be applied to the target nodes in update run.

Link copied to clipboard
data class NodeImageSelectionStatusResponse(val selectedNodeImageVersions: List<NodeImageVersionResponse>)

The node image upgrade specs for the update run.

Link copied to clipboard
data class NodeImageVersionResponse(val version: String)

The node upgrade image version.

Link copied to clipboard
data class PortRangeResponse(val portEnd: Int? = null, val portStart: Int? = null, val protocol: String? = null)

The port range.

Link copied to clipboard
data class PowerStateResponse(val code: String? = null)

Describes the Power State of the cluster

Link copied to clipboard
data class PrivateEndpointResponse(val id: String? = null)

Private endpoint which a connection belongs to.

Link copied to clipboard
data class PrivateLinkResourceResponse(val groupId: String? = null, val id: String? = null, val name: String? = null, val privateLinkServiceID: String, val requiredMembers: List<String>? = null, val type: String? = null)

A private link resource

data class PrivateLinkServiceConnectionStateResponse(val description: String? = null, val status: String? = null)

The state of a private link service connection.

Link copied to clipboard
data class RelativeMonthlyScheduleResponse(val dayOfWeek: String, val intervalMonths: Int, val weekIndex: String)

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

Link copied to clipboard
data class ResourceQuotaResponse(val cpuLimit: String? = null, val cpuRequest: String? = null, val memoryLimit: String? = null, val memoryRequest: String? = null)

Resource quota for the namespace.

Link copied to clipboard
data class ResourceReferenceResponse(val id: String? = null)

A reference to an Azure resource.

Link copied to clipboard
data class ScheduleResponse(val absoluteMonthly: AbsoluteMonthlyScheduleResponse? = null, val daily: DailyScheduleResponse? = null, val relativeMonthly: RelativeMonthlyScheduleResponse? = null, val weekly: WeeklyScheduleResponse? = null)

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

Link copied to clipboard
data class ServiceMeshProfileResponse(val istio: IstioServiceMeshResponse? = null, val mode: String)

Service mesh profile for a managed cluster.

Link copied to clipboard
data class SysctlConfigResponse(val fsAioMaxNr: Int? = null, val fsFileMax: Int? = null, val fsInotifyMaxUserWatches: Int? = null, val fsNrOpen: Int? = null, val kernelThreadsMax: Int? = null, val netCoreNetdevMaxBacklog: Int? = null, val netCoreOptmemMax: Int? = null, val netCoreRmemDefault: Int? = null, val netCoreRmemMax: Int? = null, val netCoreSomaxconn: Int? = null, val netCoreWmemDefault: Int? = null, val netCoreWmemMax: Int? = null, val netIpv4IpLocalPortRange: String? = null, val netIpv4NeighDefaultGcThresh1: Int? = null, val netIpv4NeighDefaultGcThresh2: Int? = null, val netIpv4NeighDefaultGcThresh3: Int? = null, val netIpv4TcpFinTimeout: Int? = null, val netIpv4TcpKeepaliveProbes: Int? = null, val netIpv4TcpKeepaliveTime: Int? = null, val netIpv4TcpMaxSynBacklog: Int? = null, val netIpv4TcpMaxTwBuckets: Int? = null, val netIpv4TcpTwReuse: Boolean? = null, val netIpv4TcpkeepaliveIntvl: Int? = null, val netNetfilterNfConntrackBuckets: Int? = null, val netNetfilterNfConntrackMax: Int? = null, val vmMaxMapCount: Int? = null, val vmSwappiness: Int? = null, val vmVfsCachePressure: Int? = null)

Sysctl settings for Linux agent nodes.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TimeInWeekResponse(val day: String? = null, val hourSlots: List<Int>? = null)

Time in a week.

Link copied to clipboard
data class TimeSpanResponse(val end: String? = null, val start: String? = null)

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

Link copied to clipboard
data class UpdateGroupResponse(val name: String)

A group to be updated.

Link copied to clipboard
data class UpdateGroupStatusResponse(val members: List<MemberUpdateStatusResponse>, val name: String, val status: UpdateStatusResponse)

The status of a UpdateGroup.

Link copied to clipboard

The status of a UpdateRun.

Link copied to clipboard

Defines the update sequence of the clusters via stages and groups. Stages within a run are executed sequentially one after another. Groups within a stage are executed in parallel. Member clusters within a group are updated sequentially one after another. A valid strategy contains no duplicate groups within or across stages.

Link copied to clipboard
data class UpdateStageResponse(val afterStageWaitInSeconds: Int? = null, val groups: List<UpdateGroupResponse>? = null, val name: String)

Defines a stage which contains the groups to update and the steps to take (e.g., wait for a time period) before starting the next stage.

Link copied to clipboard
data class UpdateStageStatusResponse(val afterStageWaitStatus: WaitStatusResponse, val groups: List<UpdateGroupStatusResponse>, val name: String, val status: UpdateStatusResponse)

The status of a UpdateStage.

Link copied to clipboard
data class UpdateStatusResponse(val completedTime: String, val error: ErrorDetailResponse, val startTime: String, val state: String)

The status for an operation or group of operations.

Link copied to clipboard
data class UpgradeOverrideSettingsResponse(val forceUpgrade: Boolean? = null, val until: String? = null)

Settings for overrides when upgrading a cluster.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String? = null, val objectId: String? = null, val principalId: String? = null, val resourceId: String? = null)

Details about a user assigned identity.

Link copied to clipboard
data class WaitStatusResponse(val status: UpdateStatusResponse, val waitDurationInSeconds: Int)

The status of the wait duration.

Link copied to clipboard
data class WeeklyScheduleResponse(val dayOfWeek: String, val intervalWeeks: Int)

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

Link copied to clipboard
data class WindowsGmsaProfileResponse(val dnsServer: String? = null, val enabled: Boolean? = null, val rootDomainName: String? = null)

Windows gMSA Profile in the managed cluster.