network.azure.com/v1api20240301


APIVersion

Value Description
“2024-03-01”

BastionHost

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/bastionHost.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/bastionHosts/{bastionHostName}

Used by: BastionHostList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec BastionHost_Spec
Optional
status BastionHost_STATUS
Optional

BastionHost_Spec

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
disableCopyPaste Enable/Disable Copy/Paste feature of the Bastion Host resource. bool
Optional
dnsName FQDN for the endpoint on which bastion host is accessible. string
Optional
enableFileCopy Enable/Disable File Copy feature of the Bastion Host resource. bool
Optional
enableIpConnect Enable/Disable IP Connect feature of the Bastion Host resource. bool
Optional
enableKerberos Enable/Disable Kerberos feature of the Bastion Host resource. bool
Optional
enableSessionRecording Enable/Disable Session Recording feature of the Bastion Host resource. bool
Optional
enableShareableLink Enable/Disable Shareable Link of the Bastion Host resource. bool
Optional
enableTunneling Enable/Disable Tunneling feature of the Bastion Host resource. bool
Optional
ipConfigurations IP configuration of the Bastion Host resource. BastionHostIPConfiguration[]
Optional
location Resource location. string
Optional
networkAcls BastionHostPropertiesFormat_NetworkAcls
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure BastionHostOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
scaleUnits The scale units for the Bastion Host resource. int
Optional
sku The sku of this Bastion Host. Sku
Optional
tags Resource tags. map[string]string
Optional
virtualNetwork Reference to an existing virtual network required for Developer Bastion Host only. SubResource
Optional
zones A list of availability zones denoting where the resource needs to come from. string[]
Optional

BastionHost_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
disableCopyPaste Enable/Disable Copy/Paste feature of the Bastion Host resource. bool
Optional
dnsName FQDN for the endpoint on which bastion host is accessible. string
Optional
enableFileCopy Enable/Disable File Copy feature of the Bastion Host resource. bool
Optional
enableIpConnect Enable/Disable IP Connect feature of the Bastion Host resource. bool
Optional
enableKerberos Enable/Disable Kerberos feature of the Bastion Host resource. bool
Optional
enableSessionRecording Enable/Disable Session Recording feature of the Bastion Host resource. bool
Optional
enableShareableLink Enable/Disable Shareable Link of the Bastion Host resource. bool
Optional
enableTunneling Enable/Disable Tunneling feature of the Bastion Host resource. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
ipConfigurations IP configuration of the Bastion Host resource. BastionHostIPConfiguration_STATUS[]
Optional
location Resource location. string
Optional
name Resource name. string
Optional
networkAcls BastionHostPropertiesFormat_NetworkAcls_STATUS
Optional
provisioningState The provisioning state of the bastion host resource. ProvisioningState_STATUS
Optional
scaleUnits The scale units for the Bastion Host resource. int
Optional
sku The sku of this Bastion Host. Sku_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
virtualNetwork Reference to an existing virtual network required for Developer Bastion Host only. SubResource_STATUS
Optional
zones A list of availability zones denoting where the resource needs to come from. string[]
Optional

BastionHostList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/bastionHost.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/bastionHosts/{bastionHostName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items BastionHost[]
Optional

LoadBalancer

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/loadBalancer.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/loadBalancers/{loadBalancerName}

Used by: LoadBalancerList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec LoadBalancer_Spec
Optional
status LoadBalancer_STATUS
Optional

LoadBalancer_Spec

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
backendAddressPools Collection of backend address pools used by a load balancer. BackendAddressPool_LoadBalancer_SubResourceEmbedded[]
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation
Optional
frontendIPConfigurations Object representing the frontend IPs to be used for the load balancer. FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded[]
Optional
inboundNatPools Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound NAT rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules. InboundNatPool[]
Optional
inboundNatRules Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules. InboundNatRule_LoadBalancer_SubResourceEmbedded[]
Optional
loadBalancingRules Object collection representing the load balancing rules Gets the provisioning. LoadBalancingRule[]
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure LoadBalancerOperatorSpec
Optional
outboundRules The outbound rules. OutboundRule[]
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
probes Collection of probe objects used in the load balancer. Probe[]
Optional
sku The load balancer SKU. LoadBalancerSku
Optional
tags Resource tags. map[string]string
Optional

LoadBalancer_STATUS

Property Description Type
backendAddressPools Collection of backend address pools used by a load balancer. BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded[]
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation_STATUS
Optional
frontendIPConfigurations Object representing the frontend IPs to be used for the load balancer. FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded[]
Optional
id Resource ID. string
Optional
inboundNatPools Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound NAT rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules. InboundNatPool_STATUS[]
Optional
inboundNatRules Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules. InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded[]
Optional
loadBalancingRules Object collection representing the load balancing rules Gets the provisioning. LoadBalancingRule_STATUS[]
Optional
location Resource location. string
Optional
name Resource name. string
Optional
outboundRules The outbound rules. OutboundRule_STATUS[]
Optional
probes Collection of probe objects used in the load balancer. Probe_STATUS[]
Optional
provisioningState The provisioning state of the load balancer resource. ProvisioningState_STATUS
Optional
resourceGuid The resource GUID property of the load balancer resource. string
Optional
sku The load balancer SKU. LoadBalancerSku_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional

LoadBalancerList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/loadBalancer.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/loadBalancers/{loadBalancerName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items LoadBalancer[]
Optional

LoadBalancersInboundNatRule

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/loadBalancer.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}

Used by: LoadBalancersInboundNatRuleList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec LoadBalancersInboundNatRule_Spec
Optional
status LoadBalancersInboundNatRule_STATUS
Optional

LoadBalancersInboundNatRule_Spec

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
backendAddressPool A reference to backendAddressPool resource. SubResource
Optional
backendPort The port used for the internal endpoint. Acceptable values range from 1 to 65535. int
Optional
enableFloatingIP Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint. bool
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
frontendIPConfiguration A reference to frontend IP addresses. SubResource
Optional
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeEnd The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeStart The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
idleTimeoutInMinutes The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. int
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure LoadBalancersInboundNatRuleOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/LoadBalancer resource genruntime.KnownResourceReference
Required
protocol The reference to the transport protocol used by the load balancing rule. TransportProtocol
Optional

LoadBalancersInboundNatRule_STATUS

Property Description Type
backendAddressPool A reference to backendAddressPool resource. SubResource_STATUS
Optional
backendIPConfiguration A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP. NetworkInterfaceIPConfiguration_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded
Optional
backendPort The port used for the internal endpoint. Acceptable values range from 1 to 65535. int
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
enableFloatingIP Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint. bool
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
frontendIPConfiguration A reference to frontend IP addresses. SubResource_STATUS
Optional
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeEnd The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeStart The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
id Resource ID. string
Optional
idleTimeoutInMinutes The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. int
Optional
name The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource. string
Optional
protocol The reference to the transport protocol used by the load balancing rule. TransportProtocol_STATUS
Optional
provisioningState The provisioning state of the inbound NAT rule resource. ProvisioningState_STATUS
Optional
type Type of the resource. string
Optional

LoadBalancersInboundNatRuleList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/loadBalancer.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items LoadBalancersInboundNatRule[]
Optional

NatGateway

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/natGateway.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/natGateways/{natGatewayName}

Used by: NatGatewayList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec NatGateway_Spec
Optional
status NatGateway_STATUS
Optional

NatGateway_Spec

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
idleTimeoutInMinutes The idle timeout of the nat gateway. int
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure NatGatewayOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
publicIpAddresses An array of public ip addresses associated with the nat gateway resource. SubResource[]
Optional
publicIpPrefixes An array of public ip prefixes associated with the nat gateway resource. SubResource[]
Optional
sku The nat gateway SKU. NatGatewaySku
Optional
tags Resource tags. map[string]string
Optional
zones A list of availability zones denoting the zone in which Nat Gateway should be deployed. string[]
Optional

NatGateway_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
idleTimeoutInMinutes The idle timeout of the nat gateway. int
Optional
location Resource location. string
Optional
name Resource name. string
Optional
provisioningState The provisioning state of the NAT gateway resource. ProvisioningState_STATUS
Optional
publicIpAddresses An array of public ip addresses associated with the nat gateway resource. SubResource_STATUS[]
Optional
publicIpPrefixes An array of public ip prefixes associated with the nat gateway resource. SubResource_STATUS[]
Optional
resourceGuid The resource GUID property of the NAT gateway resource. string
Optional
sku The nat gateway SKU. NatGatewaySku_STATUS
Optional
subnets An array of references to the subnets using this nat gateway resource. SubResource_STATUS[]
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
zones A list of availability zones denoting the zone in which Nat Gateway should be deployed. string[]
Optional

NatGatewayList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/natGateway.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/natGateways/{natGatewayName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items NatGateway[]
Optional

NetworkInterface

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/networkInterface.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/networkInterfaces/{networkInterfaceName}

Used by: NetworkInterfaceList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec NetworkInterface_Spec
Optional
status NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded
Optional

NetworkInterface_Spec

Property Description Type
auxiliaryMode Auxiliary mode of Network Interface resource. NetworkInterfacePropertiesFormat_AuxiliaryMode
Optional
auxiliarySku Auxiliary sku of Network Interface resource. NetworkInterfacePropertiesFormat_AuxiliarySku
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
disableTcpStateTracking Indicates whether to disable tcp state tracking. bool
Optional
dnsSettings The DNS settings in network interface. NetworkInterfaceDnsSettings
Optional
enableAcceleratedNetworking If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. bool
Optional
enableIPForwarding Indicates whether IP forwarding is enabled on this network interface. bool
Optional
extendedLocation The extended location of the network interface. ExtendedLocation
Optional
ipConfigurations A list of IPConfigurations of the network interface. NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded[]
Optional
location Resource location. string
Optional
networkSecurityGroup The reference to the NetworkSecurityGroup resource. NetworkSecurityGroupSpec_NetworkInterface_SubResourceEmbedded
Optional
nicType Type of Network Interface resource. NetworkInterfacePropertiesFormat_NicType
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure NetworkInterfaceOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
privateLinkService Privatelinkservice of the network interface resource. PrivateLinkServiceSpec
Optional
tags Resource tags. map[string]string
Optional
workloadType WorkloadType of the NetworkInterface for BareMetal resources string
Optional

NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded

Property Description Type
auxiliaryMode Auxiliary mode of Network Interface resource. NetworkInterfacePropertiesFormat_AuxiliaryMode_STATUS
Optional
auxiliarySku Auxiliary sku of Network Interface resource. NetworkInterfacePropertiesFormat_AuxiliarySku_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
disableTcpStateTracking Indicates whether to disable tcp state tracking. bool
Optional
dnsSettings The DNS settings in network interface. NetworkInterfaceDnsSettings_STATUS
Optional
dscpConfiguration A reference to the dscp configuration to which the network interface is linked. SubResource_STATUS
Optional
enableAcceleratedNetworking If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. bool
Optional
enableIPForwarding Indicates whether IP forwarding is enabled on this network interface. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the network interface. ExtendedLocation_STATUS
Optional
hostedWorkloads A list of references to linked BareMetal resources. string[]
Optional
id Resource ID. string
Optional
ipConfigurations A list of IPConfigurations of the network interface. NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded[]
Optional
location Resource location. string
Optional
macAddress The MAC address of the network interface. string
Optional
migrationPhase Migration phase of Network Interface resource. NetworkInterfacePropertiesFormat_MigrationPhase_STATUS
Optional
name Resource name. string
Optional
networkSecurityGroup The reference to the NetworkSecurityGroup resource. NetworkSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded
Optional
nicType Type of Network Interface resource. NetworkInterfacePropertiesFormat_NicType_STATUS
Optional
primary Whether this is a primary network interface on a virtual machine. bool
Optional
privateEndpoint A reference to the private endpoint to which the network interface is linked. PrivateEndpoint_STATUS_NetworkInterface_SubResourceEmbedded
Optional
privateLinkService Privatelinkservice of the network interface resource. PrivateLinkService_STATUS_NetworkInterface_SubResourceEmbedded
Optional
provisioningState The provisioning state of the network interface resource. ProvisioningState_STATUS
Optional
resourceGuid The resource GUID property of the network interface resource. string
Optional
tags Resource tags. map[string]string
Optional
tapConfigurations A list of TapConfigurations of the network interface. NetworkInterfaceTapConfiguration_STATUS_NetworkInterface_SubResourceEmbedded[]
Optional
type Resource type. string
Optional
virtualMachine The reference to a virtual machine. SubResource_STATUS
Optional
vnetEncryptionSupported Whether the virtual machine this nic is attached to supports encryption. bool
Optional
workloadType WorkloadType of the NetworkInterface for BareMetal resources string
Optional

NetworkInterfaceList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/networkInterface.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/networkInterfaces/{networkInterfaceName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items NetworkInterface[]
Optional

NetworkSecurityGroup

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/networkSecurityGroup.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}

Used by: NetworkSecurityGroupList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec NetworkSecurityGroup_Spec
Optional
status NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded
Optional

NetworkSecurityGroup_Spec

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
flushConnection When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. bool
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure NetworkSecurityGroupOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
tags Resource tags. map[string]string
Optional

NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
defaultSecurityRules The default security rules of network security group. SecurityRule_STATUS[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
flushConnection When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. bool
Optional
id Resource ID. string
Optional
location Resource location. string
Optional
name Resource name. string
Optional
networkInterfaces A collection of references to network interfaces. NetworkInterface_STATUS_NetworkSecurityGroup_SubResourceEmbedded[]
Optional
provisioningState The provisioning state of the network security group resource. ProvisioningState_STATUS
Optional
resourceGuid The resource GUID property of the network security group resource. string
Optional
subnets A collection of references to subnets. Subnet_STATUS_NetworkSecurityGroup_SubResourceEmbedded[]
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional

NetworkSecurityGroupList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/networkSecurityGroup.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items NetworkSecurityGroup[]
Optional

NetworkSecurityGroupsSecurityRule

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/networkSecurityGroup.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}

Used by: NetworkSecurityGroupsSecurityRuleList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec NetworkSecurityGroupsSecurityRule_Spec
Optional
status NetworkSecurityGroupsSecurityRule_STATUS
Optional

NetworkSecurityGroupsSecurityRule_Spec

Property Description Type
access The network traffic is allowed or denied. SecurityRuleAccess
Required
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
description A description for this rule. Restricted to 140 chars. string
Optional
destinationAddressPrefix The destination address prefix. CIDR or destination IP range. Asterisk ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. string
Optional
destinationAddressPrefixes The destination address prefixes. CIDR or destination IP ranges. string[]
Optional
destinationApplicationSecurityGroups The application security group specified as destination. ApplicationSecurityGroupSpec_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded[]
Optional
destinationPortRange The destination port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. string
Optional
destinationPortRanges The destination port ranges. string[]
Optional
direction The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. SecurityRuleDirection
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure NetworkSecurityGroupsSecurityRuleOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/NetworkSecurityGroup resource genruntime.KnownResourceReference
Required
priority The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. int
Required
protocol Network protocol this rule applies to. SecurityRulePropertiesFormat_Protocol
Required
sourceAddressPrefix The CIDR or source IP range. Asterisk ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. string
Optional
sourceAddressPrefixes The CIDR or source IP ranges. string[]
Optional
sourceApplicationSecurityGroups The application security group specified as source. ApplicationSecurityGroupSpec_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded[]
Optional
sourcePortRange The source port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. string
Optional
sourcePortRanges The source port ranges. string[]
Optional

NetworkSecurityGroupsSecurityRule_STATUS

Property Description Type
access The network traffic is allowed or denied. SecurityRuleAccess_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
description A description for this rule. Restricted to 140 chars. string
Optional
destinationAddressPrefix The destination address prefix. CIDR or destination IP range. Asterisk ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. string
Optional
destinationAddressPrefixes The destination address prefixes. CIDR or destination IP ranges. string[]
Optional
destinationApplicationSecurityGroups The application security group specified as destination. ApplicationSecurityGroup_STATUS_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded[]
Optional
destinationPortRange The destination port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. string
Optional
destinationPortRanges The destination port ranges. string[]
Optional
direction The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. SecurityRuleDirection_STATUS
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
priority The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. int
Optional
protocol Network protocol this rule applies to. SecurityRulePropertiesFormat_Protocol_STATUS
Optional
provisioningState The provisioning state of the security rule resource. ProvisioningState_STATUS
Optional
sourceAddressPrefix The CIDR or source IP range. Asterisk ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. string
Optional
sourceAddressPrefixes The CIDR or source IP ranges. string[]
Optional
sourceApplicationSecurityGroups The application security group specified as source. ApplicationSecurityGroup_STATUS_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded[]
Optional
sourcePortRange The source port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. string
Optional
sourcePortRanges The source port ranges. string[]
Optional
type The type of the resource. string
Optional

NetworkSecurityGroupsSecurityRuleList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/networkSecurityGroup.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items NetworkSecurityGroupsSecurityRule[]
Optional

PrivateEndpoint

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/privateEndpoint.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/privateEndpoints/{privateEndpointName}

Used by: PrivateEndpointList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec PrivateEndpoint_Spec
Optional
status PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded
Optional

PrivateEndpoint_Spec

Property Description Type
applicationSecurityGroups Application security groups in which the private endpoint IP configuration is included. ApplicationSecurityGroupSpec_PrivateEndpoint_SubResourceEmbedded[]
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
customNetworkInterfaceName The custom name of the network interface attached to the private endpoint. string
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation
Optional
ipConfigurations A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints. PrivateEndpointIPConfiguration[]
Optional
location Resource location. string
Optional
manualPrivateLinkServiceConnections A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. PrivateLinkServiceConnection[]
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure PrivateEndpointOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
privateLinkServiceConnections A grouping of information about the connection to the remote resource. PrivateLinkServiceConnection[]
Optional
subnet The ID of the subnet from which the private IP will be allocated. Subnet_PrivateEndpoint_SubResourceEmbedded
Optional
tags Resource tags. map[string]string
Optional

PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded

Property Description Type
applicationSecurityGroups Application security groups in which the private endpoint IP configuration is included. ApplicationSecurityGroup_STATUS_PrivateEndpoint_SubResourceEmbedded[]
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
customDnsConfigs An array of custom dns configurations. CustomDnsConfigPropertiesFormat_STATUS[]
Optional
customNetworkInterfaceName The custom name of the network interface attached to the private endpoint. string
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation_STATUS
Optional
id Resource ID. string
Optional
ipConfigurations A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints. PrivateEndpointIPConfiguration_STATUS[]
Optional
location Resource location. string
Optional
manualPrivateLinkServiceConnections A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. PrivateLinkServiceConnection_STATUS[]
Optional
name Resource name. string
Optional
networkInterfaces An array of references to the network interfaces created for this private endpoint. NetworkInterface_STATUS_PrivateEndpoint_SubResourceEmbedded[]
Optional
privateLinkServiceConnections A grouping of information about the connection to the remote resource. PrivateLinkServiceConnection_STATUS[]
Optional
provisioningState The provisioning state of the private endpoint resource. ProvisioningState_STATUS
Optional
subnet The ID of the subnet from which the private IP will be allocated. Subnet_STATUS_PrivateEndpoint_SubResourceEmbedded
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional

PrivateEndpointList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/privateEndpoint.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/privateEndpoints/{privateEndpointName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items PrivateEndpoint[]
Optional

PrivateEndpointsPrivateDnsZoneGroup

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/privateEndpoint.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}

Used by: PrivateEndpointsPrivateDnsZoneGroupList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec PrivateEndpointsPrivateDnsZoneGroup_Spec
Optional
status PrivateEndpointsPrivateDnsZoneGroup_STATUS
Optional

PrivateEndpointsPrivateDnsZoneGroup_Spec

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure PrivateEndpointsPrivateDnsZoneGroupOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/PrivateEndpoint resource genruntime.KnownResourceReference
Required
privateDnsZoneConfigs A collection of private dns zone configurations of the private dns zone group. PrivateDnsZoneConfig[]
Optional

PrivateEndpointsPrivateDnsZoneGroup_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
privateDnsZoneConfigs A collection of private dns zone configurations of the private dns zone group. PrivateDnsZoneConfig_STATUS[]
Optional
provisioningState The provisioning state of the private dns zone group resource. ProvisioningState_STATUS
Optional

PrivateEndpointsPrivateDnsZoneGroupList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/privateEndpoint.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items PrivateEndpointsPrivateDnsZoneGroup[]
Optional

PrivateLinkService

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/privateLinkService.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/privateLinkServices/{serviceName}

Used by: PrivateLinkServiceList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec PrivateLinkService_Spec
Optional
status PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded
Optional

PrivateLinkService_Spec

Property Description Type
autoApproval The auto-approval list of the private link service. ResourceSet
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
destinationIPAddress The destination IP address of the private link service. string
Optional
enableProxyProtocol Whether the private link service is enabled for proxy protocol or not. bool
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation
Optional
fqdns The list of Fqdn. string[]
Optional
ipConfigurations An array of private link service IP configurations. PrivateLinkServiceIpConfiguration[]
Optional
loadBalancerFrontendIpConfigurations An array of references to the load balancer IP configurations. FrontendIPConfiguration_PrivateLinkService_SubResourceEmbedded[]
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure PrivateLinkServiceOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
tags Resource tags. map[string]string
Optional
visibility The visibility list of the private link service. ResourceSet
Optional

PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded

Property Description Type
alias The alias of the private link service. string
Optional
autoApproval The auto-approval list of the private link service. ResourceSet_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
destinationIPAddress The destination IP address of the private link service. string
Optional
enableProxyProtocol Whether the private link service is enabled for proxy protocol or not. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation_STATUS
Optional
fqdns The list of Fqdn. string[]
Optional
id Resource ID. string
Optional
ipConfigurations An array of private link service IP configurations. PrivateLinkServiceIpConfiguration_STATUS[]
Optional
loadBalancerFrontendIpConfigurations An array of references to the load balancer IP configurations. FrontendIPConfiguration_STATUS_PrivateLinkService_SubResourceEmbedded[]
Optional
location Resource location. string
Optional
name Resource name. string
Optional
networkInterfaces An array of references to the network interfaces created for this private link service. NetworkInterface_STATUS_PrivateLinkService_SubResourceEmbedded[]
Optional
privateEndpointConnections An array of list about connections to the private endpoint. PrivateEndpointConnection_STATUS[]
Optional
provisioningState The provisioning state of the private link service resource. ProvisioningState_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
visibility The visibility list of the private link service. ResourceSet_STATUS
Optional

PrivateLinkServiceList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/privateLinkService.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/privateLinkServices/{serviceName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items PrivateLinkService[]
Optional

PublicIPAddress

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/publicIpAddress.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/publicIPAddresses/{publicIpAddressName}

Used by: PublicIPAddressList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec PublicIPAddress_Spec
Optional
status PublicIPAddress_STATUS
Optional

PublicIPAddress_Spec

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
ddosSettings The DDoS protection custom policy associated with the public IP address. DdosSettings
Optional
deleteOption Specify what happens to the public IP address when the VM using it is deleted PublicIPAddressPropertiesFormat_DeleteOption
Optional
dnsSettings The FQDN of the DNS record associated with the public IP address. PublicIPAddressDnsSettings
Optional
extendedLocation The extended location of the public ip address. ExtendedLocation
Optional
idleTimeoutInMinutes The idle timeout of the public IP address. int
Optional
ipAddress The IP address associated with the public IP address resource. string
Optional
ipTags The list of tags associated with the public IP address. IpTag[]
Optional
linkedPublicIPAddress The linked public IP address of the public IP address resource. PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded
Optional
location Resource location. string
Optional
natGateway The NatGateway for the Public IP address. NatGatewaySpec_PublicIPAddress_SubResourceEmbedded
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure PublicIPAddressOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
publicIPAddressVersion The public IP address version. IPVersion
Optional
publicIPAllocationMethod The public IP address allocation method. IPAllocationMethod
Optional
publicIPPrefix The Public IP Prefix this Public IP Address should be allocated from. SubResource
Optional
servicePublicIPAddress The service public IP address of the public IP address resource. PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded
Optional
sku The public IP address SKU. PublicIPAddressSku
Optional
tags Resource tags. map[string]string
Optional
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]
Optional

PublicIPAddress_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
ddosSettings The DDoS protection custom policy associated with the public IP address. DdosSettings_STATUS
Optional
deleteOption Specify what happens to the public IP address when the VM using it is deleted PublicIPAddressPropertiesFormat_DeleteOption_STATUS
Optional
dnsSettings The FQDN of the DNS record associated with the public IP address. PublicIPAddressDnsSettings_STATUS
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the public ip address. ExtendedLocation_STATUS
Optional
id Resource ID. string
Optional
idleTimeoutInMinutes The idle timeout of the public IP address. int
Optional
ipAddress The IP address associated with the public IP address resource. string
Optional
ipConfiguration The IP configuration associated with the public IP address. IPConfiguration_STATUS_PublicIPAddress_SubResourceEmbedded
Optional
ipTags The list of tags associated with the public IP address. IpTag_STATUS[]
Optional
location Resource location. string
Optional
migrationPhase Migration phase of Public IP Address. PublicIPAddressPropertiesFormat_MigrationPhase_STATUS
Optional
name Resource name. string
Optional
natGateway The NatGateway for the Public IP address. NatGateway_STATUS_PublicIPAddress_SubResourceEmbedded
Optional
provisioningState The provisioning state of the public IP address resource. ProvisioningState_STATUS
Optional
publicIPAddressVersion The public IP address version. IPVersion_STATUS
Optional
publicIPAllocationMethod The public IP address allocation method. IPAllocationMethod_STATUS
Optional
publicIPPrefix The Public IP Prefix this Public IP Address should be allocated from. SubResource_STATUS
Optional
resourceGuid The resource GUID property of the public IP address resource. string
Optional
sku The public IP address SKU. PublicIPAddressSku_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]
Optional

PublicIPAddressList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/publicIpAddress.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/publicIPAddresses/{publicIpAddressName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items PublicIPAddress[]
Optional

PublicIPPrefix

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/publicIpPrefix.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}

Used by: PublicIPPrefixList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec PublicIPPrefix_Spec
Optional
status PublicIPPrefix_STATUS
Optional

PublicIPPrefix_Spec

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
customIPPrefix The customIpPrefix that this prefix is associated with. SubResource
Optional
extendedLocation The extended location of the public ip address. ExtendedLocation
Optional
ipTags The list of tags associated with the public IP prefix. IpTag[]
Optional
location Resource location. string
Optional
natGateway NatGateway of Public IP Prefix. NatGatewaySpec_PublicIPPrefix_SubResourceEmbedded
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure PublicIPPrefixOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
prefixLength The Length of the Public IP Prefix. int
Optional
publicIPAddressVersion The public IP address version. IPVersion
Optional
sku The public IP prefix SKU. PublicIPPrefixSku
Optional
tags Resource tags. map[string]string
Optional
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]
Optional

PublicIPPrefix_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
customIPPrefix The customIpPrefix that this prefix is associated with. SubResource_STATUS
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the public ip address. ExtendedLocation_STATUS
Optional
id Resource ID. string
Optional
ipPrefix The allocated Prefix. string
Optional
ipTags The list of tags associated with the public IP prefix. IpTag_STATUS[]
Optional
loadBalancerFrontendIpConfiguration The reference to load balancer frontend IP configuration associated with the public IP prefix. SubResource_STATUS
Optional
location Resource location. string
Optional
name Resource name. string
Optional
natGateway NatGateway of Public IP Prefix. NatGateway_STATUS_PublicIPPrefix_SubResourceEmbedded
Optional
prefixLength The Length of the Public IP Prefix. int
Optional
provisioningState The provisioning state of the public IP prefix resource. ProvisioningState_STATUS
Optional
publicIPAddresses The list of all referenced PublicIPAddresses. ReferencedPublicIpAddress_STATUS[]
Optional
publicIPAddressVersion The public IP address version. IPVersion_STATUS
Optional
resourceGuid The resource GUID property of the public IP prefix resource. string
Optional
sku The public IP prefix SKU. PublicIPPrefixSku_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]
Optional

PublicIPPrefixList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/publicIpPrefix.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items PublicIPPrefix[]
Optional

RouteTable

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/routeTable.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/routeTables/{routeTableName}

Used by: RouteTableList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec RouteTable_Spec
Optional
status RouteTable_STATUS
Optional

RouteTable_Spec

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
disableBgpRoutePropagation Whether to disable the routes learned by BGP on that route table. True means disable. bool
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure RouteTableOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
tags Resource tags. map[string]string
Optional

RouteTable_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
disableBgpRoutePropagation Whether to disable the routes learned by BGP on that route table. True means disable. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
location Resource location. string
Optional
name Resource name. string
Optional
provisioningState The provisioning state of the route table resource. ProvisioningState_STATUS
Optional
resourceGuid The resource GUID property of the route table. string
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional

RouteTableList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/routeTable.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/routeTables/{routeTableName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items RouteTable[]
Optional

RouteTablesRoute

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/routeTable.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}

Used by: RouteTablesRouteList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec RouteTablesRoute_Spec
Optional
status RouteTablesRoute_STATUS
Optional

RouteTablesRoute_Spec

Property Description Type
addressPrefix The destination CIDR to which the route applies. string
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
nextHopIpAddress The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. string
Optional
nextHopType The type of Azure hop the packet should be sent to. RouteNextHopType
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure RouteTablesRouteOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/RouteTable resource genruntime.KnownResourceReference
Required

RouteTablesRoute_STATUS

Property Description Type
addressPrefix The destination CIDR to which the route applies. string
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
hasBgpOverride A value indicating whether this route overrides overlapping BGP routes regardless of LPM. bool
Optional
id Resource ID. string
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
nextHopIpAddress The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. string
Optional
nextHopType The type of Azure hop the packet should be sent to. RouteNextHopType_STATUS
Optional
provisioningState The provisioning state of the route resource. ProvisioningState_STATUS
Optional
type The type of the resource. string
Optional

RouteTablesRouteList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/routeTable.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items RouteTablesRoute[]
Optional

VirtualNetwork

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/virtualNetworks/{virtualNetworkName}

Used by: VirtualNetworkList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec VirtualNetwork_Spec
Optional
status VirtualNetwork_STATUS
Optional

VirtualNetwork_Spec

Property Description Type
addressSpace The AddressSpace that contains an array of IP address ranges that can be used by subnets. AddressSpace
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
bgpCommunities Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. VirtualNetworkBgpCommunities
Optional
ddosProtectionPlan The DDoS protection plan associated with the virtual network. SubResource
Optional
dhcpOptions The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. DhcpOptions
Optional
enableDdosProtection Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource. bool
Optional
enableVmProtection Indicates if VM protection is enabled for all the subnets in the virtual network. bool
Optional
encryption Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. VirtualNetworkEncryption
Optional
extendedLocation The extended location of the virtual network. ExtendedLocation
Optional
flowTimeoutInMinutes The FlowTimeout value (in minutes) for the Virtual Network int
Optional
ipAllocations Array of IpAllocation which reference this VNET. SubResource[]
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure VirtualNetworkOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
privateEndpointVNetPolicies Private Endpoint VNet Policies. PrivateEndpointVNetPolicies
Optional
tags Resource tags. map[string]string
Optional

VirtualNetwork_STATUS

Property Description Type
addressSpace The AddressSpace that contains an array of IP address ranges that can be used by subnets. AddressSpace_STATUS
Optional
bgpCommunities Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. VirtualNetworkBgpCommunities_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
ddosProtectionPlan The DDoS protection plan associated with the virtual network. SubResource_STATUS
Optional
dhcpOptions The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. DhcpOptions_STATUS
Optional
enableDdosProtection Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource. bool
Optional
enableVmProtection Indicates if VM protection is enabled for all the subnets in the virtual network. bool
Optional
encryption Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. VirtualNetworkEncryption_STATUS
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the virtual network. ExtendedLocation_STATUS
Optional
flowLogs A collection of references to flow log resources. FlowLog_STATUS_SubResourceEmbedded[]
Optional
flowTimeoutInMinutes The FlowTimeout value (in minutes) for the Virtual Network int
Optional
id Resource ID. string
Optional
ipAllocations Array of IpAllocation which reference this VNET. SubResource_STATUS[]
Optional
location Resource location. string
Optional
name Resource name. string
Optional
privateEndpointVNetPolicies Private Endpoint VNet Policies. PrivateEndpointVNetPolicies_STATUS
Optional
provisioningState The provisioning state of the virtual network resource. ProvisioningState_STATUS
Optional
resourceGuid The resourceGuid property of the Virtual Network resource. string
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional

VirtualNetworkGateway

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetworkGateway.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}

Used by: VirtualNetworkGatewayList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec VirtualNetworkGateway_Spec
Optional
status VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded
Optional

VirtualNetworkGateway_Spec

Property Description Type
activeActive ActiveActive flag. bool
Optional
adminState Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet VirtualNetworkGatewayPropertiesFormat_AdminState
Optional
allowRemoteVnetTraffic Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN. bool
Optional
allowVirtualWanTraffic Configures this gateway to accept traffic from remote Virtual WAN networks. bool
Optional
autoScaleConfiguration Autoscale configuration for virutal network gateway VirtualNetworkGatewayAutoScaleConfiguration
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
bgpSettings Virtual network gateway’s BGP speaker settings. BgpSettings
Optional
customRoutes The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient. AddressSpace
Optional
disableIPSecReplayProtection disableIPSecReplayProtection flag. bool
Optional
enableBgp Whether BGP is enabled for this virtual network gateway or not. bool
Optional
enableBgpRouteTranslationForNat EnableBgpRouteTranslationForNat flag. bool
Optional
enableDnsForwarding Whether dns forwarding is enabled or not. bool
Optional
enablePrivateIpAddress Whether private IP needs to be enabled on this gateway for connections or not. bool
Optional
extendedLocation The extended location of type local virtual network gateway. ExtendedLocation
Optional
gatewayDefaultSite The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. SubResource
Optional
gatewayType The type of this virtual network gateway. VirtualNetworkGatewayPropertiesFormat_GatewayType
Optional
identity The identity of the virtual network gateway, if configured. ManagedServiceIdentity
Optional
ipConfigurations IP configurations for virtual network gateway. VirtualNetworkGatewayIPConfiguration[]
Optional
location Resource location. string
Optional
natRules NatRules for virtual network gateway. VirtualNetworkGatewayNatRule[]
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure VirtualNetworkGatewayOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
resiliencyModel Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed VirtualNetworkGatewayPropertiesFormat_ResiliencyModel
Optional
sku The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. VirtualNetworkGatewaySku
Optional
tags Resource tags. map[string]string
Optional
virtualNetworkGatewayPolicyGroups The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway. VirtualNetworkGatewayPolicyGroup[]
Optional
vNetExtendedLocationResourceReference Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. genruntime.ResourceReference
Optional
vpnClientConfiguration The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations. VpnClientConfiguration
Optional
vpnGatewayGeneration The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration
Optional
vpnType The type of this virtual network gateway. VirtualNetworkGatewayPropertiesFormat_VpnType
Optional

VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded

Property Description Type
activeActive ActiveActive flag. bool
Optional
adminState Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet VirtualNetworkGatewayPropertiesFormat_AdminState_STATUS
Optional
allowRemoteVnetTraffic Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN. bool
Optional
allowVirtualWanTraffic Configures this gateway to accept traffic from remote Virtual WAN networks. bool
Optional
autoScaleConfiguration Autoscale configuration for virutal network gateway VirtualNetworkGatewayAutoScaleConfiguration_STATUS
Optional
bgpSettings Virtual network gateway’s BGP speaker settings. BgpSettings_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
customRoutes The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient. AddressSpace_STATUS
Optional
disableIPSecReplayProtection disableIPSecReplayProtection flag. bool
Optional
enableBgp Whether BGP is enabled for this virtual network gateway or not. bool
Optional
enableBgpRouteTranslationForNat EnableBgpRouteTranslationForNat flag. bool
Optional
enableDnsForwarding Whether dns forwarding is enabled or not. bool
Optional
enablePrivateIpAddress Whether private IP needs to be enabled on this gateway for connections or not. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of type local virtual network gateway. ExtendedLocation_STATUS
Optional
gatewayDefaultSite The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. SubResource_STATUS
Optional
gatewayType The type of this virtual network gateway. VirtualNetworkGatewayPropertiesFormat_GatewayType_STATUS
Optional
id Resource ID. string
Optional
identity The identity of the virtual network gateway, if configured. ManagedServiceIdentity_STATUS
Optional
inboundDnsForwardingEndpoint The IP address allocated by the gateway to which dns requests can be sent. string
Optional
ipConfigurations IP configurations for virtual network gateway. VirtualNetworkGatewayIPConfiguration_STATUS[]
Optional
location Resource location. string
Optional
name Resource name. string
Optional
natRules NatRules for virtual network gateway. VirtualNetworkGatewayNatRule_STATUS[]
Optional
provisioningState The provisioning state of the virtual network gateway resource. ProvisioningState_STATUS
Optional
resiliencyModel Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed VirtualNetworkGatewayPropertiesFormat_ResiliencyModel_STATUS
Optional
resourceGuid The resource GUID property of the virtual network gateway resource. string
Optional
sku The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. VirtualNetworkGatewaySku_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
virtualNetworkGatewayPolicyGroups The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway. VirtualNetworkGatewayPolicyGroup_STATUS[]
Optional
vNetExtendedLocationResourceId Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. string
Optional
vpnClientConfiguration The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations. VpnClientConfiguration_STATUS
Optional
vpnGatewayGeneration The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_STATUS
Optional
vpnType The type of this virtual network gateway. VirtualNetworkGatewayPropertiesFormat_VpnType_STATUS
Optional

VirtualNetworkGatewayList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetworkGateway.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items VirtualNetworkGateway[]
Optional

VirtualNetworkList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/virtualNetworks/{virtualNetworkName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items VirtualNetwork[]
Optional

VirtualNetworksSubnet

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

Used by: VirtualNetworksSubnetList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec VirtualNetworksSubnet_Spec
Optional
status VirtualNetworksSubnet_STATUS
Optional

VirtualNetworksSubnet_Spec

Property Description Type
addressPrefix The address prefix for the subnet. string
Optional
addressPrefixes List of address prefixes for the subnet. string[]
Optional
applicationGatewayIPConfigurations Application gateway IP configurations of virtual network resource. ApplicationGatewayIPConfiguration_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
defaultOutboundAccess Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet. bool
Optional
delegations An array of references to the delegations on the subnet. Delegation[]
Optional
ipAllocations Array of IpAllocation which reference this subnet. SubResource[]
Optional
natGateway Nat gateway associated with this subnet. SubResource
Optional
networkSecurityGroup The reference to the NetworkSecurityGroup resource. NetworkSecurityGroupSpec_VirtualNetworks_Subnet_SubResourceEmbedded
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure VirtualNetworksSubnetOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/VirtualNetwork resource genruntime.KnownResourceReference
Required
privateEndpointNetworkPolicies Enable or Disable apply network policies on private end point in the subnet. SubnetPropertiesFormat_PrivateEndpointNetworkPolicies
Optional
privateLinkServiceNetworkPolicies Enable or Disable apply network policies on private link service in the subnet. SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies
Optional
routeTable The reference to the RouteTable resource. RouteTableSpec_VirtualNetworks_Subnet_SubResourceEmbedded
Optional
serviceEndpointPolicies An array of service endpoint policies. ServiceEndpointPolicySpec_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
serviceEndpoints An array of service endpoints. ServiceEndpointPropertiesFormat[]
Optional
sharingScope Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. SubnetPropertiesFormat_SharingScope
Optional

VirtualNetworksSubnet_STATUS

Property Description Type
addressPrefix The address prefix for the subnet. string
Optional
addressPrefixes List of address prefixes for the subnet. string[]
Optional
applicationGatewayIPConfigurations Application gateway IP configurations of virtual network resource. ApplicationGatewayIPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
defaultOutboundAccess Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet. bool
Optional
delegations An array of references to the delegations on the subnet. Delegation_STATUS[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
ipAllocations Array of IpAllocation which reference this subnet. SubResource_STATUS[]
Optional
ipConfigurationProfiles Array of IP configuration profiles which reference this subnet. IPConfigurationProfile_STATUS[]
Optional
ipConfigurations An array of references to the network interface IP configurations using subnet. This field is not included if there are more than 2000 entries. IPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
natGateway Nat gateway associated with this subnet. SubResource_STATUS
Optional
networkSecurityGroup The reference to the NetworkSecurityGroup resource. NetworkSecurityGroup_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded
Optional
privateEndpointNetworkPolicies Enable or Disable apply network policies on private end point in the subnet. SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_STATUS
Optional
privateEndpoints An array of references to private endpoints. PrivateEndpoint_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
privateLinkServiceNetworkPolicies Enable or Disable apply network policies on private link service in the subnet. SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_STATUS
Optional
provisioningState The provisioning state of the subnet resource. ProvisioningState_STATUS
Optional
purpose A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. string
Optional
resourceNavigationLinks An array of references to the external resources using subnet. ResourceNavigationLink_STATUS[]
Optional
routeTable The reference to the RouteTable resource. RouteTable_STATUS_SubResourceEmbedded
Optional
serviceAssociationLinks An array of references to services injecting into this subnet. ServiceAssociationLink_STATUS[]
Optional
serviceEndpointPolicies An array of service endpoint policies. ServiceEndpointPolicy_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
serviceEndpoints An array of service endpoints. ServiceEndpointPropertiesFormat_STATUS[]
Optional
sharingScope Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. SubnetPropertiesFormat_SharingScope_STATUS
Optional
type Resource type. string
Optional

VirtualNetworksSubnetList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items VirtualNetworksSubnet[]
Optional

VirtualNetworksVirtualNetworkPeering

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}

Used by: VirtualNetworksVirtualNetworkPeeringList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec VirtualNetworksVirtualNetworkPeering_Spec
Optional
status VirtualNetworksVirtualNetworkPeering_STATUS
Optional

VirtualNetworksVirtualNetworkPeering_Spec

Property Description Type
allowForwardedTraffic Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. bool
Optional
allowGatewayTransit If gateway links can be used in remote virtual networking to link to this virtual network. bool
Optional
allowVirtualNetworkAccess Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. bool
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
doNotVerifyRemoteGateways If we need to verify the provisioning state of the remote gateway. bool
Optional
enableOnlyIPv6Peering Whether only Ipv6 address space is peered for subnet peering. bool
Optional
localAddressSpace The local address space of the local virtual network that is peered. AddressSpace
Optional
localSubnetNames List of local subnet names that are subnet peered with remote virtual network. string[]
Optional
localVirtualNetworkAddressSpace The current local address space of the local virtual network that is peered. AddressSpace
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure VirtualNetworksVirtualNetworkPeeringOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/VirtualNetwork resource genruntime.KnownResourceReference
Required
peerCompleteVnets Whether complete virtual network address space is peered. bool
Optional
peeringState The status of the virtual network peering. VirtualNetworkPeeringPropertiesFormat_PeeringState
Optional
peeringSyncLevel The peering sync status of the virtual network peering. VirtualNetworkPeeringPropertiesFormat_PeeringSyncLevel
Optional
remoteAddressSpace The reference to the address space peered with the remote virtual network. AddressSpace
Optional
remoteBgpCommunities The reference to the remote virtual network’s Bgp Communities. VirtualNetworkBgpCommunities
Optional
remoteSubnetNames List of remote subnet names from remote virtual network that are subnet peered. string[]
Optional
remoteVirtualNetwork The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). SubResource
Optional
remoteVirtualNetworkAddressSpace The reference to the current address space of the remote virtual network. AddressSpace
Optional
useRemoteGateways If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. bool
Optional

VirtualNetworksVirtualNetworkPeering_STATUS

Property Description Type
allowForwardedTraffic Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. bool
Optional
allowGatewayTransit If gateway links can be used in remote virtual networking to link to this virtual network. bool
Optional
allowVirtualNetworkAccess Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. bool
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
doNotVerifyRemoteGateways If we need to verify the provisioning state of the remote gateway. bool
Optional
enableOnlyIPv6Peering Whether only Ipv6 address space is peered for subnet peering. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
localAddressSpace The local address space of the local virtual network that is peered. AddressSpace_STATUS
Optional
localSubnetNames List of local subnet names that are subnet peered with remote virtual network. string[]
Optional
localVirtualNetworkAddressSpace The current local address space of the local virtual network that is peered. AddressSpace_STATUS
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
peerCompleteVnets Whether complete virtual network address space is peered. bool
Optional
peeringState The status of the virtual network peering. VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS
Optional
peeringSyncLevel The peering sync status of the virtual network peering. VirtualNetworkPeeringPropertiesFormat_PeeringSyncLevel_STATUS
Optional
provisioningState The provisioning state of the virtual network peering resource. ProvisioningState_STATUS
Optional
remoteAddressSpace The reference to the address space peered with the remote virtual network. AddressSpace_STATUS
Optional
remoteBgpCommunities The reference to the remote virtual network’s Bgp Communities. VirtualNetworkBgpCommunities_STATUS
Optional
remoteSubnetNames List of remote subnet names from remote virtual network that are subnet peered. string[]
Optional
remoteVirtualNetwork The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). SubResource_STATUS
Optional
remoteVirtualNetworkAddressSpace The reference to the current address space of the remote virtual network. AddressSpace_STATUS
Optional
remoteVirtualNetworkEncryption The reference to the remote virtual network’s encryption VirtualNetworkEncryption_STATUS
Optional
resourceGuid The resourceGuid property of the Virtual Network peering resource. string
Optional
type Resource type. string
Optional
useRemoteGateways If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. bool
Optional

VirtualNetworksVirtualNetworkPeeringList

Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items VirtualNetworksVirtualNetworkPeering[]
Optional

BastionHost_Spec

Used by: BastionHost.

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
disableCopyPaste Enable/Disable Copy/Paste feature of the Bastion Host resource. bool
Optional
dnsName FQDN for the endpoint on which bastion host is accessible. string
Optional
enableFileCopy Enable/Disable File Copy feature of the Bastion Host resource. bool
Optional
enableIpConnect Enable/Disable IP Connect feature of the Bastion Host resource. bool
Optional
enableKerberos Enable/Disable Kerberos feature of the Bastion Host resource. bool
Optional
enableSessionRecording Enable/Disable Session Recording feature of the Bastion Host resource. bool
Optional
enableShareableLink Enable/Disable Shareable Link of the Bastion Host resource. bool
Optional
enableTunneling Enable/Disable Tunneling feature of the Bastion Host resource. bool
Optional
ipConfigurations IP configuration of the Bastion Host resource. BastionHostIPConfiguration[]
Optional
location Resource location. string
Optional
networkAcls BastionHostPropertiesFormat_NetworkAcls
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure BastionHostOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
scaleUnits The scale units for the Bastion Host resource. int
Optional
sku The sku of this Bastion Host. Sku
Optional
tags Resource tags. map[string]string
Optional
virtualNetwork Reference to an existing virtual network required for Developer Bastion Host only. SubResource
Optional
zones A list of availability zones denoting where the resource needs to come from. string[]
Optional

BastionHost_STATUS

Bastion Host resource.

Used by: BastionHost.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
disableCopyPaste Enable/Disable Copy/Paste feature of the Bastion Host resource. bool
Optional
dnsName FQDN for the endpoint on which bastion host is accessible. string
Optional
enableFileCopy Enable/Disable File Copy feature of the Bastion Host resource. bool
Optional
enableIpConnect Enable/Disable IP Connect feature of the Bastion Host resource. bool
Optional
enableKerberos Enable/Disable Kerberos feature of the Bastion Host resource. bool
Optional
enableSessionRecording Enable/Disable Session Recording feature of the Bastion Host resource. bool
Optional
enableShareableLink Enable/Disable Shareable Link of the Bastion Host resource. bool
Optional
enableTunneling Enable/Disable Tunneling feature of the Bastion Host resource. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
ipConfigurations IP configuration of the Bastion Host resource. BastionHostIPConfiguration_STATUS[]
Optional
location Resource location. string
Optional
name Resource name. string
Optional
networkAcls BastionHostPropertiesFormat_NetworkAcls_STATUS
Optional
provisioningState The provisioning state of the bastion host resource. ProvisioningState_STATUS
Optional
scaleUnits The scale units for the Bastion Host resource. int
Optional
sku The sku of this Bastion Host. Sku_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
virtualNetwork Reference to an existing virtual network required for Developer Bastion Host only. SubResource_STATUS
Optional
zones A list of availability zones denoting where the resource needs to come from. string[]
Optional

LoadBalancer_Spec

Used by: LoadBalancer.

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
backendAddressPools Collection of backend address pools used by a load balancer. BackendAddressPool_LoadBalancer_SubResourceEmbedded[]
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation
Optional
frontendIPConfigurations Object representing the frontend IPs to be used for the load balancer. FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded[]
Optional
inboundNatPools Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound NAT rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules. InboundNatPool[]
Optional
inboundNatRules Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules. InboundNatRule_LoadBalancer_SubResourceEmbedded[]
Optional
loadBalancingRules Object collection representing the load balancing rules Gets the provisioning. LoadBalancingRule[]
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure LoadBalancerOperatorSpec
Optional
outboundRules The outbound rules. OutboundRule[]
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
probes Collection of probe objects used in the load balancer. Probe[]
Optional
sku The load balancer SKU. LoadBalancerSku
Optional
tags Resource tags. map[string]string
Optional

LoadBalancer_STATUS

LoadBalancer resource.

Used by: LoadBalancer.

Property Description Type
backendAddressPools Collection of backend address pools used by a load balancer. BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded[]
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation_STATUS
Optional
frontendIPConfigurations Object representing the frontend IPs to be used for the load balancer. FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded[]
Optional
id Resource ID. string
Optional
inboundNatPools Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound NAT rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules. InboundNatPool_STATUS[]
Optional
inboundNatRules Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules. InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded[]
Optional
loadBalancingRules Object collection representing the load balancing rules Gets the provisioning. LoadBalancingRule_STATUS[]
Optional
location Resource location. string
Optional
name Resource name. string
Optional
outboundRules The outbound rules. OutboundRule_STATUS[]
Optional
probes Collection of probe objects used in the load balancer. Probe_STATUS[]
Optional
provisioningState The provisioning state of the load balancer resource. ProvisioningState_STATUS
Optional
resourceGuid The resource GUID property of the load balancer resource. string
Optional
sku The load balancer SKU. LoadBalancerSku_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional

LoadBalancersInboundNatRule_Spec

Used by: LoadBalancersInboundNatRule.

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
backendAddressPool A reference to backendAddressPool resource. SubResource
Optional
backendPort The port used for the internal endpoint. Acceptable values range from 1 to 65535. int
Optional
enableFloatingIP Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint. bool
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
frontendIPConfiguration A reference to frontend IP addresses. SubResource
Optional
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeEnd The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeStart The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
idleTimeoutInMinutes The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. int
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure LoadBalancersInboundNatRuleOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/LoadBalancer resource genruntime.KnownResourceReference
Required
protocol The reference to the transport protocol used by the load balancing rule. TransportProtocol
Optional

LoadBalancersInboundNatRule_STATUS

Used by: LoadBalancersInboundNatRule.

Property Description Type
backendAddressPool A reference to backendAddressPool resource. SubResource_STATUS
Optional
backendIPConfiguration A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP. NetworkInterfaceIPConfiguration_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded
Optional
backendPort The port used for the internal endpoint. Acceptable values range from 1 to 65535. int
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
enableFloatingIP Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint. bool
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
frontendIPConfiguration A reference to frontend IP addresses. SubResource_STATUS
Optional
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeEnd The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeStart The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
id Resource ID. string
Optional
idleTimeoutInMinutes The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. int
Optional
name The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource. string
Optional
protocol The reference to the transport protocol used by the load balancing rule. TransportProtocol_STATUS
Optional
provisioningState The provisioning state of the inbound NAT rule resource. ProvisioningState_STATUS
Optional
type Type of the resource. string
Optional

NatGateway_Spec

Used by: NatGateway.

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
idleTimeoutInMinutes The idle timeout of the nat gateway. int
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure NatGatewayOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
publicIpAddresses An array of public ip addresses associated with the nat gateway resource. SubResource[]
Optional
publicIpPrefixes An array of public ip prefixes associated with the nat gateway resource. SubResource[]
Optional
sku The nat gateway SKU. NatGatewaySku
Optional
tags Resource tags. map[string]string
Optional
zones A list of availability zones denoting the zone in which Nat Gateway should be deployed. string[]
Optional

NatGateway_STATUS

Nat Gateway resource.

Used by: NatGateway.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
idleTimeoutInMinutes The idle timeout of the nat gateway. int
Optional
location Resource location. string
Optional
name Resource name. string
Optional
provisioningState The provisioning state of the NAT gateway resource. ProvisioningState_STATUS
Optional
publicIpAddresses An array of public ip addresses associated with the nat gateway resource. SubResource_STATUS[]
Optional
publicIpPrefixes An array of public ip prefixes associated with the nat gateway resource. SubResource_STATUS[]
Optional
resourceGuid The resource GUID property of the NAT gateway resource. string
Optional
sku The nat gateway SKU. NatGatewaySku_STATUS
Optional
subnets An array of references to the subnets using this nat gateway resource. SubResource_STATUS[]
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
zones A list of availability zones denoting the zone in which Nat Gateway should be deployed. string[]
Optional

NetworkInterface_Spec

Used by: NetworkInterface.

Property Description Type
auxiliaryMode Auxiliary mode of Network Interface resource. NetworkInterfacePropertiesFormat_AuxiliaryMode
Optional
auxiliarySku Auxiliary sku of Network Interface resource. NetworkInterfacePropertiesFormat_AuxiliarySku
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
disableTcpStateTracking Indicates whether to disable tcp state tracking. bool
Optional
dnsSettings The DNS settings in network interface. NetworkInterfaceDnsSettings
Optional
enableAcceleratedNetworking If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. bool
Optional
enableIPForwarding Indicates whether IP forwarding is enabled on this network interface. bool
Optional
extendedLocation The extended location of the network interface. ExtendedLocation
Optional
ipConfigurations A list of IPConfigurations of the network interface. NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded[]
Optional
location Resource location. string
Optional
networkSecurityGroup The reference to the NetworkSecurityGroup resource. NetworkSecurityGroupSpec_NetworkInterface_SubResourceEmbedded
Optional
nicType Type of Network Interface resource. NetworkInterfacePropertiesFormat_NicType
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure NetworkInterfaceOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
privateLinkService Privatelinkservice of the network interface resource. PrivateLinkServiceSpec
Optional
tags Resource tags. map[string]string
Optional
workloadType WorkloadType of the NetworkInterface for BareMetal resources string
Optional

NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded

A network interface in a resource group.

Used by: NetworkInterface.

Property Description Type
auxiliaryMode Auxiliary mode of Network Interface resource. NetworkInterfacePropertiesFormat_AuxiliaryMode_STATUS
Optional
auxiliarySku Auxiliary sku of Network Interface resource. NetworkInterfacePropertiesFormat_AuxiliarySku_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
disableTcpStateTracking Indicates whether to disable tcp state tracking. bool
Optional
dnsSettings The DNS settings in network interface. NetworkInterfaceDnsSettings_STATUS
Optional
dscpConfiguration A reference to the dscp configuration to which the network interface is linked. SubResource_STATUS
Optional
enableAcceleratedNetworking If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. bool
Optional
enableIPForwarding Indicates whether IP forwarding is enabled on this network interface. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the network interface. ExtendedLocation_STATUS
Optional
hostedWorkloads A list of references to linked BareMetal resources. string[]
Optional
id Resource ID. string
Optional
ipConfigurations A list of IPConfigurations of the network interface. NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded[]
Optional
location Resource location. string
Optional
macAddress The MAC address of the network interface. string
Optional
migrationPhase Migration phase of Network Interface resource. NetworkInterfacePropertiesFormat_MigrationPhase_STATUS
Optional
name Resource name. string
Optional
networkSecurityGroup The reference to the NetworkSecurityGroup resource. NetworkSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded
Optional
nicType Type of Network Interface resource. NetworkInterfacePropertiesFormat_NicType_STATUS
Optional
primary Whether this is a primary network interface on a virtual machine. bool
Optional
privateEndpoint A reference to the private endpoint to which the network interface is linked. PrivateEndpoint_STATUS_NetworkInterface_SubResourceEmbedded
Optional
privateLinkService Privatelinkservice of the network interface resource. PrivateLinkService_STATUS_NetworkInterface_SubResourceEmbedded
Optional
provisioningState The provisioning state of the network interface resource. ProvisioningState_STATUS
Optional
resourceGuid The resource GUID property of the network interface resource. string
Optional
tags Resource tags. map[string]string
Optional
tapConfigurations A list of TapConfigurations of the network interface. NetworkInterfaceTapConfiguration_STATUS_NetworkInterface_SubResourceEmbedded[]
Optional
type Resource type. string
Optional
virtualMachine The reference to a virtual machine. SubResource_STATUS
Optional
vnetEncryptionSupported Whether the virtual machine this nic is attached to supports encryption. bool
Optional
workloadType WorkloadType of the NetworkInterface for BareMetal resources string
Optional

NetworkSecurityGroup_Spec

Used by: NetworkSecurityGroup.

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
flushConnection When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. bool
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure NetworkSecurityGroupOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
tags Resource tags. map[string]string
Optional

NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded

NetworkSecurityGroup resource.

Used by: NetworkSecurityGroup.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
defaultSecurityRules The default security rules of network security group. SecurityRule_STATUS[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
flushConnection When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. bool
Optional
id Resource ID. string
Optional
location Resource location. string
Optional
name Resource name. string
Optional
networkInterfaces A collection of references to network interfaces. NetworkInterface_STATUS_NetworkSecurityGroup_SubResourceEmbedded[]
Optional
provisioningState The provisioning state of the network security group resource. ProvisioningState_STATUS
Optional
resourceGuid The resource GUID property of the network security group resource. string
Optional
subnets A collection of references to subnets. Subnet_STATUS_NetworkSecurityGroup_SubResourceEmbedded[]
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional

NetworkSecurityGroupsSecurityRule_Spec

Used by: NetworkSecurityGroupsSecurityRule.

Property Description Type
access The network traffic is allowed or denied. SecurityRuleAccess
Required
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
description A description for this rule. Restricted to 140 chars. string
Optional
destinationAddressPrefix The destination address prefix. CIDR or destination IP range. Asterisk ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. string
Optional
destinationAddressPrefixes The destination address prefixes. CIDR or destination IP ranges. string[]
Optional
destinationApplicationSecurityGroups The application security group specified as destination. ApplicationSecurityGroupSpec_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded[]
Optional
destinationPortRange The destination port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. string
Optional
destinationPortRanges The destination port ranges. string[]
Optional
direction The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. SecurityRuleDirection
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure NetworkSecurityGroupsSecurityRuleOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/NetworkSecurityGroup resource genruntime.KnownResourceReference
Required
priority The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. int
Required
protocol Network protocol this rule applies to. SecurityRulePropertiesFormat_Protocol
Required
sourceAddressPrefix The CIDR or source IP range. Asterisk ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. string
Optional
sourceAddressPrefixes The CIDR or source IP ranges. string[]
Optional
sourceApplicationSecurityGroups The application security group specified as source. ApplicationSecurityGroupSpec_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded[]
Optional
sourcePortRange The source port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. string
Optional
sourcePortRanges The source port ranges. string[]
Optional

NetworkSecurityGroupsSecurityRule_STATUS

Used by: NetworkSecurityGroupsSecurityRule.

Property Description Type
access The network traffic is allowed or denied. SecurityRuleAccess_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
description A description for this rule. Restricted to 140 chars. string
Optional
destinationAddressPrefix The destination address prefix. CIDR or destination IP range. Asterisk ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. string
Optional
destinationAddressPrefixes The destination address prefixes. CIDR or destination IP ranges. string[]
Optional
destinationApplicationSecurityGroups The application security group specified as destination. ApplicationSecurityGroup_STATUS_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded[]
Optional
destinationPortRange The destination port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. string
Optional
destinationPortRanges The destination port ranges. string[]
Optional
direction The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. SecurityRuleDirection_STATUS
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
priority The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. int
Optional
protocol Network protocol this rule applies to. SecurityRulePropertiesFormat_Protocol_STATUS
Optional
provisioningState The provisioning state of the security rule resource. ProvisioningState_STATUS
Optional
sourceAddressPrefix The CIDR or source IP range. Asterisk ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. string
Optional
sourceAddressPrefixes The CIDR or source IP ranges. string[]
Optional
sourceApplicationSecurityGroups The application security group specified as source. ApplicationSecurityGroup_STATUS_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded[]
Optional
sourcePortRange The source port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. string
Optional
sourcePortRanges The source port ranges. string[]
Optional
type The type of the resource. string
Optional

PrivateEndpoint_Spec

Used by: PrivateEndpoint.

Property Description Type
applicationSecurityGroups Application security groups in which the private endpoint IP configuration is included. ApplicationSecurityGroupSpec_PrivateEndpoint_SubResourceEmbedded[]
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
customNetworkInterfaceName The custom name of the network interface attached to the private endpoint. string
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation
Optional
ipConfigurations A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints. PrivateEndpointIPConfiguration[]
Optional
location Resource location. string
Optional
manualPrivateLinkServiceConnections A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. PrivateLinkServiceConnection[]
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure PrivateEndpointOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
privateLinkServiceConnections A grouping of information about the connection to the remote resource. PrivateLinkServiceConnection[]
Optional
subnet The ID of the subnet from which the private IP will be allocated. Subnet_PrivateEndpoint_SubResourceEmbedded
Optional
tags Resource tags. map[string]string
Optional

PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded

Private endpoint resource.

Used by: PrivateEndpoint.

Property Description Type
applicationSecurityGroups Application security groups in which the private endpoint IP configuration is included. ApplicationSecurityGroup_STATUS_PrivateEndpoint_SubResourceEmbedded[]
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
customDnsConfigs An array of custom dns configurations. CustomDnsConfigPropertiesFormat_STATUS[]
Optional
customNetworkInterfaceName The custom name of the network interface attached to the private endpoint. string
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation_STATUS
Optional
id Resource ID. string
Optional
ipConfigurations A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints. PrivateEndpointIPConfiguration_STATUS[]
Optional
location Resource location. string
Optional
manualPrivateLinkServiceConnections A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. PrivateLinkServiceConnection_STATUS[]
Optional
name Resource name. string
Optional
networkInterfaces An array of references to the network interfaces created for this private endpoint. NetworkInterface_STATUS_PrivateEndpoint_SubResourceEmbedded[]
Optional
privateLinkServiceConnections A grouping of information about the connection to the remote resource. PrivateLinkServiceConnection_STATUS[]
Optional
provisioningState The provisioning state of the private endpoint resource. ProvisioningState_STATUS
Optional
subnet The ID of the subnet from which the private IP will be allocated. Subnet_STATUS_PrivateEndpoint_SubResourceEmbedded
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional

PrivateEndpointsPrivateDnsZoneGroup_Spec

Used by: PrivateEndpointsPrivateDnsZoneGroup.

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure PrivateEndpointsPrivateDnsZoneGroupOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/PrivateEndpoint resource genruntime.KnownResourceReference
Required
privateDnsZoneConfigs A collection of private dns zone configurations of the private dns zone group. PrivateDnsZoneConfig[]
Optional

PrivateEndpointsPrivateDnsZoneGroup_STATUS

Used by: PrivateEndpointsPrivateDnsZoneGroup.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
privateDnsZoneConfigs A collection of private dns zone configurations of the private dns zone group. PrivateDnsZoneConfig_STATUS[]
Optional
provisioningState The provisioning state of the private dns zone group resource. ProvisioningState_STATUS
Optional

PrivateLinkService_Spec

Used by: PrivateLinkService.

Property Description Type
autoApproval The auto-approval list of the private link service. ResourceSet
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
destinationIPAddress The destination IP address of the private link service. string
Optional
enableProxyProtocol Whether the private link service is enabled for proxy protocol or not. bool
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation
Optional
fqdns The list of Fqdn. string[]
Optional
ipConfigurations An array of private link service IP configurations. PrivateLinkServiceIpConfiguration[]
Optional
loadBalancerFrontendIpConfigurations An array of references to the load balancer IP configurations. FrontendIPConfiguration_PrivateLinkService_SubResourceEmbedded[]
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure PrivateLinkServiceOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
tags Resource tags. map[string]string
Optional
visibility The visibility list of the private link service. ResourceSet
Optional

PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded

Private link service resource.

Used by: PrivateLinkService.

Property Description Type
alias The alias of the private link service. string
Optional
autoApproval The auto-approval list of the private link service. ResourceSet_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
destinationIPAddress The destination IP address of the private link service. string
Optional
enableProxyProtocol Whether the private link service is enabled for proxy protocol or not. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the load balancer. ExtendedLocation_STATUS
Optional
fqdns The list of Fqdn. string[]
Optional
id Resource ID. string
Optional
ipConfigurations An array of private link service IP configurations. PrivateLinkServiceIpConfiguration_STATUS[]
Optional
loadBalancerFrontendIpConfigurations An array of references to the load balancer IP configurations. FrontendIPConfiguration_STATUS_PrivateLinkService_SubResourceEmbedded[]
Optional
location Resource location. string
Optional
name Resource name. string
Optional
networkInterfaces An array of references to the network interfaces created for this private link service. NetworkInterface_STATUS_PrivateLinkService_SubResourceEmbedded[]
Optional
privateEndpointConnections An array of list about connections to the private endpoint. PrivateEndpointConnection_STATUS[]
Optional
provisioningState The provisioning state of the private link service resource. ProvisioningState_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
visibility The visibility list of the private link service. ResourceSet_STATUS
Optional

PublicIPAddress_Spec

Used by: PublicIPAddress.

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
ddosSettings The DDoS protection custom policy associated with the public IP address. DdosSettings
Optional
deleteOption Specify what happens to the public IP address when the VM using it is deleted PublicIPAddressPropertiesFormat_DeleteOption
Optional
dnsSettings The FQDN of the DNS record associated with the public IP address. PublicIPAddressDnsSettings
Optional
extendedLocation The extended location of the public ip address. ExtendedLocation
Optional
idleTimeoutInMinutes The idle timeout of the public IP address. int
Optional
ipAddress The IP address associated with the public IP address resource. string
Optional
ipTags The list of tags associated with the public IP address. IpTag[]
Optional
linkedPublicIPAddress The linked public IP address of the public IP address resource. PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded
Optional
location Resource location. string
Optional
natGateway The NatGateway for the Public IP address. NatGatewaySpec_PublicIPAddress_SubResourceEmbedded
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure PublicIPAddressOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
publicIPAddressVersion The public IP address version. IPVersion
Optional
publicIPAllocationMethod The public IP address allocation method. IPAllocationMethod
Optional
publicIPPrefix The Public IP Prefix this Public IP Address should be allocated from. SubResource
Optional
servicePublicIPAddress The service public IP address of the public IP address resource. PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded
Optional
sku The public IP address SKU. PublicIPAddressSku
Optional
tags Resource tags. map[string]string
Optional
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]
Optional

PublicIPAddress_STATUS

Public IP address resource.

Used by: PublicIPAddress.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
ddosSettings The DDoS protection custom policy associated with the public IP address. DdosSettings_STATUS
Optional
deleteOption Specify what happens to the public IP address when the VM using it is deleted PublicIPAddressPropertiesFormat_DeleteOption_STATUS
Optional
dnsSettings The FQDN of the DNS record associated with the public IP address. PublicIPAddressDnsSettings_STATUS
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the public ip address. ExtendedLocation_STATUS
Optional
id Resource ID. string
Optional
idleTimeoutInMinutes The idle timeout of the public IP address. int
Optional
ipAddress The IP address associated with the public IP address resource. string
Optional
ipConfiguration The IP configuration associated with the public IP address. IPConfiguration_STATUS_PublicIPAddress_SubResourceEmbedded
Optional
ipTags The list of tags associated with the public IP address. IpTag_STATUS[]
Optional
location Resource location. string
Optional
migrationPhase Migration phase of Public IP Address. PublicIPAddressPropertiesFormat_MigrationPhase_STATUS
Optional
name Resource name. string
Optional
natGateway The NatGateway for the Public IP address. NatGateway_STATUS_PublicIPAddress_SubResourceEmbedded
Optional
provisioningState The provisioning state of the public IP address resource. ProvisioningState_STATUS
Optional
publicIPAddressVersion The public IP address version. IPVersion_STATUS
Optional
publicIPAllocationMethod The public IP address allocation method. IPAllocationMethod_STATUS
Optional
publicIPPrefix The Public IP Prefix this Public IP Address should be allocated from. SubResource_STATUS
Optional
resourceGuid The resource GUID property of the public IP address resource. string
Optional
sku The public IP address SKU. PublicIPAddressSku_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]
Optional

PublicIPPrefix_Spec

Used by: PublicIPPrefix.

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
customIPPrefix The customIpPrefix that this prefix is associated with. SubResource
Optional
extendedLocation The extended location of the public ip address. ExtendedLocation
Optional
ipTags The list of tags associated with the public IP prefix. IpTag[]
Optional
location Resource location. string
Optional
natGateway NatGateway of Public IP Prefix. NatGatewaySpec_PublicIPPrefix_SubResourceEmbedded
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure PublicIPPrefixOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
prefixLength The Length of the Public IP Prefix. int
Optional
publicIPAddressVersion The public IP address version. IPVersion
Optional
sku The public IP prefix SKU. PublicIPPrefixSku
Optional
tags Resource tags. map[string]string
Optional
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]
Optional

PublicIPPrefix_STATUS

Public IP prefix resource.

Used by: PublicIPPrefix.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
customIPPrefix The customIpPrefix that this prefix is associated with. SubResource_STATUS
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the public ip address. ExtendedLocation_STATUS
Optional
id Resource ID. string
Optional
ipPrefix The allocated Prefix. string
Optional
ipTags The list of tags associated with the public IP prefix. IpTag_STATUS[]
Optional
loadBalancerFrontendIpConfiguration The reference to load balancer frontend IP configuration associated with the public IP prefix. SubResource_STATUS
Optional
location Resource location. string
Optional
name Resource name. string
Optional
natGateway NatGateway of Public IP Prefix. NatGateway_STATUS_PublicIPPrefix_SubResourceEmbedded
Optional
prefixLength The Length of the Public IP Prefix. int
Optional
provisioningState The provisioning state of the public IP prefix resource. ProvisioningState_STATUS
Optional
publicIPAddresses The list of all referenced PublicIPAddresses. ReferencedPublicIpAddress_STATUS[]
Optional
publicIPAddressVersion The public IP address version. IPVersion_STATUS
Optional
resourceGuid The resource GUID property of the public IP prefix resource. string
Optional
sku The public IP prefix SKU. PublicIPPrefixSku_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]
Optional

RouteTable_Spec

Used by: RouteTable.

Property Description Type
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
disableBgpRoutePropagation Whether to disable the routes learned by BGP on that route table. True means disable. bool
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure RouteTableOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
tags Resource tags. map[string]string
Optional

RouteTable_STATUS

Route table resource.

Used by: RouteTable.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
disableBgpRoutePropagation Whether to disable the routes learned by BGP on that route table. True means disable. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
location Resource location. string
Optional
name Resource name. string
Optional
provisioningState The provisioning state of the route table resource. ProvisioningState_STATUS
Optional
resourceGuid The resource GUID property of the route table. string
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional

RouteTablesRoute_Spec

Used by: RouteTablesRoute.

Property Description Type
addressPrefix The destination CIDR to which the route applies. string
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
nextHopIpAddress The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. string
Optional
nextHopType The type of Azure hop the packet should be sent to. RouteNextHopType
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure RouteTablesRouteOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/RouteTable resource genruntime.KnownResourceReference
Required

RouteTablesRoute_STATUS

Used by: RouteTablesRoute.

Property Description Type
addressPrefix The destination CIDR to which the route applies. string
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
hasBgpOverride A value indicating whether this route overrides overlapping BGP routes regardless of LPM. bool
Optional
id Resource ID. string
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
nextHopIpAddress The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. string
Optional
nextHopType The type of Azure hop the packet should be sent to. RouteNextHopType_STATUS
Optional
provisioningState The provisioning state of the route resource. ProvisioningState_STATUS
Optional
type The type of the resource. string
Optional

VirtualNetwork_Spec

Used by: VirtualNetwork.

Property Description Type
addressSpace The AddressSpace that contains an array of IP address ranges that can be used by subnets. AddressSpace
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
bgpCommunities Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. VirtualNetworkBgpCommunities
Optional
ddosProtectionPlan The DDoS protection plan associated with the virtual network. SubResource
Optional
dhcpOptions The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. DhcpOptions
Optional
enableDdosProtection Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource. bool
Optional
enableVmProtection Indicates if VM protection is enabled for all the subnets in the virtual network. bool
Optional
encryption Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. VirtualNetworkEncryption
Optional
extendedLocation The extended location of the virtual network. ExtendedLocation
Optional
flowTimeoutInMinutes The FlowTimeout value (in minutes) for the Virtual Network int
Optional
ipAllocations Array of IpAllocation which reference this VNET. SubResource[]
Optional
location Resource location. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure VirtualNetworkOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
privateEndpointVNetPolicies Private Endpoint VNet Policies. PrivateEndpointVNetPolicies
Optional
tags Resource tags. map[string]string
Optional

VirtualNetwork_STATUS

Virtual Network resource.

Used by: VirtualNetwork.

Property Description Type
addressSpace The AddressSpace that contains an array of IP address ranges that can be used by subnets. AddressSpace_STATUS
Optional
bgpCommunities Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. VirtualNetworkBgpCommunities_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
ddosProtectionPlan The DDoS protection plan associated with the virtual network. SubResource_STATUS
Optional
dhcpOptions The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. DhcpOptions_STATUS
Optional
enableDdosProtection Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource. bool
Optional
enableVmProtection Indicates if VM protection is enabled for all the subnets in the virtual network. bool
Optional
encryption Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. VirtualNetworkEncryption_STATUS
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of the virtual network. ExtendedLocation_STATUS
Optional
flowLogs A collection of references to flow log resources. FlowLog_STATUS_SubResourceEmbedded[]
Optional
flowTimeoutInMinutes The FlowTimeout value (in minutes) for the Virtual Network int
Optional
id Resource ID. string
Optional
ipAllocations Array of IpAllocation which reference this VNET. SubResource_STATUS[]
Optional
location Resource location. string
Optional
name Resource name. string
Optional
privateEndpointVNetPolicies Private Endpoint VNet Policies. PrivateEndpointVNetPolicies_STATUS
Optional
provisioningState The provisioning state of the virtual network resource. ProvisioningState_STATUS
Optional
resourceGuid The resourceGuid property of the Virtual Network resource. string
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional

VirtualNetworkGateway_Spec

Used by: VirtualNetworkGateway.

Property Description Type
activeActive ActiveActive flag. bool
Optional
adminState Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet VirtualNetworkGatewayPropertiesFormat_AdminState
Optional
allowRemoteVnetTraffic Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN. bool
Optional
allowVirtualWanTraffic Configures this gateway to accept traffic from remote Virtual WAN networks. bool
Optional
autoScaleConfiguration Autoscale configuration for virutal network gateway VirtualNetworkGatewayAutoScaleConfiguration
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
bgpSettings Virtual network gateway’s BGP speaker settings. BgpSettings
Optional
customRoutes The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient. AddressSpace
Optional
disableIPSecReplayProtection disableIPSecReplayProtection flag. bool
Optional
enableBgp Whether BGP is enabled for this virtual network gateway or not. bool
Optional
enableBgpRouteTranslationForNat EnableBgpRouteTranslationForNat flag. bool
Optional
enableDnsForwarding Whether dns forwarding is enabled or not. bool
Optional
enablePrivateIpAddress Whether private IP needs to be enabled on this gateway for connections or not. bool
Optional
extendedLocation The extended location of type local virtual network gateway. ExtendedLocation
Optional
gatewayDefaultSite The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. SubResource
Optional
gatewayType The type of this virtual network gateway. VirtualNetworkGatewayPropertiesFormat_GatewayType
Optional
identity The identity of the virtual network gateway, if configured. ManagedServiceIdentity
Optional
ipConfigurations IP configurations for virtual network gateway. VirtualNetworkGatewayIPConfiguration[]
Optional
location Resource location. string
Optional
natRules NatRules for virtual network gateway. VirtualNetworkGatewayNatRule[]
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure VirtualNetworkGatewayOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
resiliencyModel Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed VirtualNetworkGatewayPropertiesFormat_ResiliencyModel
Optional
sku The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. VirtualNetworkGatewaySku
Optional
tags Resource tags. map[string]string
Optional
virtualNetworkGatewayPolicyGroups The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway. VirtualNetworkGatewayPolicyGroup[]
Optional
vNetExtendedLocationResourceReference Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. genruntime.ResourceReference
Optional
vpnClientConfiguration The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations. VpnClientConfiguration
Optional
vpnGatewayGeneration The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration
Optional
vpnType The type of this virtual network gateway. VirtualNetworkGatewayPropertiesFormat_VpnType
Optional

VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded

A common class for general resource information.

Used by: VirtualNetworkGateway.

Property Description Type
activeActive ActiveActive flag. bool
Optional
adminState Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet VirtualNetworkGatewayPropertiesFormat_AdminState_STATUS
Optional
allowRemoteVnetTraffic Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN. bool
Optional
allowVirtualWanTraffic Configures this gateway to accept traffic from remote Virtual WAN networks. bool
Optional
autoScaleConfiguration Autoscale configuration for virutal network gateway VirtualNetworkGatewayAutoScaleConfiguration_STATUS
Optional
bgpSettings Virtual network gateway’s BGP speaker settings. BgpSettings_STATUS
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
customRoutes The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient. AddressSpace_STATUS
Optional
disableIPSecReplayProtection disableIPSecReplayProtection flag. bool
Optional
enableBgp Whether BGP is enabled for this virtual network gateway or not. bool
Optional
enableBgpRouteTranslationForNat EnableBgpRouteTranslationForNat flag. bool
Optional
enableDnsForwarding Whether dns forwarding is enabled or not. bool
Optional
enablePrivateIpAddress Whether private IP needs to be enabled on this gateway for connections or not. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
extendedLocation The extended location of type local virtual network gateway. ExtendedLocation_STATUS
Optional
gatewayDefaultSite The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. SubResource_STATUS
Optional
gatewayType The type of this virtual network gateway. VirtualNetworkGatewayPropertiesFormat_GatewayType_STATUS
Optional
id Resource ID. string
Optional
identity The identity of the virtual network gateway, if configured. ManagedServiceIdentity_STATUS
Optional
inboundDnsForwardingEndpoint The IP address allocated by the gateway to which dns requests can be sent. string
Optional
ipConfigurations IP configurations for virtual network gateway. VirtualNetworkGatewayIPConfiguration_STATUS[]
Optional
location Resource location. string
Optional
name Resource name. string
Optional
natRules NatRules for virtual network gateway. VirtualNetworkGatewayNatRule_STATUS[]
Optional
provisioningState The provisioning state of the virtual network gateway resource. ProvisioningState_STATUS
Optional
resiliencyModel Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed VirtualNetworkGatewayPropertiesFormat_ResiliencyModel_STATUS
Optional
resourceGuid The resource GUID property of the virtual network gateway resource. string
Optional
sku The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. VirtualNetworkGatewaySku_STATUS
Optional
tags Resource tags. map[string]string
Optional
type Resource type. string
Optional
virtualNetworkGatewayPolicyGroups The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway. VirtualNetworkGatewayPolicyGroup_STATUS[]
Optional
vNetExtendedLocationResourceId Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. string
Optional
vpnClientConfiguration The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations. VpnClientConfiguration_STATUS
Optional
vpnGatewayGeneration The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_STATUS
Optional
vpnType The type of this virtual network gateway. VirtualNetworkGatewayPropertiesFormat_VpnType_STATUS
Optional

VirtualNetworksSubnet_Spec

Used by: VirtualNetworksSubnet.

Property Description Type
addressPrefix The address prefix for the subnet. string
Optional
addressPrefixes List of address prefixes for the subnet. string[]
Optional
applicationGatewayIPConfigurations Application gateway IP configurations of virtual network resource. ApplicationGatewayIPConfiguration_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
defaultOutboundAccess Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet. bool
Optional
delegations An array of references to the delegations on the subnet. Delegation[]
Optional
ipAllocations Array of IpAllocation which reference this subnet. SubResource[]
Optional
natGateway Nat gateway associated with this subnet. SubResource
Optional
networkSecurityGroup The reference to the NetworkSecurityGroup resource. NetworkSecurityGroupSpec_VirtualNetworks_Subnet_SubResourceEmbedded
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure VirtualNetworksSubnetOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/VirtualNetwork resource genruntime.KnownResourceReference
Required
privateEndpointNetworkPolicies Enable or Disable apply network policies on private end point in the subnet. SubnetPropertiesFormat_PrivateEndpointNetworkPolicies
Optional
privateLinkServiceNetworkPolicies Enable or Disable apply network policies on private link service in the subnet. SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies
Optional
routeTable The reference to the RouteTable resource. RouteTableSpec_VirtualNetworks_Subnet_SubResourceEmbedded
Optional
serviceEndpointPolicies An array of service endpoint policies. ServiceEndpointPolicySpec_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
serviceEndpoints An array of service endpoints. ServiceEndpointPropertiesFormat[]
Optional
sharingScope Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. SubnetPropertiesFormat_SharingScope
Optional

VirtualNetworksSubnet_STATUS

Used by: VirtualNetworksSubnet.

Property Description Type
addressPrefix The address prefix for the subnet. string
Optional
addressPrefixes List of address prefixes for the subnet. string[]
Optional
applicationGatewayIPConfigurations Application gateway IP configurations of virtual network resource. ApplicationGatewayIPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
defaultOutboundAccess Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet. bool
Optional
delegations An array of references to the delegations on the subnet. Delegation_STATUS[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
ipAllocations Array of IpAllocation which reference this subnet. SubResource_STATUS[]
Optional
ipConfigurationProfiles Array of IP configuration profiles which reference this subnet. IPConfigurationProfile_STATUS[]
Optional
ipConfigurations An array of references to the network interface IP configurations using subnet. This field is not included if there are more than 2000 entries. IPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
natGateway Nat gateway associated with this subnet. SubResource_STATUS
Optional
networkSecurityGroup The reference to the NetworkSecurityGroup resource. NetworkSecurityGroup_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded
Optional
privateEndpointNetworkPolicies Enable or Disable apply network policies on private end point in the subnet. SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_STATUS
Optional
privateEndpoints An array of references to private endpoints. PrivateEndpoint_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
privateLinkServiceNetworkPolicies Enable or Disable apply network policies on private link service in the subnet. SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_STATUS
Optional
provisioningState The provisioning state of the subnet resource. ProvisioningState_STATUS
Optional
purpose A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. string
Optional
resourceNavigationLinks An array of references to the external resources using subnet. ResourceNavigationLink_STATUS[]
Optional
routeTable The reference to the RouteTable resource. RouteTable_STATUS_SubResourceEmbedded
Optional
serviceAssociationLinks An array of references to services injecting into this subnet. ServiceAssociationLink_STATUS[]
Optional
serviceEndpointPolicies An array of service endpoint policies. ServiceEndpointPolicy_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded[]
Optional
serviceEndpoints An array of service endpoints. ServiceEndpointPropertiesFormat_STATUS[]
Optional
sharingScope Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. SubnetPropertiesFormat_SharingScope_STATUS
Optional
type Resource type. string
Optional

VirtualNetworksVirtualNetworkPeering_Spec

Used by: VirtualNetworksVirtualNetworkPeering.

Property Description Type
allowForwardedTraffic Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. bool
Optional
allowGatewayTransit If gateway links can be used in remote virtual networking to link to this virtual network. bool
Optional
allowVirtualNetworkAccess Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. bool
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
doNotVerifyRemoteGateways If we need to verify the provisioning state of the remote gateway. bool
Optional
enableOnlyIPv6Peering Whether only Ipv6 address space is peered for subnet peering. bool
Optional
localAddressSpace The local address space of the local virtual network that is peered. AddressSpace
Optional
localSubnetNames List of local subnet names that are subnet peered with remote virtual network. string[]
Optional
localVirtualNetworkAddressSpace The current local address space of the local virtual network that is peered. AddressSpace
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure VirtualNetworksVirtualNetworkPeeringOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/VirtualNetwork resource genruntime.KnownResourceReference
Required
peerCompleteVnets Whether complete virtual network address space is peered. bool
Optional
peeringState The status of the virtual network peering. VirtualNetworkPeeringPropertiesFormat_PeeringState
Optional
peeringSyncLevel The peering sync status of the virtual network peering. VirtualNetworkPeeringPropertiesFormat_PeeringSyncLevel
Optional
remoteAddressSpace The reference to the address space peered with the remote virtual network. AddressSpace
Optional
remoteBgpCommunities The reference to the remote virtual network’s Bgp Communities. VirtualNetworkBgpCommunities
Optional
remoteSubnetNames List of remote subnet names from remote virtual network that are subnet peered. string[]
Optional
remoteVirtualNetwork The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). SubResource
Optional
remoteVirtualNetworkAddressSpace The reference to the current address space of the remote virtual network. AddressSpace
Optional
useRemoteGateways If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. bool
Optional

VirtualNetworksVirtualNetworkPeering_STATUS

Used by: VirtualNetworksVirtualNetworkPeering.

Property Description Type
allowForwardedTraffic Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. bool
Optional
allowGatewayTransit If gateway links can be used in remote virtual networking to link to this virtual network. bool
Optional
allowVirtualNetworkAccess Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. bool
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
doNotVerifyRemoteGateways If we need to verify the provisioning state of the remote gateway. bool
Optional
enableOnlyIPv6Peering Whether only Ipv6 address space is peered for subnet peering. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
localAddressSpace The local address space of the local virtual network that is peered. AddressSpace_STATUS
Optional
localSubnetNames List of local subnet names that are subnet peered with remote virtual network. string[]
Optional
localVirtualNetworkAddressSpace The current local address space of the local virtual network that is peered. AddressSpace_STATUS
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
peerCompleteVnets Whether complete virtual network address space is peered. bool
Optional
peeringState The status of the virtual network peering. VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS
Optional
peeringSyncLevel The peering sync status of the virtual network peering. VirtualNetworkPeeringPropertiesFormat_PeeringSyncLevel_STATUS
Optional
provisioningState The provisioning state of the virtual network peering resource. ProvisioningState_STATUS
Optional
remoteAddressSpace The reference to the address space peered with the remote virtual network. AddressSpace_STATUS
Optional
remoteBgpCommunities The reference to the remote virtual network’s Bgp Communities. VirtualNetworkBgpCommunities_STATUS
Optional
remoteSubnetNames List of remote subnet names from remote virtual network that are subnet peered. string[]
Optional
remoteVirtualNetwork The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). SubResource_STATUS
Optional
remoteVirtualNetworkAddressSpace The reference to the current address space of the remote virtual network. AddressSpace_STATUS
Optional
remoteVirtualNetworkEncryption The reference to the remote virtual network’s encryption VirtualNetworkEncryption_STATUS
Optional
resourceGuid The resourceGuid property of the Virtual Network peering resource. string
Optional
type Resource type. string
Optional
useRemoteGateways If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. bool
Optional

AddressSpace

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

Used by: VirtualNetwork_Spec, VirtualNetworkGateway_Spec, VirtualNetworksVirtualNetworkPeering_Spec, VirtualNetworksVirtualNetworkPeering_Spec, VirtualNetworksVirtualNetworkPeering_Spec, VirtualNetworksVirtualNetworkPeering_Spec, and VpnClientConfiguration.

Property Description Type
addressPrefixes A list of address blocks reserved for this virtual network in CIDR notation. string[]
Optional

AddressSpace_STATUS

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

Used by: VirtualNetwork_STATUS, VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded, VirtualNetworksVirtualNetworkPeering_STATUS, VirtualNetworksVirtualNetworkPeering_STATUS, VirtualNetworksVirtualNetworkPeering_STATUS, VirtualNetworksVirtualNetworkPeering_STATUS, and VpnClientConfiguration_STATUS.

Property Description Type
addressPrefixes A list of address blocks reserved for this virtual network in CIDR notation. string[]
Optional

ApplicationGatewayIPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded

IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
id Resource ID. string
Optional

ApplicationGatewayIPConfiguration_VirtualNetworks_Subnet_SubResourceEmbedded

IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.

Used by: VirtualNetworksSubnet_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

ApplicationSecurityGroup_STATUS_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded

An application security group in a resource group.

Used by: NetworkSecurityGroupsSecurityRule_STATUS, and NetworkSecurityGroupsSecurityRule_STATUS.

Property Description Type
id Resource ID. string
Optional

ApplicationSecurityGroup_STATUS_PrivateEndpoint_SubResourceEmbedded

An application security group in a resource group.

Used by: PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

ApplicationSecurityGroupSpec_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded

An application security group in a resource group.

Used by: NetworkSecurityGroupsSecurityRule_Spec, and NetworkSecurityGroupsSecurityRule_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

ApplicationSecurityGroupSpec_PrivateEndpoint_SubResourceEmbedded

An application security group in a resource group.

Used by: PrivateEndpoint_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

BackendAddressPool_LoadBalancer_SubResourceEmbedded

Pool of backend IP addresses.

Used by: LoadBalancer_Spec.

Property Description Type
drainPeriodInSeconds Amount of seconds Load Balancer waits for before sending RESET to client and backend address. int
Optional
loadBalancerBackendAddresses An array of backend addresses. LoadBalancerBackendAddress[]
Optional
location The location of the backend address pool. string
Optional
name The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource. string
Optional
syncMode Backend address synchronous mode for the backend pool BackendAddressPoolPropertiesFormat_SyncMode
Optional
tunnelInterfaces An array of gateway load balancer tunnel interfaces. GatewayLoadBalancerTunnelInterface[]
Optional
virtualNetwork A reference to a virtual network. SubResource
Optional

BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded

Pool of backend IP addresses.

Used by: LoadBalancer_STATUS.

Property Description Type
backendIPConfigurations An array of references to IP addresses defined in network interfaces. NetworkInterfaceIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded[]
Optional
drainPeriodInSeconds Amount of seconds Load Balancer waits for before sending RESET to client and backend address. int
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
inboundNatRules An array of references to inbound NAT rules that use this backend address pool. SubResource_STATUS[]
Optional
loadBalancerBackendAddresses An array of backend addresses. LoadBalancerBackendAddress_STATUS[]
Optional
loadBalancingRules An array of references to load balancing rules that use this backend address pool. SubResource_STATUS[]
Optional
location The location of the backend address pool. string
Optional
name The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource. string
Optional
outboundRule A reference to an outbound rule that uses this backend address pool. SubResource_STATUS
Optional
outboundRules An array of references to outbound rules that use this backend address pool. SubResource_STATUS[]
Optional
provisioningState The provisioning state of the backend address pool resource. ProvisioningState_STATUS
Optional
syncMode Backend address synchronous mode for the backend pool BackendAddressPoolPropertiesFormat_SyncMode_STATUS
Optional
tunnelInterfaces An array of gateway load balancer tunnel interfaces. GatewayLoadBalancerTunnelInterface_STATUS[]
Optional
type Type of the resource. string
Optional
virtualNetwork A reference to a virtual network. SubResource_STATUS
Optional

BastionHostIPConfiguration

IP configuration of an Bastion Host.

Used by: BastionHost_Spec.

Property Description Type
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
privateIPAllocationMethod Private IP allocation method. IPAllocationMethod
Optional
publicIPAddress Reference of the PublicIP resource. SubResource
Required
subnet Reference of the subnet resource. SubResource
Required

BastionHostIPConfiguration_STATUS

IP configuration of an Bastion Host.

Used by: BastionHost_STATUS.

Property Description Type
id Resource ID. string
Optional

BastionHostOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: BastionHost_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

BastionHostPropertiesFormat_NetworkAcls

Used by: BastionHost_Spec.

Property Description Type
ipRules Sets the IP ACL rules for Developer Bastion Host. IPRule[]
Optional

BastionHostPropertiesFormat_NetworkAcls_STATUS

Used by: BastionHost_STATUS.

Property Description Type
ipRules Sets the IP ACL rules for Developer Bastion Host. IPRule_STATUS[]
Optional

BgpSettings

BGP settings details.

Used by: VirtualNetworkGateway_Spec.

Property Description Type
asn The BGP speaker’s ASN. uint32
Optional
bgpPeeringAddress The BGP peering address and BGP identifier of this BGP speaker. string
Optional
bgpPeeringAddresses BGP peering address with IP configuration ID for virtual network gateway. IPConfigurationBgpPeeringAddress[]
Optional
peerWeight The weight added to routes learned from this BGP speaker. int
Optional

BgpSettings_STATUS

BGP settings details.

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Property Description Type
asn The BGP speaker’s ASN. uint32
Optional
bgpPeeringAddress The BGP peering address and BGP identifier of this BGP speaker. string
Optional
bgpPeeringAddresses BGP peering address with IP configuration ID for virtual network gateway. IPConfigurationBgpPeeringAddress_STATUS[]
Optional
peerWeight The weight added to routes learned from this BGP speaker. int
Optional

CustomDnsConfigPropertiesFormat_STATUS

Contains custom Dns resolution configuration from customer.

Used by: PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded.

Property Description Type
fqdn Fqdn that resolves to private endpoint ip address. string
Optional
ipAddresses A list of private ip addresses of the private endpoint. string[]
Optional

DdosSettings

Contains the DDoS protection settings of the public IP.

Used by: PublicIPAddress_Spec.

Property Description Type
ddosProtectionPlan The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled SubResource
Optional
protectionMode The DDoS protection mode of the public IP DdosSettings_ProtectionMode
Optional

DdosSettings_STATUS

Contains the DDoS protection settings of the public IP.

Used by: PublicIPAddress_STATUS.

Property Description Type
ddosProtectionPlan The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled SubResource_STATUS
Optional
protectionMode The DDoS protection mode of the public IP DdosSettings_ProtectionMode_STATUS
Optional

Delegation

Details the service to which the subnet is delegated.

Used by: VirtualNetworksSubnet_Spec.

Property Description Type
name The name of the resource that is unique within a subnet. This name can be used to access the resource. string
Optional
serviceName The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). string
Optional

Delegation_STATUS

Details the service to which the subnet is delegated.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
actions The actions permitted to the service upon delegation. string[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
name The name of the resource that is unique within a subnet. This name can be used to access the resource. string
Optional
provisioningState The provisioning state of the service delegation resource. ProvisioningState_STATUS
Optional
serviceName The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). string
Optional
type Resource type. string
Optional

DhcpOptions

DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.

Used by: VirtualNetwork_Spec.

Property Description Type
dnsServers The list of DNS servers IP addresses. string[]
Optional

DhcpOptions_STATUS

DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.

Used by: VirtualNetwork_STATUS.

Property Description Type
dnsServers The list of DNS servers IP addresses. string[]
Optional

ExtendedLocation

ExtendedLocation complex type.

Used by: LoadBalancer_Spec, NetworkInterface_Spec, PrivateEndpoint_Spec, PrivateLinkService_Spec, PublicIPAddress_Spec, PublicIPPrefix_Spec, VirtualNetwork_Spec, and VirtualNetworkGateway_Spec.

Property Description Type
name The name of the extended location. string
Optional
type The type of the extended location. ExtendedLocationType
Optional

ExtendedLocation_STATUS

ExtendedLocation complex type.

Used by: LoadBalancer_STATUS, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded, PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded, PublicIPAddress_STATUS, PublicIPPrefix_STATUS, VirtualNetwork_STATUS, and VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Property Description Type
name The name of the extended location. string
Optional
type The type of the extended location. ExtendedLocationType_STATUS
Optional

FlowLog_STATUS_SubResourceEmbedded

A flow log resource.

Used by: VirtualNetwork_STATUS.

Property Description Type
id Resource ID. string
Optional

FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded

Frontend IP address of the load balancer.

Used by: LoadBalancer_Spec.

Property Description Type
gatewayLoadBalancer The reference to gateway load balancer frontend IP. SubResource
Optional
name The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. string
Optional
privateIPAddress The private IP address of the IP configuration. string
Optional
privateIPAddressVersion Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. IPVersion
Optional
privateIPAllocationMethod The Private IP allocation method. IPAllocationMethod
Optional
publicIPAddress The reference to the Public IP resource. PublicIPAddressSpec_LoadBalancer_SubResourceEmbedded
Optional
publicIPPrefix The reference to the Public IP Prefix resource. SubResource
Optional
subnet The reference to the subnet resource. Subnet_LoadBalancer_SubResourceEmbedded
Optional
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]
Optional

FrontendIPConfiguration_PrivateLinkService_SubResourceEmbedded

Frontend IP address of the load balancer.

Used by: PrivateLinkService_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded

Frontend IP address of the load balancer.

Used by: LoadBalancer_STATUS.

Property Description Type
etag A unique read-only string that changes whenever the resource is updated. string
Optional
gatewayLoadBalancer The reference to gateway load balancer frontend IP. SubResource_STATUS
Optional
id Resource ID. string
Optional
inboundNatPools An array of references to inbound pools that use this frontend IP. SubResource_STATUS[]
Optional
inboundNatRules An array of references to inbound rules that use this frontend IP. SubResource_STATUS[]
Optional
loadBalancingRules An array of references to load balancing rules that use this frontend IP. SubResource_STATUS[]
Optional
name The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. string
Optional
outboundRules An array of references to outbound rules that use this frontend IP. SubResource_STATUS[]
Optional
privateIPAddress The private IP address of the IP configuration. string
Optional
privateIPAddressVersion Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. IPVersion_STATUS
Optional
privateIPAllocationMethod The Private IP allocation method. IPAllocationMethod_STATUS
Optional
provisioningState The provisioning state of the frontend IP configuration resource. ProvisioningState_STATUS
Optional
publicIPAddress The reference to the Public IP resource. PublicIPAddress_STATUS_LoadBalancer_SubResourceEmbedded
Optional
publicIPPrefix The reference to the Public IP Prefix resource. SubResource_STATUS
Optional
subnet The reference to the subnet resource. Subnet_STATUS_LoadBalancer_SubResourceEmbedded
Optional
type Type of the resource. string
Optional
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]
Optional

FrontendIPConfiguration_STATUS_PrivateLinkService_SubResourceEmbedded

Frontend IP address of the load balancer.

Used by: PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

InboundNatPool

Inbound NAT pool of the load balancer.

Used by: LoadBalancer_Spec.

Property Description Type
backendPort The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. int
Required
enableFloatingIP Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint. bool
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
frontendIPConfiguration A reference to frontend IP addresses. SubResource
Optional
frontendPortRangeEnd The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535. int
Required
frontendPortRangeStart The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534. int
Required
idleTimeoutInMinutes The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. int
Optional
name The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource. string
Optional
protocol The reference to the transport protocol used by the inbound NAT pool. TransportProtocol
Required

InboundNatPool_STATUS

Inbound NAT pool of the load balancer.

Used by: LoadBalancer_STATUS.

Property Description Type
backendPort The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. int
Optional
enableFloatingIP Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint. bool
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
frontendIPConfiguration A reference to frontend IP addresses. SubResource_STATUS
Optional
frontendPortRangeEnd The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535. int
Optional
frontendPortRangeStart The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534. int
Optional
id Resource ID. string
Optional
idleTimeoutInMinutes The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. int
Optional
name The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource. string
Optional
protocol The reference to the transport protocol used by the inbound NAT pool. TransportProtocol_STATUS
Optional
provisioningState The provisioning state of the inbound NAT pool resource. ProvisioningState_STATUS
Optional
type Type of the resource. string
Optional

InboundNatRule_LoadBalancer_SubResourceEmbedded

Inbound NAT rule of the load balancer.

Used by: LoadBalancer_Spec.

Property Description Type
backendAddressPool A reference to backendAddressPool resource. SubResource
Optional
backendPort The port used for the internal endpoint. Acceptable values range from 1 to 65535. int
Optional
enableFloatingIP Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint. bool
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
frontendIPConfiguration A reference to frontend IP addresses. SubResource
Optional
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeEnd The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeStart The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
idleTimeoutInMinutes The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. int
Optional
name The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource. string
Optional
protocol The reference to the transport protocol used by the load balancing rule. TransportProtocol
Optional

InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded

Inbound NAT rule of the load balancer.

Used by: LoadBalancer_STATUS.

Property Description Type
backendAddressPool A reference to backendAddressPool resource. SubResource_STATUS
Optional
backendIPConfiguration A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP. NetworkInterfaceIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded
Optional
backendPort The port used for the internal endpoint. Acceptable values range from 1 to 65535. int
Optional
enableFloatingIP Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint. bool
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
frontendIPConfiguration A reference to frontend IP addresses. SubResource_STATUS
Optional
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeEnd The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
frontendPortRangeStart The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. int
Optional
id Resource ID. string
Optional
idleTimeoutInMinutes The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. int
Optional
name The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource. string
Optional
protocol The reference to the transport protocol used by the load balancing rule. TransportProtocol_STATUS
Optional
provisioningState The provisioning state of the inbound NAT rule resource. ProvisioningState_STATUS
Optional
type Type of the resource. string
Optional

IPAllocationMethod

IP address allocation method.

Used by: BastionHostIPConfiguration, FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded, PrivateLinkServiceIpConfiguration, PublicIPAddress_Spec, and VirtualNetworkGatewayIPConfiguration.

Value Description
“Dynamic”
“Static”

IPAllocationMethod_STATUS

IP address allocation method.

Used by: FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, PrivateLinkServiceIpConfiguration_STATUS, PublicIPAddress_STATUS, and VirtualNetworkGatewayIPConfiguration_STATUS.

Value Description
“Dynamic”
“Static”

IPConfiguration_STATUS_PublicIPAddress_SubResourceEmbedded

IP configuration.

Used by: PublicIPAddress_STATUS.

Property Description Type
id Resource ID. string
Optional

IPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded

IP configuration.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
id Resource ID. string
Optional

IPConfigurationProfile_STATUS

IP configuration profile child resource.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
id Resource ID. string
Optional

IpTag

Contains the IpTag associated with the object.

Used by: PublicIPAddress_Spec, and PublicIPPrefix_Spec.

Property Description Type
ipTagType The IP tag type. Example: FirstPartyUsage. string
Optional
tag The value of the IP tag associated with the public IP. Example: SQL. string
Optional

IpTag_STATUS

Contains the IpTag associated with the object.

Used by: PublicIPAddress_STATUS, and PublicIPPrefix_STATUS.

Property Description Type
ipTagType The IP tag type. Example: FirstPartyUsage. string
Optional
tag The value of the IP tag associated with the public IP. Example: SQL. string
Optional

IPVersion

IP address version.

Used by: FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded, PrivateLinkServiceIpConfiguration, PublicIPAddress_Spec, and PublicIPPrefix_Spec.

Value Description
“IPv4”
“IPv6”

IPVersion_STATUS

IP address version.

Used by: FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, PrivateLinkServiceIpConfiguration_STATUS, PublicIPAddress_STATUS, and PublicIPPrefix_STATUS.

Value Description
“IPv4”
“IPv6”

LoadBalancerOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: LoadBalancer_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

LoadBalancersInboundNatRuleOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: LoadBalancersInboundNatRule_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

LoadBalancerSku

SKU of a load balancer.

Used by: LoadBalancer_Spec.

Property Description Type
name Name of a load balancer SKU. LoadBalancerSku_Name
Optional
tier Tier of a load balancer SKU. LoadBalancerSku_Tier
Optional

LoadBalancerSku_STATUS

SKU of a load balancer.

Used by: LoadBalancer_STATUS.

Property Description Type
name Name of a load balancer SKU. LoadBalancerSku_Name_STATUS
Optional
tier Tier of a load balancer SKU. LoadBalancerSku_Tier_STATUS
Optional

LoadBalancingRule

A load balancing rule for a load balancer.

Used by: LoadBalancer_Spec.

Property Description Type
backendAddressPool A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. SubResource
Optional
backendAddressPools An array of references to pool of DIPs. SubResource[]
Optional
backendPort The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables “Any Port”. int
Optional
disableOutboundSnat Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. bool
Optional
enableFloatingIP Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint. bool
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
frontendIPConfiguration A reference to frontend IP addresses. SubResource
Optional
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables “Any Port”. int
Required
idleTimeoutInMinutes The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. int
Optional
loadDistribution The load distribution policy for this rule. LoadBalancingRulePropertiesFormat_LoadDistribution
Optional
name The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource. string
Optional
probe The reference to the load balancer probe used by the load balancing rule. SubResource
Optional
protocol The reference to the transport protocol used by the load balancing rule. TransportProtocol
Required

LoadBalancingRule_STATUS

A load balancing rule for a load balancer.

Used by: LoadBalancer_STATUS.

Property Description Type
backendAddressPool A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. SubResource_STATUS
Optional
backendAddressPools An array of references to pool of DIPs. SubResource_STATUS[]
Optional
backendPort The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables “Any Port”. int
Optional
disableOutboundSnat Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. bool
Optional
enableFloatingIP Configures a virtual machine’s endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can’t be changed after you create the endpoint. bool
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
frontendIPConfiguration A reference to frontend IP addresses. SubResource_STATUS
Optional
frontendPort The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables “Any Port”. int
Optional
id Resource ID. string
Optional
idleTimeoutInMinutes The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. int
Optional
loadDistribution The load distribution policy for this rule. LoadBalancingRulePropertiesFormat_LoadDistribution_STATUS
Optional
name The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource. string
Optional
probe The reference to the load balancer probe used by the load balancing rule. SubResource_STATUS
Optional
protocol The reference to the transport protocol used by the load balancing rule. TransportProtocol_STATUS
Optional
provisioningState The provisioning state of the load balancing rule resource. ProvisioningState_STATUS
Optional
type Type of the resource. string
Optional

ManagedServiceIdentity

Identity for the resource.

Used by: VirtualNetworkGateway_Spec.

Property Description Type
type The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine. ManagedServiceIdentity_Type
Optional
userAssignedIdentities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. UserAssignedIdentityDetails[]
Optional

ManagedServiceIdentity_STATUS

Identity for the resource.

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Property Description Type
principalId The principal id of the system assigned identity. This property will only be provided for a system assigned identity. string
Optional
tenantId The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. string
Optional
type The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine. ManagedServiceIdentity_Type_STATUS
Optional
userAssignedIdentities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. map[string]ManagedServiceIdentity_UserAssignedIdentities_STATUS
Optional

NatGateway_STATUS_PublicIPAddress_SubResourceEmbedded

Nat Gateway resource.

Used by: PublicIPAddress_STATUS.

Property Description Type
id Resource ID. string
Optional

NatGateway_STATUS_PublicIPPrefix_SubResourceEmbedded

Nat Gateway resource.

Used by: PublicIPPrefix_STATUS.

Property Description Type
id Resource ID. string
Optional

NatGatewayOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: NatGateway_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

NatGatewaySku

SKU of nat gateway.

Used by: NatGateway_Spec.

Property Description Type
name Name of Nat Gateway SKU. NatGatewaySku_Name
Optional

NatGatewaySku_STATUS

SKU of nat gateway.

Used by: NatGateway_STATUS.

Property Description Type
name Name of Nat Gateway SKU. NatGatewaySku_Name_STATUS
Optional

NatGatewaySpec_PublicIPAddress_SubResourceEmbedded

Nat Gateway resource.

Used by: PublicIPAddress_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

NatGatewaySpec_PublicIPPrefix_SubResourceEmbedded

Nat Gateway resource.

Used by: PublicIPPrefix_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

NetworkInterface_STATUS_NetworkSecurityGroup_SubResourceEmbedded

A network interface in a resource group.

Used by: NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

NetworkInterface_STATUS_PrivateEndpoint_SubResourceEmbedded

A network interface in a resource group.

Used by: PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

NetworkInterface_STATUS_PrivateLinkService_SubResourceEmbedded

A network interface in a resource group.

Used by: PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

NetworkInterfaceDnsSettings

DNS settings of a network interface.

Used by: NetworkInterface_Spec.

Property Description Type
dnsServers List of DNS servers IP addresses. Use ‘AzureProvidedDNS’ to switch to azure provided DNS resolution. ‘AzureProvidedDNS’ value cannot be combined with other IPs, it must be the only value in dnsServers collection. string[]
Optional
internalDnsNameLabel Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. string
Optional

NetworkInterfaceDnsSettings_STATUS

DNS settings of a network interface.

Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
appliedDnsServers If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. string[]
Optional
dnsServers List of DNS servers IP addresses. Use ‘AzureProvidedDNS’ to switch to azure provided DNS resolution. ‘AzureProvidedDNS’ value cannot be combined with other IPs, it must be the only value in dnsServers collection. string[]
Optional
internalDnsNameLabel Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. string
Optional
internalDomainNameSuffix Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. string
Optional
internalFqdn Fully qualified DNS name supporting internal communications between VMs in the same virtual network. string
Optional

NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded

IPConfiguration in a network interface.

Used by: NetworkInterface_Spec.

Property Description Type
applicationGatewayBackendAddressPools The reference to ApplicationGatewayBackendAddressPool resource. ApplicationGatewayBackendAddressPool_NetworkInterface_SubResourceEmbedded[]
Optional
applicationSecurityGroups Application security groups in which the IP configuration is included. ApplicationSecurityGroupSpec_NetworkInterface_SubResourceEmbedded[]
Optional
gatewayLoadBalancer The reference to gateway load balancer frontend IP. SubResource
Optional
loadBalancerBackendAddressPools The reference to LoadBalancerBackendAddressPool resource. BackendAddressPool_NetworkInterface_SubResourceEmbedded[]
Optional
loadBalancerInboundNatRules A list of references of LoadBalancerInboundNatRules. InboundNatRule_NetworkInterface_SubResourceEmbedded[]
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
primary Whether this is a primary customer address on the network interface. bool
Optional
privateIPAddress Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format
/.
string
Optional
privateIPAddressPrefixLength The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address. int
Optional
privateIPAddressVersion Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. IPVersion
Optional
privateIPAllocationMethod The private IP address allocation method. IPAllocationMethod
Optional
publicIPAddress Public IP address bound to the IP configuration. PublicIPAddressSpec_NetworkInterface_SubResourceEmbedded
Optional
subnet Subnet bound to the IP configuration. Subnet_NetworkInterface_SubResourceEmbedded
Optional
virtualNetworkTaps The reference to Virtual Network Taps. VirtualNetworkTapSpec_NetworkInterface_SubResourceEmbedded[]
Optional

NetworkInterfaceIPConfiguration_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded

IPConfiguration in a network interface.

Used by: LoadBalancersInboundNatRule_STATUS.

Property Description Type
id Resource ID. string
Optional

NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded

IPConfiguration in a network interface.

Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
applicationGatewayBackendAddressPools The reference to ApplicationGatewayBackendAddressPool resource. ApplicationGatewayBackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded[]
Optional
applicationSecurityGroups Application security groups in which the IP configuration is included. ApplicationSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded[]
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
gatewayLoadBalancer The reference to gateway load balancer frontend IP. SubResource_STATUS
Optional
id Resource ID. string
Optional
loadBalancerBackendAddressPools The reference to LoadBalancerBackendAddressPool resource. BackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded[]
Optional
loadBalancerInboundNatRules A list of references of LoadBalancerInboundNatRules. InboundNatRule_STATUS_NetworkInterface_SubResourceEmbedded[]
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
primary Whether this is a primary customer address on the network interface. bool
Optional
privateIPAddress Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format
/.
string
Optional
privateIPAddressPrefixLength The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address. int
Optional
privateIPAddressVersion Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. IPVersion_STATUS
Optional
privateIPAllocationMethod The private IP address allocation method. IPAllocationMethod_STATUS
Optional
privateLinkConnectionProperties PrivateLinkConnection properties for the network interface. NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties_STATUS
Optional
provisioningState The provisioning state of the network interface IP configuration. ProvisioningState_STATUS
Optional
publicIPAddress Public IP address bound to the IP configuration. PublicIPAddress_STATUS_NetworkInterface_SubResourceEmbedded
Optional
subnet Subnet bound to the IP configuration. Subnet_STATUS_NetworkInterface_SubResourceEmbedded
Optional
type Resource type. string
Optional
virtualNetworkTaps The reference to Virtual Network Taps. VirtualNetworkTap_STATUS_NetworkInterface_SubResourceEmbedded[]
Optional

NetworkInterfaceOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: NetworkInterface_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

NetworkInterfacePropertiesFormat_AuxiliaryMode

Used by: NetworkInterface_Spec.

Value Description
“AcceleratedConnections”
“Floating”
“MaxConnections”
“None”

NetworkInterfacePropertiesFormat_AuxiliaryMode_STATUS

Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.

Value Description
“AcceleratedConnections”
“Floating”
“MaxConnections”
“None”

NetworkInterfacePropertiesFormat_AuxiliarySku

Used by: NetworkInterface_Spec.

Value Description
“A1”
“A2”
“A4”
“A8”
“None”

NetworkInterfacePropertiesFormat_AuxiliarySku_STATUS

Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.

Value Description
“A1”
“A2”
“A4”
“A8”
“None”

NetworkInterfacePropertiesFormat_MigrationPhase_STATUS

Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.

Value Description
“Abort”
“Commit”
“Committed”
“None”
“Prepare”

NetworkInterfacePropertiesFormat_NicType

Used by: NetworkInterface_Spec.

Value Description
“Elastic”
“Standard”

NetworkInterfacePropertiesFormat_NicType_STATUS

Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.

Value Description
“Elastic”
“Standard”

NetworkInterfaceTapConfiguration_STATUS_NetworkInterface_SubResourceEmbedded

Tap configuration in a Network Interface.

Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

NetworkSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded

NetworkSecurityGroup resource.

Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

NetworkSecurityGroup_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded

NetworkSecurityGroup resource.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
id Resource ID. string
Optional

NetworkSecurityGroupOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: NetworkSecurityGroup_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

NetworkSecurityGroupSpec_NetworkInterface_SubResourceEmbedded

NetworkSecurityGroup resource.

Used by: NetworkInterface_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

NetworkSecurityGroupSpec_VirtualNetworks_Subnet_SubResourceEmbedded

NetworkSecurityGroup resource.

Used by: VirtualNetworksSubnet_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

NetworkSecurityGroupsSecurityRuleOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: NetworkSecurityGroupsSecurityRule_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

OutboundRule

Outbound rule of the load balancer.

Used by: LoadBalancer_Spec.

Property Description Type
allocatedOutboundPorts The number of outbound ports to be used for NAT. int
Optional
backendAddressPool A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. SubResource
Required
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
frontendIPConfigurations The Frontend IP addresses of the load balancer. SubResource[]
Required
idleTimeoutInMinutes The timeout for the TCP idle connection. int
Optional
name The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource. string
Optional
protocol The protocol for the outbound rule in load balancer. OutboundRulePropertiesFormat_Protocol
Required

OutboundRule_STATUS

Outbound rule of the load balancer.

Used by: LoadBalancer_STATUS.

Property Description Type
allocatedOutboundPorts The number of outbound ports to be used for NAT. int
Optional
backendAddressPool A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. SubResource_STATUS
Optional
enableTcpReset Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. bool
Optional
etag A unique read-only string that changes whenever the resource is updated. string
Optional
frontendIPConfigurations The Frontend IP addresses of the load balancer. SubResource_STATUS[]
Optional
id Resource ID. string
Optional
idleTimeoutInMinutes The timeout for the TCP idle connection. int
Optional
name The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource. string
Optional
protocol The protocol for the outbound rule in load balancer. OutboundRulePropertiesFormat_Protocol_STATUS
Optional
provisioningState The provisioning state of the outbound rule resource. ProvisioningState_STATUS
Optional
type Type of the resource. string
Optional

PrivateDnsZoneConfig

PrivateDnsZoneConfig resource.

Used by: PrivateEndpointsPrivateDnsZoneGroup_Spec.

Property Description Type
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
privateDnsZoneReference The resource id of the private dns zone. genruntime.ResourceReference
Optional

PrivateDnsZoneConfig_STATUS

PrivateDnsZoneConfig resource.

Used by: PrivateEndpointsPrivateDnsZoneGroup_STATUS.

Property Description Type
name Name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
privateDnsZoneId The resource id of the private dns zone. string
Optional
recordSets A collection of information regarding a recordSet, holding information to identify private resources. RecordSet_STATUS[]
Optional

PrivateEndpoint_STATUS_NetworkInterface_SubResourceEmbedded

Private endpoint resource.

Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

PrivateEndpoint_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded

Private endpoint resource.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
id Resource ID. string
Optional

PrivateEndpointConnection_STATUS

PrivateEndpointConnection resource.

Used by: PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

PrivateEndpointIPConfiguration

An IP Configuration of the private endpoint.

Used by: PrivateEndpoint_Spec.

Property Description Type
groupId The ID of a group obtained from the remote resource that this private endpoint should connect to. string
Optional
memberName The member name of a group obtained from the remote resource that this private endpoint should connect to. string
Optional
name The name of the resource that is unique within a resource group. string
Optional
privateIPAddress A private ip address obtained from the private endpoint’s subnet. string
Optional

PrivateEndpointIPConfiguration_STATUS

An IP Configuration of the private endpoint.

Used by: PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded.

Property Description Type
etag A unique read-only string that changes whenever the resource is updated. string
Optional
groupId The ID of a group obtained from the remote resource that this private endpoint should connect to. string
Optional
memberName The member name of a group obtained from the remote resource that this private endpoint should connect to. string
Optional
name The name of the resource that is unique within a resource group. string
Optional
privateIPAddress A private ip address obtained from the private endpoint’s subnet. string
Optional
type The resource type. string
Optional

PrivateEndpointOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: PrivateEndpoint_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
configMaps configures where to place operator written ConfigMaps. PrivateEndpointOperatorConfigMaps
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

PrivateEndpointsPrivateDnsZoneGroupOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: PrivateEndpointsPrivateDnsZoneGroup_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

PrivateEndpointVNetPolicies

Private Endpoint VNet Policies.

Used by: VirtualNetwork_Spec.

Value Description
“Basic”
“Disabled”

PrivateEndpointVNetPolicies_STATUS

Private Endpoint VNet Policies.

Used by: VirtualNetwork_STATUS.

Value Description
“Basic”
“Disabled”

PrivateLinkService_STATUS_NetworkInterface_SubResourceEmbedded

Private link service resource.

Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

PrivateLinkServiceConnection

PrivateLinkServiceConnection resource.

Used by: PrivateEndpoint_Spec, and PrivateEndpoint_Spec.

Property Description Type
groupIds The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. string[]
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
privateLinkServiceConnectionState A collection of read-only information about the state of the connection to the remote resource. PrivateLinkServiceConnectionState
Optional
privateLinkServiceReference The resource id of private link service. genruntime.ResourceReference
Optional
requestMessage A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. string
Optional

PrivateLinkServiceConnection_STATUS

PrivateLinkServiceConnection resource.

Used by: PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded, and PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded.

Property Description Type
etag A unique read-only string that changes whenever the resource is updated. string
Optional
groupIds The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. string[]
Optional
id Resource ID. string
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
privateLinkServiceConnectionState A collection of read-only information about the state of the connection to the remote resource. PrivateLinkServiceConnectionState_STATUS
Optional
privateLinkServiceId The resource id of private link service. string
Optional
provisioningState The provisioning state of the private link service connection resource. ProvisioningState_STATUS
Optional
requestMessage A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. string
Optional
type The resource type. string
Optional

PrivateLinkServiceIpConfiguration

The private link service ip configuration.

Used by: PrivateLinkService_Spec.

Property Description Type
name The name of private link service ip configuration. string
Optional
primary Whether the ip configuration is primary or not. bool
Optional
privateIPAddress The private IP address of the IP configuration. string
Optional
privateIPAddressVersion Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. IPVersion
Optional
privateIPAllocationMethod The private IP address allocation method. IPAllocationMethod
Optional
subnet The reference to the subnet resource. Subnet_PrivateLinkService_SubResourceEmbedded
Optional

PrivateLinkServiceIpConfiguration_STATUS

The private link service ip configuration.

Used by: PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded.

Property Description Type
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
name The name of private link service ip configuration. string
Optional
primary Whether the ip configuration is primary or not. bool
Optional
privateIPAddress The private IP address of the IP configuration. string
Optional
privateIPAddressVersion Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. IPVersion_STATUS
Optional
privateIPAllocationMethod The private IP address allocation method. IPAllocationMethod_STATUS
Optional
provisioningState The provisioning state of the private link service IP configuration resource. ProvisioningState_STATUS
Optional
subnet The reference to the subnet resource. Subnet_STATUS_PrivateLinkService_SubResourceEmbedded
Optional
type The resource type. string
Optional

PrivateLinkServiceOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: PrivateLinkService_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
configMaps configures where to place operator written ConfigMaps. PrivateLinkServiceOperatorConfigMaps
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

PrivateLinkServiceSpec

Private link service resource.

Used by: NetworkInterface_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

Probe

A load balancer probe.

Used by: LoadBalancer_Spec.

Property Description Type
intervalInSeconds The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5. int
Optional
name The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource. string
Optional
noHealthyBackendsBehavior Determines how new connections are handled by the load balancer when all backend instances are probed down. ProbePropertiesFormat_NoHealthyBackendsBehavior
Optional
numberOfProbes The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure. int
Optional
port The port for communicating the probe. Possible values range from 1 to 65535, inclusive. int
Required
probeThreshold The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation. int
Optional
protocol The protocol of the end point. If ‘Tcp’ is specified, a received ACK is required for the probe to be successful. If ‘Http’ or ‘Https’ is specified, a 200 OK response from the specifies URI is required for the probe to be successful. ProbePropertiesFormat_Protocol
Required
requestPath The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value. string
Optional

Probe_STATUS

A load balancer probe.

Used by: LoadBalancer_STATUS.

Property Description Type
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
intervalInSeconds The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5. int
Optional
loadBalancingRules The load balancer rules that use this probe. SubResource_STATUS[]
Optional
name The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource. string
Optional
noHealthyBackendsBehavior Determines how new connections are handled by the load balancer when all backend instances are probed down. ProbePropertiesFormat_NoHealthyBackendsBehavior_STATUS
Optional
numberOfProbes The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure. int
Optional
port The port for communicating the probe. Possible values range from 1 to 65535, inclusive. int
Optional
probeThreshold The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation. int
Optional
protocol The protocol of the end point. If ‘Tcp’ is specified, a received ACK is required for the probe to be successful. If ‘Http’ or ‘Https’ is specified, a 200 OK response from the specifies URI is required for the probe to be successful. ProbePropertiesFormat_Protocol_STATUS
Optional
provisioningState The provisioning state of the probe resource. ProvisioningState_STATUS
Optional
requestPath The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value. string
Optional
type Type of the resource. string
Optional

ProvisioningState_STATUS

The current provisioning state.

Used by: BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, BastionHost_STATUS, Delegation_STATUS, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, InboundNatPool_STATUS, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, LoadBalancer_STATUS, LoadBalancersInboundNatRule_STATUS, LoadBalancingRule_STATUS, NatGateway_STATUS, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded, NetworkSecurityGroupsSecurityRule_STATUS, OutboundRule_STATUS, PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded, PrivateEndpointsPrivateDnsZoneGroup_STATUS, PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded, PrivateLinkServiceConnection_STATUS, PrivateLinkServiceIpConfiguration_STATUS, Probe_STATUS, PublicIPAddress_STATUS, PublicIPPrefix_STATUS, RecordSet_STATUS, RouteTable_STATUS, RouteTablesRoute_STATUS, ServiceEndpointPropertiesFormat_STATUS, VirtualNetwork_STATUS, VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded, VirtualNetworkGatewayIPConfiguration_STATUS, VirtualNetworkGatewayNatRule_STATUS, VirtualNetworkGatewayPolicyGroup_STATUS, VirtualNetworksSubnet_STATUS, VirtualNetworksVirtualNetworkPeering_STATUS, VpnClientRevokedCertificate_STATUS, and VpnClientRootCertificate_STATUS.

Value Description
“Deleting”
“Failed”
“Succeeded”
“Updating”

PublicIPAddressDnsSettings

Contains FQDN of the DNS record associated with the public IP address.

Used by: PublicIPAddress_Spec.

Property Description Type
domainNameLabel The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. string
Optional
domainNameLabelScope The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. PublicIPAddressDnsSettings_DomainNameLabelScope
Optional
fqdn The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. string
Optional
reverseFqdn The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. string
Optional

PublicIPAddressDnsSettings_STATUS

Contains FQDN of the DNS record associated with the public IP address.

Used by: PublicIPAddress_STATUS.

Property Description Type
domainNameLabel The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. string
Optional
domainNameLabelScope The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. PublicIPAddressDnsSettings_DomainNameLabelScope_STATUS
Optional
fqdn The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. string
Optional
reverseFqdn The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. string
Optional

PublicIPAddressOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: PublicIPAddress_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

PublicIPAddressPropertiesFormat_DeleteOption

Used by: PublicIPAddress_Spec.

Value Description
“Delete”
“Detach”

PublicIPAddressPropertiesFormat_DeleteOption_STATUS

Used by: PublicIPAddress_STATUS.

Value Description
“Delete”
“Detach”

PublicIPAddressPropertiesFormat_MigrationPhase_STATUS

Used by: PublicIPAddress_STATUS.

Value Description
“Abort”
“Commit”
“Committed”
“None”
“Prepare”

PublicIPAddressSku

SKU of a public IP address.

Used by: PublicIPAddress_Spec.

Property Description Type
name Name of a public IP address SKU. PublicIPAddressSku_Name
Optional
tier Tier of a public IP address SKU. PublicIPAddressSku_Tier
Optional

PublicIPAddressSku_STATUS

SKU of a public IP address.

Used by: PublicIPAddress_STATUS.

Property Description Type
name Name of a public IP address SKU. PublicIPAddressSku_Name_STATUS
Optional
tier Tier of a public IP address SKU. PublicIPAddressSku_Tier_STATUS
Optional

PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded

Public IP address resource.

Used by: PublicIPAddress_Spec, and PublicIPAddress_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

PublicIPPrefixOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: PublicIPPrefix_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

PublicIPPrefixSku

SKU of a public IP prefix.

Used by: PublicIPPrefix_Spec.

Property Description Type
name Name of a public IP prefix SKU. PublicIPPrefixSku_Name
Optional
tier Tier of a public IP prefix SKU. PublicIPPrefixSku_Tier
Optional

PublicIPPrefixSku_STATUS

SKU of a public IP prefix.

Used by: PublicIPPrefix_STATUS.

Property Description Type
name Name of a public IP prefix SKU. PublicIPPrefixSku_Name_STATUS
Optional
tier Tier of a public IP prefix SKU. PublicIPPrefixSku_Tier_STATUS
Optional

ReferencedPublicIpAddress_STATUS

Reference to a public IP address.

Used by: PublicIPPrefix_STATUS.

Property Description Type
id The PublicIPAddress Reference. string
Optional

ResourceNavigationLink resource.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
id Resource navigation link identifier. string
Optional

ResourceSet

The base resource set for visibility and auto-approval.

Used by: PrivateLinkService_Spec, and PrivateLinkService_Spec.

Property Description Type
subscriptions The list of subscriptions. string[]
Optional

ResourceSet_STATUS

The base resource set for visibility and auto-approval.

Used by: PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded, and PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded.

Property Description Type
subscriptions The list of subscriptions. string[]
Optional

RouteNextHopType

The type of Azure hop the packet should be sent to.

Used by: RouteTablesRoute_Spec.

Value Description
“Internet”
“None”
“VirtualAppliance”
“VirtualNetworkGateway”
“VnetLocal”

RouteNextHopType_STATUS

The type of Azure hop the packet should be sent to.

Used by: RouteTablesRoute_STATUS.

Value Description
“Internet”
“None”
“VirtualAppliance”
“VirtualNetworkGateway”
“VnetLocal”

RouteTable_STATUS_SubResourceEmbedded

Route table resource.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
id Resource ID. string
Optional

RouteTableOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: RouteTable_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

RouteTableSpec_VirtualNetworks_Subnet_SubResourceEmbedded

Route table resource.

Used by: VirtualNetworksSubnet_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

RouteTablesRouteOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: RouteTablesRoute_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

SecurityRule_STATUS

Network security rule.

Used by: NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

SecurityRuleAccess

Whether network traffic is allowed or denied.

Used by: NetworkSecurityGroupsSecurityRule_Spec.

Value Description
“Allow”
“Deny”

SecurityRuleAccess_STATUS

Whether network traffic is allowed or denied.

Used by: NetworkSecurityGroupsSecurityRule_STATUS.

Value Description
“Allow”
“Deny”

SecurityRuleDirection

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.

Used by: NetworkSecurityGroupsSecurityRule_Spec.

Value Description
“Inbound”
“Outbound”

SecurityRuleDirection_STATUS

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.

Used by: NetworkSecurityGroupsSecurityRule_STATUS.

Value Description
“Inbound”
“Outbound”

SecurityRulePropertiesFormat_Protocol

Used by: NetworkSecurityGroupsSecurityRule_Spec.

Value Description
“Ah”
“Esp”
“Icmp”
“*”
“Tcp”
“Udp”

SecurityRulePropertiesFormat_Protocol_STATUS

Used by: NetworkSecurityGroupsSecurityRule_STATUS.

Value Description
“Ah”
“Esp”
“Icmp”
“*”
“Tcp”
“Udp”

ServiceAssociationLink resource.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
id Resource ID. string
Optional

ServiceEndpointPolicy_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded

Service End point policy resource.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
id Resource ID. string
Optional

ServiceEndpointPolicySpec_VirtualNetworks_Subnet_SubResourceEmbedded

Service End point policy resource.

Used by: VirtualNetworksSubnet_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

ServiceEndpointPropertiesFormat

The service endpoint properties.

Used by: VirtualNetworksSubnet_Spec.

Property Description Type
locations A list of locations. string[]
Optional
networkIdentifier SubResource as network identifier. SubResource
Optional
service The type of the endpoint service. string
Optional

ServiceEndpointPropertiesFormat_STATUS

The service endpoint properties.

Used by: VirtualNetworksSubnet_STATUS.

Property Description Type
locations A list of locations. string[]
Optional
networkIdentifier SubResource as network identifier. SubResource_STATUS
Optional
provisioningState The provisioning state of the service endpoint resource. ProvisioningState_STATUS
Optional
service The type of the endpoint service. string
Optional

Sku

The sku of this Bastion Host.

Used by: BastionHost_Spec.

Property Description Type
name The name of the sku of this Bastion Host. Sku_Name
Optional

Sku_STATUS

The sku of this Bastion Host.

Used by: BastionHost_STATUS.

Property Description Type
name The name of the sku of this Bastion Host. Sku_Name_STATUS
Optional

Subnet_PrivateEndpoint_SubResourceEmbedded

Subnet in a virtual network resource.

Used by: PrivateEndpoint_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

Subnet_STATUS_NetworkSecurityGroup_SubResourceEmbedded

Subnet in a virtual network resource.

Used by: NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

Subnet_STATUS_PrivateEndpoint_SubResourceEmbedded

Subnet in a virtual network resource.

Used by: PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

SubnetPropertiesFormat_PrivateEndpointNetworkPolicies

Used by: VirtualNetworksSubnet_Spec.

Value Description
“Disabled”
“Enabled”
“NetworkSecurityGroupEnabled”
“RouteTableEnabled”

SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_STATUS

Used by: VirtualNetworksSubnet_STATUS.

Value Description
“Disabled”
“Enabled”
“NetworkSecurityGroupEnabled”
“RouteTableEnabled”

SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies

Used by: VirtualNetworksSubnet_Spec.

Value Description
“Disabled”
“Enabled”

SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_STATUS

Used by: VirtualNetworksSubnet_STATUS.

Value Description
“Disabled”
“Enabled”

SubnetPropertiesFormat_SharingScope

Used by: VirtualNetworksSubnet_Spec.

Value Description
“DelegatedServices”
“Tenant”

SubnetPropertiesFormat_SharingScope_STATUS

Used by: VirtualNetworksSubnet_STATUS.

Value Description
“DelegatedServices”
“Tenant”

SubResource

Reference to another subresource.

Used by: BackendAddressPool_LoadBalancer_SubResourceEmbedded, BastionHost_Spec, BastionHostIPConfiguration, BastionHostIPConfiguration, DdosSettings, FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, InboundNatPool, InboundNatRule_LoadBalancer_SubResourceEmbedded, InboundNatRule_LoadBalancer_SubResourceEmbedded, LoadBalancerBackendAddress, LoadBalancerBackendAddress, LoadBalancerBackendAddress, LoadBalancersInboundNatRule_Spec, LoadBalancersInboundNatRule_Spec, LoadBalancingRule, LoadBalancingRule, LoadBalancingRule, LoadBalancingRule, NatGateway_Spec, NatGateway_Spec, NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded, OutboundRule, OutboundRule, PublicIPAddress_Spec, PublicIPPrefix_Spec, ServiceEndpointPropertiesFormat, VirtualNetwork_Spec, VirtualNetwork_Spec, VirtualNetworkGateway_Spec, VirtualNetworkGatewayIPConfiguration, VirtualNetworkGatewayIPConfiguration, VirtualNetworksSubnet_Spec, VirtualNetworksSubnet_Spec, and VirtualNetworksVirtualNetworkPeering_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

SubResource_STATUS

Reference to another subresource.

Used by: BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, BastionHost_STATUS, DdosSettings_STATUS, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, InboundNatPool_STATUS, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, LoadBalancerBackendAddress_STATUS, LoadBalancerBackendAddress_STATUS, LoadBalancerBackendAddress_STATUS, LoadBalancerBackendAddress_STATUS, LoadBalancersInboundNatRule_STATUS, LoadBalancersInboundNatRule_STATUS, LoadBalancingRule_STATUS, LoadBalancingRule_STATUS, LoadBalancingRule_STATUS, LoadBalancingRule_STATUS, NatGateway_STATUS, NatGateway_STATUS, NatGateway_STATUS, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, OutboundRule_STATUS, OutboundRule_STATUS, Probe_STATUS, PublicIPAddress_STATUS, PublicIPPrefix_STATUS, PublicIPPrefix_STATUS, ServiceEndpointPropertiesFormat_STATUS, VirtualNetwork_STATUS, VirtualNetwork_STATUS, VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded, VirtualNetworkGatewayIPConfiguration_STATUS, VirtualNetworkGatewayIPConfiguration_STATUS, VirtualNetworkGatewayPolicyGroup_STATUS, VirtualNetworksSubnet_STATUS, VirtualNetworksSubnet_STATUS, and VirtualNetworksVirtualNetworkPeering_STATUS.

Property Description Type
id Resource ID. string
Optional

TransportProtocol

The transport protocol for the endpoint.

Used by: InboundNatPool, InboundNatRule_LoadBalancer_SubResourceEmbedded, LoadBalancersInboundNatRule_Spec, and LoadBalancingRule.

Value Description
“All”
“Tcp”
“Udp”

TransportProtocol_STATUS

The transport protocol for the endpoint.

Used by: InboundNatPool_STATUS, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, LoadBalancersInboundNatRule_STATUS, and LoadBalancingRule_STATUS.

Value Description
“All”
“Tcp”
“Udp”

VirtualNetworkBgpCommunities

Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.

Used by: VirtualNetwork_Spec, and VirtualNetworksVirtualNetworkPeering_Spec.

Property Description Type
virtualNetworkCommunity The BGP community associated with the virtual network. string
Required

VirtualNetworkBgpCommunities_STATUS

Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.

Used by: VirtualNetwork_STATUS, and VirtualNetworksVirtualNetworkPeering_STATUS.

Property Description Type
regionalCommunity The BGP community associated with the region of the virtual network. string
Optional
virtualNetworkCommunity The BGP community associated with the virtual network. string
Optional

VirtualNetworkEncryption

Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet.

Used by: VirtualNetwork_Spec.

Property Description Type
enabled Indicates if encryption is enabled on the virtual network. bool
Required
enforcement If the encrypted VNet allows VM that does not support encryption. This field is for future support, AllowUnencrypted is the only supported value at general availability. VirtualNetworkEncryption_Enforcement
Optional

VirtualNetworkEncryption_STATUS

Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet.

Used by: VirtualNetwork_STATUS, and VirtualNetworksVirtualNetworkPeering_STATUS.

Property Description Type
enabled Indicates if encryption is enabled on the virtual network. bool
Optional
enforcement If the encrypted VNet allows VM that does not support encryption. This field is for future support, AllowUnencrypted is the only supported value at general availability. VirtualNetworkEncryption_Enforcement_STATUS
Optional

VirtualNetworkGatewayAutoScaleConfiguration

Virtual Network Gateway Autoscale Configuration details

Used by: VirtualNetworkGateway_Spec.

Property Description Type
bounds The bounds of the autoscale configuration VirtualNetworkGatewayAutoScaleBounds
Optional

VirtualNetworkGatewayAutoScaleConfiguration_STATUS

Virtual Network Gateway Autoscale Configuration details

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Property Description Type
bounds The bounds of the autoscale configuration VirtualNetworkGatewayAutoScaleBounds_STATUS
Optional

VirtualNetworkGatewayIPConfiguration

IP configuration for virtual network gateway.

Used by: VirtualNetworkGateway_Spec.

Property Description Type
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
privateIPAllocationMethod The private IP address allocation method. IPAllocationMethod
Optional
publicIPAddress The reference to the public IP resource. SubResource
Optional
subnet The reference to the subnet resource. SubResource
Optional

VirtualNetworkGatewayIPConfiguration_STATUS

IP configuration for virtual network gateway.

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Property Description Type
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
privateIPAddress Private IP Address for this gateway. string
Optional
privateIPAllocationMethod The private IP address allocation method. IPAllocationMethod_STATUS
Optional
provisioningState The provisioning state of the virtual network gateway IP configuration resource. ProvisioningState_STATUS
Optional
publicIPAddress The reference to the public IP resource. SubResource_STATUS
Optional
subnet The reference to the subnet resource. SubResource_STATUS
Optional

VirtualNetworkGatewayNatRule

VirtualNetworkGatewayNatRule Resource.

Used by: VirtualNetworkGateway_Spec.

Property Description Type
externalMappings The private IP address external mapping for NAT. VpnNatRuleMapping[]
Optional
internalMappings The private IP address internal mapping for NAT. VpnNatRuleMapping[]
Optional
ipConfigurationId The IP Configuration ID this NAT rule applies to. string
Optional
mode The Source NAT direction of a VPN NAT. VirtualNetworkGatewayNatRuleProperties_Mode
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
type The type of NAT rule for VPN NAT. VirtualNetworkGatewayNatRuleProperties_Type
Optional

VirtualNetworkGatewayNatRule_STATUS

VirtualNetworkGatewayNatRule Resource.

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Property Description Type
etag A unique read-only string that changes whenever the resource is updated. string
Optional
externalMappings The private IP address external mapping for NAT. VpnNatRuleMapping_STATUS[]
Optional
id Resource ID. string
Optional
internalMappings The private IP address internal mapping for NAT. VpnNatRuleMapping_STATUS[]
Optional
ipConfigurationId The IP Configuration ID this NAT rule applies to. string
Optional
mode The Source NAT direction of a VPN NAT. VirtualNetworkGatewayNatRuleProperties_Mode_STATUS
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
properties_type The type of NAT rule for VPN NAT. VirtualNetworkGatewayNatRuleProperties_Type_STATUS
Optional
provisioningState The provisioning state of the NAT Rule resource. ProvisioningState_STATUS
Optional
type Resource type. string
Optional

VirtualNetworkGatewayOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: VirtualNetworkGateway_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

VirtualNetworkGatewayPolicyGroup

Parameters for VirtualNetworkGatewayPolicyGroup.

Used by: VirtualNetworkGateway_Spec.

Property Description Type
isDefault Shows if this is a Default VirtualNetworkGatewayPolicyGroup or not. bool
Required
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
policyMembers Multiple PolicyMembers for VirtualNetworkGatewayPolicyGroup. VirtualNetworkGatewayPolicyGroupMember[]
Required
priority Priority for VirtualNetworkGatewayPolicyGroup. int
Required

VirtualNetworkGatewayPolicyGroup_STATUS

Parameters for VirtualNetworkGatewayPolicyGroup.

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Property Description Type
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
isDefault Shows if this is a Default VirtualNetworkGatewayPolicyGroup or not. bool
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
policyMembers Multiple PolicyMembers for VirtualNetworkGatewayPolicyGroup. VirtualNetworkGatewayPolicyGroupMember_STATUS[]
Optional
priority Priority for VirtualNetworkGatewayPolicyGroup. int
Optional
provisioningState The provisioning state of the VirtualNetworkGatewayPolicyGroup resource. ProvisioningState_STATUS
Optional
vngClientConnectionConfigurations List of references to vngClientConnectionConfigurations. SubResource_STATUS[]
Optional

VirtualNetworkGatewayPropertiesFormat_AdminState

Used by: VirtualNetworkGateway_Spec.

Value Description
“Disabled”
“Enabled”

VirtualNetworkGatewayPropertiesFormat_AdminState_STATUS

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Value Description
“Disabled”
“Enabled”

VirtualNetworkGatewayPropertiesFormat_GatewayType

Used by: VirtualNetworkGateway_Spec.

Value Description
“ExpressRoute”
“LocalGateway”
“Vpn”

VirtualNetworkGatewayPropertiesFormat_GatewayType_STATUS

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Value Description
“ExpressRoute”
“LocalGateway”
“Vpn”

VirtualNetworkGatewayPropertiesFormat_ResiliencyModel

Used by: VirtualNetworkGateway_Spec.

Value Description
“MultiHomed”
“SingleHomed”

VirtualNetworkGatewayPropertiesFormat_ResiliencyModel_STATUS

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Value Description
“MultiHomed”
“SingleHomed”

VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration

Used by: VirtualNetworkGateway_Spec.

Value Description
“Generation1”
“Generation2”
“None”

VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_STATUS

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Value Description
“Generation1”
“Generation2”
“None”

VirtualNetworkGatewayPropertiesFormat_VpnType

Used by: VirtualNetworkGateway_Spec.

Value Description
“PolicyBased”
“RouteBased”

VirtualNetworkGatewayPropertiesFormat_VpnType_STATUS

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Value Description
“PolicyBased”
“RouteBased”

VirtualNetworkGatewaySku

VirtualNetworkGatewaySku details.

Used by: VirtualNetworkGateway_Spec.

Property Description Type
name Gateway SKU name. VirtualNetworkGatewaySku_Name
Optional
tier Gateway SKU tier. VirtualNetworkGatewaySku_Tier
Optional

VirtualNetworkGatewaySku_STATUS

VirtualNetworkGatewaySku details.

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Property Description Type
capacity The capacity. int
Optional
name Gateway SKU name. VirtualNetworkGatewaySku_Name_STATUS
Optional
tier Gateway SKU tier. VirtualNetworkGatewaySku_Tier_STATUS
Optional

VirtualNetworkOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: VirtualNetwork_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

VirtualNetworkPeeringPropertiesFormat_PeeringState

Used by: VirtualNetworksVirtualNetworkPeering_Spec.

Value Description
“Connected”
“Disconnected”
“Initiated”

VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS

Used by: VirtualNetworksVirtualNetworkPeering_STATUS.

Value Description
“Connected”
“Disconnected”
“Initiated”

VirtualNetworkPeeringPropertiesFormat_PeeringSyncLevel

Used by: VirtualNetworksVirtualNetworkPeering_Spec.

Value Description
“FullyInSync”
“LocalAndRemoteNotInSync”
“LocalNotInSync”
“RemoteNotInSync”

VirtualNetworkPeeringPropertiesFormat_PeeringSyncLevel_STATUS

Used by: VirtualNetworksVirtualNetworkPeering_STATUS.

Value Description
“FullyInSync”
“LocalAndRemoteNotInSync”
“LocalNotInSync”
“RemoteNotInSync”

VirtualNetworksSubnetOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: VirtualNetworksSubnet_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

VirtualNetworksVirtualNetworkPeeringOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: VirtualNetworksVirtualNetworkPeering_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

VpnClientConfiguration

VpnClientConfiguration for P2S client.

Used by: VirtualNetworkGateway_Spec.

Property Description Type
aadAudience The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. string
Optional
aadIssuer The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. string
Optional
aadTenant The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. string
Optional
radiusServerAddress The radius server address property of the VirtualNetworkGateway resource for vpn client connection. string
Optional
radiusServers The radiusServers property for multiple radius server configuration. RadiusServer[]
Optional
radiusServerSecret The radius secret property of the VirtualNetworkGateway resource for vpn client connection. string
Optional
vngClientConnectionConfigurations per ip address pool connection policy for virtual network gateway P2S client. VngClientConnectionConfiguration[]
Optional
vpnAuthenticationTypes VPN authentication types for the virtual network gateway.. VpnClientConfiguration_VpnAuthenticationTypes[]
Optional
vpnClientAddressPool The reference to the address space resource which represents Address space for P2S VpnClient. AddressSpace
Optional
vpnClientIpsecPolicies VpnClientIpsecPolicies for virtual network gateway P2S client. IpsecPolicy[]
Optional
vpnClientProtocols VpnClientProtocols for Virtual network gateway. VpnClientConfiguration_VpnClientProtocols[]
Optional
vpnClientRevokedCertificates VpnClientRevokedCertificate for Virtual network gateway. VpnClientRevokedCertificate[]
Optional
vpnClientRootCertificates VpnClientRootCertificate for virtual network gateway. VpnClientRootCertificate[]
Optional

VpnClientConfiguration_STATUS

VpnClientConfiguration for P2S client.

Used by: VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded.

Property Description Type
aadAudience The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. string
Optional
aadIssuer The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. string
Optional
aadTenant The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. string
Optional
radiusServerAddress The radius server address property of the VirtualNetworkGateway resource for vpn client connection. string
Optional
radiusServers The radiusServers property for multiple radius server configuration. RadiusServer_STATUS[]
Optional
radiusServerSecret The radius secret property of the VirtualNetworkGateway resource for vpn client connection. string
Optional
vngClientConnectionConfigurations per ip address pool connection policy for virtual network gateway P2S client. VngClientConnectionConfiguration_STATUS[]
Optional
vpnAuthenticationTypes VPN authentication types for the virtual network gateway.. VpnClientConfiguration_VpnAuthenticationTypes_STATUS[]
Optional
vpnClientAddressPool The reference to the address space resource which represents Address space for P2S VpnClient. AddressSpace_STATUS
Optional
vpnClientIpsecPolicies VpnClientIpsecPolicies for virtual network gateway P2S client. IpsecPolicy_STATUS[]
Optional
vpnClientProtocols VpnClientProtocols for Virtual network gateway. VpnClientConfiguration_VpnClientProtocols_STATUS[]
Optional
vpnClientRevokedCertificates VpnClientRevokedCertificate for Virtual network gateway. VpnClientRevokedCertificate_STATUS[]
Optional
vpnClientRootCertificates VpnClientRootCertificate for virtual network gateway. VpnClientRootCertificate_STATUS[]
Optional

ApplicationGatewayBackendAddressPool_NetworkInterface_SubResourceEmbedded

Backend Address Pool of an application gateway.

Used by: NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

ApplicationGatewayBackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded

Backend Address Pool of an application gateway.

Used by: NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

ApplicationSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded

An application security group in a resource group.

Used by: NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

ApplicationSecurityGroupSpec_NetworkInterface_SubResourceEmbedded

An application security group in a resource group.

Used by: NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

BackendAddressPool_NetworkInterface_SubResourceEmbedded

Pool of backend IP addresses.

Used by: NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

BackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded

Pool of backend IP addresses.

Used by: NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

BackendAddressPoolPropertiesFormat_SyncMode

Used by: BackendAddressPool_LoadBalancer_SubResourceEmbedded.

Value Description
“Automatic”
“Manual”

BackendAddressPoolPropertiesFormat_SyncMode_STATUS

Used by: BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded.

Value Description
“Automatic”
“Manual”

DdosSettings_ProtectionMode

Used by: DdosSettings.

Value Description
“Disabled”
“Enabled”
“VirtualNetworkInherited”

DdosSettings_ProtectionMode_STATUS

Used by: DdosSettings_STATUS.

Value Description
“Disabled”
“Enabled”
“VirtualNetworkInherited”

ExtendedLocationType

The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources.

Used by: ExtendedLocation.

Value Description
“EdgeZone”

ExtendedLocationType_STATUS

The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources.

Used by: ExtendedLocation_STATUS.

Value Description
“EdgeZone”

GatewayLoadBalancerTunnelInterface

Gateway load balancer tunnel interface of a load balancer backend address pool.

Used by: BackendAddressPool_LoadBalancer_SubResourceEmbedded.

Property Description Type
identifier Identifier of gateway load balancer tunnel interface. int
Optional
port Port of gateway load balancer tunnel interface. int
Optional
protocol Protocol of gateway load balancer tunnel interface. GatewayLoadBalancerTunnelInterface_Protocol
Optional
type Traffic type of gateway load balancer tunnel interface. GatewayLoadBalancerTunnelInterface_Type
Optional

GatewayLoadBalancerTunnelInterface_STATUS

Gateway load balancer tunnel interface of a load balancer backend address pool.

Used by: BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded.

Property Description Type
identifier Identifier of gateway load balancer tunnel interface. int
Optional
port Port of gateway load balancer tunnel interface. int
Optional
protocol Protocol of gateway load balancer tunnel interface. GatewayLoadBalancerTunnelInterface_Protocol_STATUS
Optional
type Traffic type of gateway load balancer tunnel interface. GatewayLoadBalancerTunnelInterface_Type_STATUS
Optional

InboundNatRule_NetworkInterface_SubResourceEmbedded

Inbound NAT rule of the load balancer.

Used by: NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

InboundNatRule_STATUS_NetworkInterface_SubResourceEmbedded

Inbound NAT rule of the load balancer.

Used by: NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

IPConfigurationBgpPeeringAddress

Properties of IPConfigurationBgpPeeringAddress.

Used by: BgpSettings.

Property Description Type
customBgpIpAddresses The list of custom BGP peering addresses which belong to IP configuration. string[]
Optional
ipconfigurationId The ID of IP configuration which belongs to gateway. string
Optional

IPConfigurationBgpPeeringAddress_STATUS

Properties of IPConfigurationBgpPeeringAddress.

Used by: BgpSettings_STATUS.

Property Description Type
customBgpIpAddresses The list of custom BGP peering addresses which belong to IP configuration. string[]
Optional
defaultBgpIpAddresses The list of default BGP peering addresses which belong to IP configuration. string[]
Optional
ipconfigurationId The ID of IP configuration which belongs to gateway. string
Optional
tunnelIpAddresses The list of tunnel public IP addresses which belong to IP configuration. string[]
Optional

IPRule

Used by: BastionHostPropertiesFormat_NetworkAcls.

Property Description Type
addressPrefix Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. string
Optional

IPRule_STATUS

Used by: BastionHostPropertiesFormat_NetworkAcls_STATUS.

Property Description Type
addressPrefix Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. string
Optional

IpsecPolicy

An IPSec Policy configuration for a virtual network gateway connection.

Used by: VpnClientConfiguration.

Property Description Type
dhGroup The DH Group used in IKE Phase 1 for initial SA. DhGroup
Required
ikeEncryption The IKE encryption algorithm (IKE phase 2). IkeEncryption
Required
ikeIntegrity The IKE integrity algorithm (IKE phase 2). IkeIntegrity
Required
ipsecEncryption The IPSec encryption algorithm (IKE phase 1). IpsecEncryption
Required
ipsecIntegrity The IPSec integrity algorithm (IKE phase 1). IpsecIntegrity
Required
pfsGroup The Pfs Group used in IKE Phase 2 for new child SA. PfsGroup
Required
saDataSizeKilobytes The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. int
Required
saLifeTimeSeconds The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. int
Required

IpsecPolicy_STATUS

An IPSec Policy configuration for a virtual network gateway connection.

Used by: VpnClientConfiguration_STATUS.

Property Description Type
dhGroup The DH Group used in IKE Phase 1 for initial SA. DhGroup_STATUS
Optional
ikeEncryption The IKE encryption algorithm (IKE phase 2). IkeEncryption_STATUS
Optional
ikeIntegrity The IKE integrity algorithm (IKE phase 2). IkeIntegrity_STATUS
Optional
ipsecEncryption The IPSec encryption algorithm (IKE phase 1). IpsecEncryption_STATUS
Optional
ipsecIntegrity The IPSec integrity algorithm (IKE phase 1). IpsecIntegrity_STATUS
Optional
pfsGroup The Pfs Group used in IKE Phase 2 for new child SA. PfsGroup_STATUS
Optional
saDataSizeKilobytes The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. int
Optional
saLifeTimeSeconds The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. int
Optional

LoadBalancerBackendAddress

Load balancer backend addresses.

Used by: BackendAddressPool_LoadBalancer_SubResourceEmbedded.

Property Description Type
adminState A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections. LoadBalancerBackendAddressPropertiesFormat_AdminState
Optional
ipAddress IP Address belonging to the referenced virtual network. string
Optional
loadBalancerFrontendIPConfiguration Reference to the frontend ip address configuration defined in regional loadbalancer. SubResource
Optional
name Name of the backend address. string
Optional
subnet Reference to an existing subnet. SubResource
Optional
virtualNetwork Reference to an existing virtual network. SubResource
Optional

LoadBalancerBackendAddress_STATUS

Load balancer backend addresses.

Used by: BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded.

Property Description Type
adminState A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections. LoadBalancerBackendAddressPropertiesFormat_AdminState_STATUS
Optional
inboundNatRulesPortMapping Collection of inbound NAT rule port mappings. NatRulePortMapping_STATUS[]
Optional
ipAddress IP Address belonging to the referenced virtual network. string
Optional
loadBalancerFrontendIPConfiguration Reference to the frontend ip address configuration defined in regional loadbalancer. SubResource_STATUS
Optional
name Name of the backend address. string
Optional
networkInterfaceIPConfiguration Reference to IP address defined in network interfaces. SubResource_STATUS
Optional
subnet Reference to an existing subnet. SubResource_STATUS
Optional
virtualNetwork Reference to an existing virtual network. SubResource_STATUS
Optional

LoadBalancerSku_Name

Used by: LoadBalancerSku.

Value Description
“Basic”
“Gateway”
“Standard”

LoadBalancerSku_Name_STATUS

Used by: LoadBalancerSku_STATUS.

Value Description
“Basic”
“Gateway”
“Standard”

LoadBalancerSku_Tier

Used by: LoadBalancerSku.

Value Description
“Global”
“Regional”

LoadBalancerSku_Tier_STATUS

Used by: LoadBalancerSku_STATUS.

Value Description
“Global”
“Regional”

LoadBalancingRulePropertiesFormat_LoadDistribution

Used by: LoadBalancingRule.

Value Description
“Default”
“SourceIP”
“SourceIPProtocol”

LoadBalancingRulePropertiesFormat_LoadDistribution_STATUS

Used by: LoadBalancingRule_STATUS.

Value Description
“Default”
“SourceIP”
“SourceIPProtocol”

ManagedServiceIdentity_Type

Used by: ManagedServiceIdentity.

Value Description
“None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”

ManagedServiceIdentity_Type_STATUS

Used by: ManagedServiceIdentity_STATUS.

Value Description
“None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”

ManagedServiceIdentity_UserAssignedIdentities_STATUS

Used by: ManagedServiceIdentity_STATUS.

Property Description Type
clientId The client id of user assigned identity. string
Optional
principalId The principal id of user assigned identity. string
Optional

NatGatewaySku_Name

Used by: NatGatewaySku.

Value Description
“Standard”

NatGatewaySku_Name_STATUS

Used by: NatGatewaySku_STATUS.

Value Description
“Standard”

NetworkInterfaceIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded

IPConfiguration in a network interface.

Used by: BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, and InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties_STATUS

PrivateLinkConnection properties for the network interface.

Used by: NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
fqdns List of FQDNs for current private link connection. string[]
Optional
groupId The group ID for current private link connection. string
Optional
requiredMemberName The required member name for current private link connection. string
Optional

OutboundRulePropertiesFormat_Protocol

Used by: OutboundRule.

Value Description
“All”
“Tcp”
“Udp”

OutboundRulePropertiesFormat_Protocol_STATUS

Used by: OutboundRule_STATUS.

Value Description
“All”
“Tcp”
“Udp”

PrivateEndpointOperatorConfigMaps

Used by: PrivateEndpointOperatorSpec.

Property Description Type
primaryNicPrivateIpAddress indicates where the PrimaryNicPrivateIpAddress config map should be placed. If omitted, no config map will be created. genruntime.ConfigMapDestination
Optional

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Used by: PrivateLinkServiceConnection.

Property Description Type
actionsRequired A message indicating if changes on the service provider require any updates on the consumer. string
Optional
description The reason for approval/rejection of the connection. string
Optional
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. string
Optional

PrivateLinkServiceConnectionState_STATUS

A collection of information about the state of the connection between service consumer and provider.

Used by: PrivateLinkServiceConnection_STATUS.

Property Description Type
actionsRequired A message indicating if changes on the service provider require any updates on the consumer. string
Optional
description The reason for approval/rejection of the connection. string
Optional
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. string
Optional

PrivateLinkServiceOperatorConfigMaps

Used by: PrivateLinkServiceOperatorSpec.

Property Description Type
alias indicates where the Alias config map should be placed. If omitted, no config map will be created. genruntime.ConfigMapDestination
Optional

ProbePropertiesFormat_NoHealthyBackendsBehavior

Used by: Probe.

Value Description
“AllProbedDown”
“AllProbedUp”

ProbePropertiesFormat_NoHealthyBackendsBehavior_STATUS

Used by: Probe_STATUS.

Value Description
“AllProbedDown”
“AllProbedUp”

ProbePropertiesFormat_Protocol

Used by: Probe.

Value Description
“Http”
“Https”
“Tcp”

ProbePropertiesFormat_Protocol_STATUS

Used by: Probe_STATUS.

Value Description
“Http”
“Https”
“Tcp”

PublicIPAddress_STATUS_LoadBalancer_SubResourceEmbedded

Public IP address resource.

Used by: FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

PublicIPAddress_STATUS_NetworkInterface_SubResourceEmbedded

Public IP address resource.

Used by: NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

PublicIPAddressDnsSettings_DomainNameLabelScope

Used by: PublicIPAddressDnsSettings.

Value Description
“NoReuse”
“ResourceGroupReuse”
“SubscriptionReuse”
“TenantReuse”

PublicIPAddressDnsSettings_DomainNameLabelScope_STATUS

Used by: PublicIPAddressDnsSettings_STATUS.

Value Description
“NoReuse”
“ResourceGroupReuse”
“SubscriptionReuse”
“TenantReuse”

PublicIPAddressSku_Name

Used by: PublicIPAddressSku.

Value Description
“Basic”
“Standard”

PublicIPAddressSku_Name_STATUS

Used by: PublicIPAddressSku_STATUS.

Value Description
“Basic”
“Standard”

PublicIPAddressSku_Tier

Used by: PublicIPAddressSku.

Value Description
“Global”
“Regional”

PublicIPAddressSku_Tier_STATUS

Used by: PublicIPAddressSku_STATUS.

Value Description
“Global”
“Regional”

PublicIPAddressSpec_LoadBalancer_SubResourceEmbedded

Public IP address resource.

Used by: FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

PublicIPAddressSpec_NetworkInterface_SubResourceEmbedded

Public IP address resource.

Used by: NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

PublicIPPrefixSku_Name

Used by: PublicIPPrefixSku.

Value Description
“Standard”

PublicIPPrefixSku_Name_STATUS

Used by: PublicIPPrefixSku_STATUS.

Value Description
“Standard”

PublicIPPrefixSku_Tier

Used by: PublicIPPrefixSku.

Value Description
“Global”
“Regional”

PublicIPPrefixSku_Tier_STATUS

Used by: PublicIPPrefixSku_STATUS.

Value Description
“Global”
“Regional”

RadiusServer

Radius Server Settings.

Used by: VpnClientConfiguration.

Property Description Type
radiusServerAddress The address of this radius server. string
Required
radiusServerScore The initial score assigned to this radius server. int
Optional
radiusServerSecret The secret used for this radius server. string
Optional

RadiusServer_STATUS

Radius Server Settings.

Used by: VpnClientConfiguration_STATUS.

Property Description Type
radiusServerAddress The address of this radius server. string
Optional
radiusServerScore The initial score assigned to this radius server. int
Optional
radiusServerSecret The secret used for this radius server. string
Optional

RecordSet_STATUS

A collective group of information about the record set information.

Used by: PrivateDnsZoneConfig_STATUS.

Property Description Type
fqdn Fqdn that resolves to private endpoint ip address. string
Optional
ipAddresses The private ip address of the private endpoint. string[]
Optional
provisioningState The provisioning state of the recordset. ProvisioningState_STATUS
Optional
recordSetName Recordset name. string
Optional
recordType Resource record type. string
Optional
ttl Recordset time to live. int
Optional

Sku_Name

Used by: Sku.

Value Description
“Basic”
“Developer”
“Premium”
“Standard”

Sku_Name_STATUS

Used by: Sku_STATUS.

Value Description
“Basic”
“Developer”
“Premium”
“Standard”

Subnet_LoadBalancer_SubResourceEmbedded

Subnet in a virtual network resource.

Used by: FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

Subnet_NetworkInterface_SubResourceEmbedded

Subnet in a virtual network resource.

Used by: NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

Subnet_PrivateLinkService_SubResourceEmbedded

Subnet in a virtual network resource.

Used by: PrivateLinkServiceIpConfiguration.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

Subnet_STATUS_LoadBalancer_SubResourceEmbedded

Subnet in a virtual network resource.

Used by: FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

Subnet_STATUS_NetworkInterface_SubResourceEmbedded

Subnet in a virtual network resource.

Used by: NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

Subnet_STATUS_PrivateLinkService_SubResourceEmbedded

Subnet in a virtual network resource.

Used by: PrivateLinkServiceIpConfiguration_STATUS.

Property Description Type
id Resource ID. string
Optional

UserAssignedIdentityDetails

Information about the user assigned identity for the resource

Used by: ManagedServiceIdentity.

Property Description Type
reference genruntime.ResourceReference
Optional

VirtualNetworkEncryption_Enforcement

Used by: VirtualNetworkEncryption.

Value Description
“AllowUnencrypted”
“DropUnencrypted”

VirtualNetworkEncryption_Enforcement_STATUS

Used by: VirtualNetworkEncryption_STATUS.

Value Description
“AllowUnencrypted”
“DropUnencrypted”

VirtualNetworkGatewayAutoScaleBounds

Used by: VirtualNetworkGatewayAutoScaleConfiguration.

Property Description Type
max Maximum Scale Units for Autoscale configuration int
Optional
min Minimum scale Units for Autoscale configuration int
Optional

VirtualNetworkGatewayAutoScaleBounds_STATUS

Used by: VirtualNetworkGatewayAutoScaleConfiguration_STATUS.

Property Description Type
max Maximum Scale Units for Autoscale configuration int
Optional
min Minimum scale Units for Autoscale configuration int
Optional

VirtualNetworkGatewayNatRuleProperties_Mode

Used by: VirtualNetworkGatewayNatRule.

Value Description
“EgressSnat”
“IngressSnat”

VirtualNetworkGatewayNatRuleProperties_Mode_STATUS

Used by: VirtualNetworkGatewayNatRule_STATUS.

Value Description
“EgressSnat”
“IngressSnat”

VirtualNetworkGatewayNatRuleProperties_Type

Used by: VirtualNetworkGatewayNatRule.

Value Description
“Dynamic”
“Static”

VirtualNetworkGatewayNatRuleProperties_Type_STATUS

Used by: VirtualNetworkGatewayNatRule_STATUS.

Value Description
“Dynamic”
“Static”

VirtualNetworkGatewayPolicyGroupMember

Vpn Client Connection configuration PolicyGroup member

Used by: VirtualNetworkGatewayPolicyGroup.

Property Description Type
attributeType The Vpn Policy member attribute type. VirtualNetworkGatewayPolicyGroupMember_AttributeType
Optional
attributeValue The value of Attribute used for this VirtualNetworkGatewayPolicyGroupMember. string
Optional
name Name of the VirtualNetworkGatewayPolicyGroupMember. string
Optional

VirtualNetworkGatewayPolicyGroupMember_STATUS

Vpn Client Connection configuration PolicyGroup member

Used by: VirtualNetworkGatewayPolicyGroup_STATUS.

Property Description Type
attributeType The Vpn Policy member attribute type. VirtualNetworkGatewayPolicyGroupMember_AttributeType_STATUS
Optional
attributeValue The value of Attribute used for this VirtualNetworkGatewayPolicyGroupMember. string
Optional
name Name of the VirtualNetworkGatewayPolicyGroupMember. string
Optional

VirtualNetworkGatewaySku_Name

Used by: VirtualNetworkGatewaySku.

Value Description
“Basic”
“ErGw1AZ”
“ErGw2AZ”
“ErGw3AZ”
“ErGwScale”
“HighPerformance”
“Standard”
“UltraPerformance”
“VpnGw1”
“VpnGw1AZ”
“VpnGw2”
“VpnGw2AZ”
“VpnGw3”
“VpnGw3AZ”
“VpnGw4”
“VpnGw4AZ”
“VpnGw5”
“VpnGw5AZ”

VirtualNetworkGatewaySku_Name_STATUS

Used by: VirtualNetworkGatewaySku_STATUS.

Value Description
“Basic”
“ErGw1AZ”
“ErGw2AZ”
“ErGw3AZ”
“ErGwScale”
“HighPerformance”
“Standard”
“UltraPerformance”
“VpnGw1”
“VpnGw1AZ”
“VpnGw2”
“VpnGw2AZ”
“VpnGw3”
“VpnGw3AZ”
“VpnGw4”
“VpnGw4AZ”
“VpnGw5”
“VpnGw5AZ”

VirtualNetworkGatewaySku_Tier

Used by: VirtualNetworkGatewaySku.

Value Description
“Basic”
“ErGw1AZ”
“ErGw2AZ”
“ErGw3AZ”
“ErGwScale”
“HighPerformance”
“Standard”
“UltraPerformance”
“VpnGw1”
“VpnGw1AZ”
“VpnGw2”
“VpnGw2AZ”
“VpnGw3”
“VpnGw3AZ”
“VpnGw4”
“VpnGw4AZ”
“VpnGw5”
“VpnGw5AZ”

VirtualNetworkGatewaySku_Tier_STATUS

Used by: VirtualNetworkGatewaySku_STATUS.

Value Description
“Basic”
“ErGw1AZ”
“ErGw2AZ”
“ErGw3AZ”
“ErGwScale”
“HighPerformance”
“Standard”
“UltraPerformance”
“VpnGw1”
“VpnGw1AZ”
“VpnGw2”
“VpnGw2AZ”
“VpnGw3”
“VpnGw3AZ”
“VpnGw4”
“VpnGw4AZ”
“VpnGw5”
“VpnGw5AZ”

VirtualNetworkTap_STATUS_NetworkInterface_SubResourceEmbedded

Virtual Network Tap resource.

Used by: NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded.

Property Description Type
id Resource ID. string
Optional

VirtualNetworkTapSpec_NetworkInterface_SubResourceEmbedded

Virtual Network Tap resource.

Used by: NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

VngClientConnectionConfiguration

A vpn client connection configuration for client connection configuration.

Used by: VpnClientConfiguration.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

VngClientConnectionConfiguration_STATUS

A vpn client connection configuration for client connection configuration.

Used by: VpnClientConfiguration_STATUS.

Property Description Type
id Resource ID. string
Optional

VpnClientConfiguration_VpnAuthenticationTypes

Used by: VpnClientConfiguration.

Value Description
“AAD”
“Certificate”
“Radius”

VpnClientConfiguration_VpnAuthenticationTypes_STATUS

Used by: VpnClientConfiguration_STATUS.

Value Description
“AAD”
“Certificate”
“Radius”

VpnClientConfiguration_VpnClientProtocols

Used by: VpnClientConfiguration.

Value Description
“IkeV2”
“OpenVPN”
“SSTP”

VpnClientConfiguration_VpnClientProtocols_STATUS

Used by: VpnClientConfiguration_STATUS.

Value Description
“IkeV2”
“OpenVPN”
“SSTP”

VpnClientRevokedCertificate

VPN client revoked certificate of virtual network gateway.

Used by: VpnClientConfiguration.

Property Description Type
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
thumbprint The revoked VPN client certificate thumbprint. string
Optional

VpnClientRevokedCertificate_STATUS

VPN client revoked certificate of virtual network gateway.

Used by: VpnClientConfiguration_STATUS.

Property Description Type
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
provisioningState The provisioning state of the VPN client revoked certificate resource. ProvisioningState_STATUS
Optional
thumbprint The revoked VPN client certificate thumbprint. string
Optional

VpnClientRootCertificate

VPN client root certificate of virtual network gateway.

Used by: VpnClientConfiguration.

Property Description Type
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
publicCertData The certificate public data. string
Required

VpnClientRootCertificate_STATUS

VPN client root certificate of virtual network gateway.

Used by: VpnClientConfiguration_STATUS.

Property Description Type
etag A unique read-only string that changes whenever the resource is updated. string
Optional
id Resource ID. string
Optional
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
Optional
provisioningState The provisioning state of the VPN client root certificate resource. ProvisioningState_STATUS
Optional
publicCertData The certificate public data. string
Optional

VpnNatRuleMapping

Vpn NatRule mapping.

Used by: VirtualNetworkGatewayNatRule, and VirtualNetworkGatewayNatRule.

Property Description Type
addressSpace Address space for Vpn NatRule mapping. string
Optional
portRange Port range for Vpn NatRule mapping. string
Optional

VpnNatRuleMapping_STATUS

Vpn NatRule mapping.

Used by: VirtualNetworkGatewayNatRule_STATUS, and VirtualNetworkGatewayNatRule_STATUS.

Property Description Type
addressSpace Address space for Vpn NatRule mapping. string
Optional
portRange Port range for Vpn NatRule mapping. string
Optional

DhGroup

The DH Groups used in IKE Phase 1 for initial SA.

Used by: IpsecPolicy.

Value Description
“DHGroup1”
“DHGroup14”
“DHGroup2”
“DHGroup2048”
“DHGroup24”
“ECP256”
“ECP384”
“None”

DhGroup_STATUS

The DH Groups used in IKE Phase 1 for initial SA.

Used by: IpsecPolicy_STATUS.

Value Description
“DHGroup1”
“DHGroup14”
“DHGroup2”
“DHGroup2048”
“DHGroup24”
“ECP256”
“ECP384”
“None”

GatewayLoadBalancerTunnelInterface_Protocol

Used by: GatewayLoadBalancerTunnelInterface.

Value Description
“Native”
“None”
“VXLAN”

GatewayLoadBalancerTunnelInterface_Protocol_STATUS

Used by: GatewayLoadBalancerTunnelInterface_STATUS.

Value Description
“Native”
“None”
“VXLAN”

GatewayLoadBalancerTunnelInterface_Type

Used by: GatewayLoadBalancerTunnelInterface.

Value Description
“External”
“Internal”
“None”

GatewayLoadBalancerTunnelInterface_Type_STATUS

Used by: GatewayLoadBalancerTunnelInterface_STATUS.

Value Description
“External”
“Internal”
“None”

IkeEncryption

The IKE encryption algorithm (IKE phase 2).

Used by: IpsecPolicy.

Value Description
“AES128”
“AES192”
“AES256”
“DES”
“DES3”
“GCMAES128”
“GCMAES256”

IkeEncryption_STATUS

The IKE encryption algorithm (IKE phase 2).

Used by: IpsecPolicy_STATUS.

Value Description
“AES128”
“AES192”
“AES256”
“DES”
“DES3”
“GCMAES128”
“GCMAES256”

IkeIntegrity

The IKE integrity algorithm (IKE phase 2).

Used by: IpsecPolicy.

Value Description
“GCMAES128”
“GCMAES256”
“MD5”
“SHA1”
“SHA256”
“SHA384”

IkeIntegrity_STATUS

The IKE integrity algorithm (IKE phase 2).

Used by: IpsecPolicy_STATUS.

Value Description
“GCMAES128”
“GCMAES256”
“MD5”
“SHA1”
“SHA256”
“SHA384”

IpsecEncryption

The IPSec encryption algorithm (IKE phase 1).

Used by: IpsecPolicy.

Value Description
“AES128”
“AES192”
“AES256”
“DES”
“DES3”
“GCMAES128”
“GCMAES192”
“GCMAES256”
“None”

IpsecEncryption_STATUS

The IPSec encryption algorithm (IKE phase 1).

Used by: IpsecPolicy_STATUS.

Value Description
“AES128”
“AES192”
“AES256”
“DES”
“DES3”
“GCMAES128”
“GCMAES192”
“GCMAES256”
“None”

IpsecIntegrity

The IPSec integrity algorithm (IKE phase 1).

Used by: IpsecPolicy.

Value Description
“GCMAES128”
“GCMAES192”
“GCMAES256”
“MD5”
“SHA1”
“SHA256”

IpsecIntegrity_STATUS

The IPSec integrity algorithm (IKE phase 1).

Used by: IpsecPolicy_STATUS.

Value Description
“GCMAES128”
“GCMAES192”
“GCMAES256”
“MD5”
“SHA1”
“SHA256”

LoadBalancerBackendAddressPropertiesFormat_AdminState

Used by: LoadBalancerBackendAddress.

Value Description
“Down”
“None”
“Up”

LoadBalancerBackendAddressPropertiesFormat_AdminState_STATUS

Used by: LoadBalancerBackendAddress_STATUS.

Value Description
“Down”
“None”
“Up”

NatRulePortMapping_STATUS

Individual port mappings for inbound NAT rule created for backend pool.

Used by: LoadBalancerBackendAddress_STATUS.

Property Description Type
backendPort Backend port. int
Optional
frontendPort Frontend port. int
Optional
inboundNatRuleName Name of inbound NAT rule. string
Optional

PfsGroup

The Pfs Groups used in IKE Phase 2 for new child SA.

Used by: IpsecPolicy.

Value Description
“ECP256”
“ECP384”
“None”
“PFS1”
“PFS14”
“PFS2”
“PFS2048”
“PFS24”
“PFSMM”

PfsGroup_STATUS

The Pfs Groups used in IKE Phase 2 for new child SA.

Used by: IpsecPolicy_STATUS.

Value Description
“ECP256”
“ECP384”
“None”
“PFS1”
“PFS14”
“PFS2”
“PFS2048”
“PFS24”
“PFSMM”

VirtualNetworkGatewayPolicyGroupMember_AttributeType

Used by: VirtualNetworkGatewayPolicyGroupMember.

Value Description
“AADGroupId”
“CertificateGroupId”
“RadiusAzureGroupId”

VirtualNetworkGatewayPolicyGroupMember_AttributeType_STATUS

Used by: VirtualNetworkGatewayPolicyGroupMember_STATUS.

Value Description
“AADGroupId”
“CertificateGroupId”
“RadiusAzureGroupId”