ContainerServiceNetworkProfile interface

Package:

@azure-rest/arm-containerservice

Profile of network configuration.

Properties

dnsServiceIP	An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.
dockerBridgeCidr	A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.
ipFamilies	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.
loadBalancerProfile	Profile of the cluster load balancer.
loadBalancerSku	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.
networkMode	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	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	One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.
serviceCidr	A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.
serviceCidrs	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.

Property Details

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

dockerBridgeCidr

A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.

dockerBridgeCidr?: string

Property Value

string

ipFamilies

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?: ("IPv4" | "IPv6")[]

Property Value

("IPv4" | "IPv6")[]

loadBalancerProfile

Profile of the cluster load balancer.

loadBalancerProfile?: ManagedClusterLoadBalancerProfile

Property Value

ManagedClusterLoadBalancerProfile

loadBalancerSku

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

loadBalancerSku?: "standard" | "basic"

Property Value

"standard" | "basic"

natGatewayProfile

Profile of the cluster NAT gateway.

natGatewayProfile?: ManagedClusterNATGatewayProfile

Property Value

ManagedClusterNATGatewayProfile

networkMode

This cannot be specified if networkPlugin is anything other than 'azure'.

networkMode?: "transparent" | "bridge"

Property Value

"transparent" | "bridge"

networkPlugin

Network plugin used for building the Kubernetes network.

networkPlugin?: "azure" | "kubenet" | "none"

Property Value

"azure" | "kubenet" | "none"

networkPluginMode

Network plugin mode used for building the Kubernetes network.

networkPluginMode?: "Overlay"

Property Value

"Overlay"

networkPolicy

Network policy used for building the Kubernetes network.

networkPolicy?: "azure" | "calico"

Property Value

"azure" | "calico"

outboundType

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

outboundType?: "loadBalancer" | "userDefinedRouting" | "managedNATGateway" | "userAssignedNATGateway"

Property Value

"loadBalancer" | "userDefinedRouting" | "managedNATGateway" | "userAssignedNATGateway"

podCidr

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

podCidr?: string

Property Value

string

podCidrs

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[]

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

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[]