Package-level declarations

Types

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

Settings for upgrading an agentpool

Link copied to clipboard
data class CloudErrorBodyResponse(val code: String? = null, val details: List<CloudErrorBodyResponse>? = null, val message: String? = null, val target: String? = null)

An error response from the Container service.

Link copied to clipboard
data class CloudErrorResponse(val error: CloudErrorBodyResponse? = null)

An error response from the Container service.

Link copied to clipboard

Profile for Linux VMs in the container service cluster.

Link copied to clipboard
data class ContainerServiceNetworkProfileResponse(val dnsServiceIP: String? = null, val dockerBridgeCidr: String? = null, val loadBalancerProfile: ManagedClusterLoadBalancerProfileResponse? = null, val loadBalancerSku: String? = null, val networkMode: String? = null, val networkPlugin: String? = null, val networkPolicy: String? = null, val outboundType: String? = null, val podCidr: String? = null, val serviceCidr: 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 ExtendedLocationResponse(val name: String? = null, val type: String? = null)

The complex type of the extended location.

Link copied to clipboard
data class GetAgentPoolResult(val availabilityZones: List<String>? = null, val count: Int? = null, val enableAutoScaling: Boolean? = null, val enableEncryptionAtHost: Boolean? = null, val enableFIPS: Boolean? = null, val enableNodePublicIP: Boolean? = null, val gpuInstanceProfile: 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 minCount: Int? = null, val mode: String? = null, val name: String, 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, val provisioningState: String, val proximityPlacementGroupID: String? = null, val scaleSetEvictionPolicy: String? = null, val scaleSetPriority: String? = 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)

Agent Pool.

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

maintenance configuration.

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 azurePortalFQDN: String, val disableLocalAccounts: Boolean? = null, val diskEncryptionSetID: String? = null, val dnsPrefix: String? = null, 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, ManagedClusterPropertiesResponseIdentityProfile>? = null, val kubernetesVersion: String? = null, val linuxProfile: ContainerServiceLinuxProfileResponse? = null, val location: String, val maxAgentPools: Int, val name: String, val networkProfile: ContainerServiceNetworkProfileResponse? = null, val nodeResourceGroup: String? = null, val podIdentityProfile: ManagedClusterPodIdentityProfileResponse? = null, val powerState: PowerStateResponse, val privateFQDN: String, val privateLinkResources: List<PrivateLinkResourceResponse>? = null, val provisioningState: String, val servicePrincipalProfile: ManagedClusterServicePrincipalProfileResponse? = null, val sku: ManagedClusterSKUResponse? = null, val tags: Map<String, String>? = null, val type: String, val windowsProfile: ManagedClusterWindowsProfileResponse? = null)

Managed cluster.

Link copied to clipboard
data class GetManagedClusterSnapshotResult(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 GetOpenShiftManagedClusterResult(val agentPoolProfiles: List<OpenShiftManagedClusterAgentPoolProfileResponse>? = null, val authProfile: OpenShiftManagedClusterAuthProfileResponse? = null, val clusterVersion: String, val fqdn: String, val id: String, val location: String, val masterPoolProfile: OpenShiftManagedClusterMasterPoolProfileResponse? = null, val name: String, val networkProfile: NetworkProfileResponse? = null, val openShiftVersion: String, val plan: PurchasePlanResponse? = null, val provisioningState: String, val publicHostname: String, val routerProfiles: List<OpenShiftRouterProfileResponse>? = null, val tags: Map<String, String>? = null, val type: String)

OpenShift Managed cluster.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(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 creationData: CreationDataResponse? = null, val id: String, val location: String, val name: String, val snapshotType: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A node pool snapshot resource.

Link copied to clipboard
data class GetTrustedAccessRoleBindingResult(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 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)

Kubelet configurations of agent nodes.

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

OS configurations of Linux agent nodes.

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 of credential result response.

The list of credential result response.

Link copied to clipboard

The list of credential result response.

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)

AADProfile specifies attributes for Azure Active Directory integration.

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 count: Int? = null, val enableAutoScaling: Boolean? = null, val enableEncryptionAtHost: Boolean? = null, val enableFIPS: Boolean? = null, val enableNodePublicIP: Boolean? = null, val gpuInstanceProfile: String? = null, val kubeletConfig: KubeletConfigResponse? = null, val kubeletDiskType: String? = null, val linuxOSConfig: LinuxOSConfigResponse? = null, val maxCount: Int? = null, val maxPods: Int? = null, val minCount: Int? = null, val mode: String? = null, val name: String, 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, val provisioningState: String, val proximityPlacementGroupID: String? = null, val scaleSetEvictionPolicy: String? = null, val scaleSetPriority: String? = 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)

Profile for the container service agent pool.

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

Access profile for managed cluster API server.

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

Auto upgrade profile for a managed 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)

Configurations for provisioning the cluster with HTTP proxy servers.

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

Identity for the managed cluster.

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

Profile of the managed cluster load balancer.

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.

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)
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)
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 expander: String? = 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 ManagedClusterPropertiesResponseIdentityProfile(val clientId: String? = null, val objectId: String? = null, val resourceId: String? = null)
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.

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

Profile for Windows VMs in the container service cluster.

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

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

Link copied to clipboard
data class NetworkProfileResponse(val peerVnetId: String? = null, val vnetCidr: String? = null, val vnetId: String? = null)

Represents the OpenShift networking configuration

data class OpenShiftManagedClusterAADIdentityProviderResponse(val clientId: String? = null, val customerAdminGroupId: String? = null, val kind: String, val secret: String? = null, val tenantId: String? = null)

Defines the Identity provider for MS AAD.

data class OpenShiftManagedClusterAgentPoolProfileResponse(val count: Int, val name: String, val osType: String? = null, val role: String? = null, val subnetCidr: String? = null, val vmSize: String)

Defines the configuration of the OpenShift cluster VMs.

Defines all possible authentication profiles for the OpenShift cluster.

Defines the configuration of the identity providers to be used in the OpenShift cluster.

data class OpenShiftManagedClusterMasterPoolProfileResponse(val count: Int, val name: String? = null, val osType: String? = null, val subnetCidr: String? = null, val vmSize: String)

OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs.

Link copied to clipboard
data class OpenShiftRouterProfileResponse(val fqdn: String, val name: String? = null, val publicSubdomain: String)

Represents an OpenShift router

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 PurchasePlanResponse(val name: String? = null, val product: String? = null, val promotionCode: String? = null, val publisher: String? = null)

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

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

A reference to an Azure resource.

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)

The time span with start and end properties.

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