ContainerServiceNetworkProfile interface

Package:

@azure/arm-containerservice

Profile of network configuration.

Properties

advancedNetworking	Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking.
dnsServiceIP	An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.
ipFamilies	The IP families used to specify IP versions available to the cluster. IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.
kubeProxyConfig	Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v<version>.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where <version> is represented by a <major version>-<minor version> string. Kubernetes version 1.23 would be '1-23'.
loadBalancerProfile	Profile of the cluster load balancer.
loadBalancerSku	The load balancer sku for the managed cluster. The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.
natGatewayProfile	Profile of the cluster NAT gateway.
networkDataplane	Network dataplane used in the Kubernetes cluster.
networkMode	The network mode Azure CNI is configured with. This cannot be specified if networkPlugin is anything other than 'azure'.
networkPlugin	Network plugin used for building the Kubernetes network.
networkPluginMode	Network plugin mode used for building the Kubernetes network.
networkPolicy	Network policy used for building the Kubernetes network.
outboundType	The outbound (egress) routing method. This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.
podCidr	A CIDR notation IP range from which to assign pod IPs when kubenet is used.
podCidrs	The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.
podLinkLocalAccess	Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. if not specified, the default is 'IMDS'.
serviceCidr	A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.
serviceCidrs	The CIDR notation IP ranges from which to assign service cluster IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.
staticEgressGatewayProfile	The profile for Static Egress Gateway addon. For more details about Static Egress Gateway, see https://aka.ms/aks/static-egress-gateway.

Property Details

advancedNetworking

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

advancedNetworking?: AdvancedNetworking

Property Value

AdvancedNetworking

dnsServiceIP

An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

dnsServiceIP?: string

Property Value

string

ipFamilies

The IP families used to specify IP versions available to the cluster. IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.

ipFamilies?: string[]

Property Value

string[]

kubeProxyConfig

Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v<version>.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where <version> is represented by a <major version>-<minor version> string. Kubernetes version 1.23 would be '1-23'.

kubeProxyConfig?: ContainerServiceNetworkProfileKubeProxyConfig

Property Value

ContainerServiceNetworkProfileKubeProxyConfig

loadBalancerProfile

Profile of the cluster load balancer.

loadBalancerProfile?: ManagedClusterLoadBalancerProfile

Property Value

ManagedClusterLoadBalancerProfile

loadBalancerSku

The load balancer sku for the managed cluster. The default is 'standard'. See Azure Load Balancer SKUs for more information about the differences between load balancer SKUs.

loadBalancerSku?: string

Property Value

string

natGatewayProfile

Profile of the cluster NAT gateway.

natGatewayProfile?: ManagedClusterNATGatewayProfile

Property Value

ManagedClusterNATGatewayProfile

networkDataplane

Network dataplane used in the Kubernetes cluster.

networkDataplane?: string

Property Value

string

networkMode

The network mode Azure CNI is configured with. This cannot be specified if networkPlugin is anything other than 'azure'.

networkMode?: string

Property Value

string

networkPlugin

Network plugin used for building the Kubernetes network.

networkPlugin?: string

Property Value

string

networkPluginMode

Network plugin mode used for building the Kubernetes network.

networkPluginMode?: string

Property Value

string

networkPolicy

Network policy used for building the Kubernetes network.

networkPolicy?: string

Property Value

string

outboundType

The outbound (egress) routing method. This can only be set at cluster creation time and cannot be changed later. For more information see egress outbound type.

outboundType?: string

Property Value

string

podCidr

A CIDR notation IP range from which to assign pod IPs when kubenet is used.

podCidr?: string

Property Value

string

podCidrs

The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.

podCidrs?: string[]

Property Value

string[]

podLinkLocalAccess

Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. if not specified, the default is 'IMDS'.

podLinkLocalAccess?: string

Property Value

string

serviceCidr

A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

serviceCidr?: string

Property Value

string

serviceCidrs

The CIDR notation IP ranges from which to assign service cluster IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges.

serviceCidrs?: string[]

Property Value

string[]

staticEgressGatewayProfile

The profile for Static Egress Gateway addon. For more details about Static Egress Gateway, see https://aka.ms/aks/static-egress-gateway.

staticEgressGatewayProfile?: ManagedClusterStaticEgressGatewayProfile

Property Value

ManagedClusterStaticEgressGatewayProfile