network.azure.com/v1api20201101
APIVersion
| Value | Description |
|---|---|
| “2020-11-01” |
LoadBalancer
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2020-11-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/2020-11-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/2020-11-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 |
| 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 |
| 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 |
|---|---|---|
| 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 |
| 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/2020-11-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 |
NetworkInterface
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2020-11-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 |
|---|---|---|
| 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 |
| dnsSettings | The DNS settings in network interface. | NetworkInterfaceDnsSettings Optional |
| enableAcceleratedNetworking | If the network interface is accelerated networking enabled. | 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 |
NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] 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 accelerated networking enabled. | 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 |
NetworkInterfaceList
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2020-11-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/2020-11-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 |
| 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 |
| flowLogs | A collection of references to flow log resources. | FlowLog_STATUS[] 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/2020-11-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/2020-11-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 Optional |
| 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/2020-11-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 |
PublicIPAddress
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2020-11-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 |
| 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 |
| 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/2020-11-01/publicIpAddress.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | PublicIPAddress[] Optional |
RouteTable
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2020-11-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/2020-11-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/2020-11-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/2020-11-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/2020-11-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 |
| extendedLocation | The extended location of the virtual network. | ExtendedLocation 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 |
| 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 |
| 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 |
| 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 |
| 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/2020-11-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 Optional |
VirtualNetworkGateway_Spec
| Property | Description | Type |
|---|---|---|
| activeActive | ActiveActive flag. | 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 |
| 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 |
| enableBgp | Whether BGP is enabled for this virtual network gateway or not. | 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 |
| ipConfigurations | IP configurations for virtual network gateway. | VirtualNetworkGatewayIPConfiguration[] 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 | 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 |
| 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 |
| 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
| Property | Description | Type |
|---|---|---|
| activeActive | ActiveActive flag. | bool 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 |
| enableBgp | Whether BGP is enabled for this virtual network gateway or not. | 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 |
| 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 |
| provisioningState | The provisioning state of the virtual network gateway resource. | ProvisioningState_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 |
| 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/2020-11-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/2020-11-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/2020-11-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 |
| 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 |
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 |
| 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 |
| type | Resource type. | string Optional |
VirtualNetworksSubnetList
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2020-11-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/2020-11-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 |
| 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 |
| peeringState | The status of the virtual network peering. | VirtualNetworkPeeringPropertiesFormat_PeeringState Optional |
| remoteAddressSpace | The reference to the remote virtual network address space. | AddressSpace Optional |
| remoteBgpCommunities | The reference to the remote virtual network’s Bgp Communities. | VirtualNetworkBgpCommunities 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 |
| 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 |
| 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 |
| peeringState | The status of the virtual network peering. | VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS Optional |
| provisioningState | The provisioning state of the virtual network peering resource. | ProvisioningState_STATUS Optional |
| remoteAddressSpace | The reference to the remote virtual network address space. | AddressSpace_STATUS Optional |
| remoteBgpCommunities | The reference to the remote virtual network’s Bgp Communities. | VirtualNetworkBgpCommunities_STATUS 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 |
| 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/2020-11-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 |
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 |
| 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 |
| 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 |
|---|---|---|
| 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 |
| 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 |
NetworkInterface_Spec
Used by: NetworkInterface.
| 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 |
| dnsSettings | The DNS settings in network interface. | NetworkInterfaceDnsSettings Optional |
| enableAcceleratedNetworking | If the network interface is accelerated networking enabled. | 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 |
NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded
A network interface in a resource group.
Used by: NetworkInterface.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] 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 accelerated networking enabled. | 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 |
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 |
| 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 |
| flowLogs | A collection of references to flow log resources. | FlowLog_STATUS[] 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 Optional |
| 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 |
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 |
| 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 |
| 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 |
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 |
| extendedLocation | The extended location of the virtual network. | ExtendedLocation 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| enableBgp | Whether BGP is enabled for this virtual network gateway or not. | 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 |
| ipConfigurations | IP configurations for virtual network gateway. | VirtualNetworkGatewayIPConfiguration[] 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 | 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 |
| 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 |
| 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
A common class for general resource information.
Used by: VirtualNetworkGateway.
| Property | Description | Type |
|---|---|---|
| activeActive | ActiveActive flag. | bool 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 |
| enableBgp | Whether BGP is enabled for this virtual network gateway or not. | 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 |
| 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 |
| provisioningState | The provisioning state of the virtual network gateway resource. | ProvisioningState_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 |
| 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 |
| 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 |
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 |
| 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 |
| 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 |
| 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 |
| peeringState | The status of the virtual network peering. | VirtualNetworkPeeringPropertiesFormat_PeeringState Optional |
| remoteAddressSpace | The reference to the remote virtual network address space. | AddressSpace Optional |
| remoteBgpCommunities | The reference to the remote virtual network’s Bgp Communities. | VirtualNetworkBgpCommunities 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 |
| 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 |
| 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 |
| peeringState | The status of the virtual network peering. | VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS Optional |
| provisioningState | The provisioning state of the virtual network peering resource. | ProvisioningState_STATUS Optional |
| remoteAddressSpace | The reference to the remote virtual network address space. | AddressSpace_STATUS Optional |
| remoteBgpCommunities | The reference to the remote virtual network’s Bgp Communities. | VirtualNetworkBgpCommunities_STATUS 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 |
| 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, 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, 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 |
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 |
BackendAddressPool_LoadBalancer_SubResourceEmbedded
Pool of backend IP addresses.
Used by: LoadBalancer_Spec.
| Property | Description | Type |
|---|---|---|
| loadBalancerBackendAddresses | An array of backend addresses. | LoadBalancerBackendAddress[] 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 |
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 |
| etag | A unique read-only string that changes whenever the resource is updated. | string Optional |
| id | Resource ID. | string 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 |
| 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 |
| type | Type of the resource. | string 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.
| 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 |
DdosSettings
Contains the DDoS protection settings of the public IP.
Used by: PublicIPAddress_Spec.
| Property | Description | Type |
|---|---|---|
| ddosCustomPolicy | The DDoS custom policy associated with the public IP. | SubResource Optional |
| protectedIP | Enables DDoS protection on the public IP. | bool Optional |
| protectionCoverage | The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. | DdosSettings_ProtectionCoverage Optional |
DdosSettings_STATUS
Contains the DDoS protection settings of the public IP.
Used by: PublicIPAddress_STATUS.
| Property | Description | Type |
|---|---|---|
| ddosCustomPolicy | The DDoS custom policy associated with the public IP. | SubResource_STATUS Optional |
| protectedIP | Enables DDoS protection on the public IP. | bool Optional |
| protectionCoverage | The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. | DdosSettings_ProtectionCoverage_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, PublicIPAddress_Spec, VirtualNetwork_Spec, and VirtualNetworkGateway_Spec.
| Property | Description | Type |
|---|---|---|
| name | The name of the extended location. | string Required |
| type | The type of the extended location. | ExtendedLocationType Required |
ExtendedLocation_STATUS
ExtendedLocation complex type.
Used by: LoadBalancer_STATUS, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, PublicIPAddress_STATUS, VirtualNetwork_STATUS, and VirtualNetworkGateway_STATUS.
| Property | Description | Type |
|---|---|---|
| name | The name of the extended location. | string Optional |
| type | The type of the extended location. | ExtendedLocationType_STATUS Optional |
FlowLog_STATUS
A flow log resource.
Used by: NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded.
| 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 |
|---|---|---|
| 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_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 |
| 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 |
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 |
|---|---|---|
| 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 |
| 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 |
|---|---|---|
| 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 |
| 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: FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded, PublicIPAddress_Spec, and VirtualNetworkGatewayIPConfiguration.
| Value | Description |
|---|---|
| “Dynamic” | |
| “Static” |
IPAllocationMethod_STATUS
IP address allocation method.
Used by: FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, 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.
| 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.
| 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, and PublicIPAddress_Spec.
| Value | Description |
|---|---|
| “IPv4” | |
| “IPv6” |
IPVersion_STATUS
IP address version.
Used by: FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, and PublicIPAddress_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 |
| 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 |
| 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 |
NatGateway_STATUS_PublicIPAddress_SubResourceEmbedded
Nat Gateway resource.
Used by: PublicIPAddress_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Resource ID. | string Optional |
NatGatewaySpec_PublicIPAddress_SubResourceEmbedded
Nat Gateway resource.
Used by: PublicIPAddress_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 |
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 |
| 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. | 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 |
| 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 |
| 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. | 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 |
| 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_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 |
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 |
PrivateLinkService_STATUS_NetworkInterface_SubResourceEmbedded
Private link service resource.
Used by: NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded.
| Property | Description | Type |
|---|---|---|
| id | Resource ID. | string 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 |
| 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 |
| 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 |
| 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 |
| 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, Delegation_STATUS, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, InboundNatPool_STATUS, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, LoadBalancer_STATUS, LoadBalancersInboundNatRule_STATUS, LoadBalancingRule_STATUS, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded, NetworkSecurityGroupsSecurityRule_STATUS, OutboundRule_STATUS, Probe_STATUS, PublicIPAddress_STATUS, RouteTable_STATUS, RouteTablesRoute_STATUS, ServiceEndpointPropertiesFormat_STATUS, VirtualNetwork_STATUS, VirtualNetworkGateway_STATUS, VirtualNetworkGatewayIPConfiguration_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 |
| 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 |
| 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_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 |
ResourceNavigationLink_STATUS
ResourceNavigationLink resource.
Used by: VirtualNetworksSubnet_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Resource navigation link identifier. | 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_STATUS
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 |
| 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 |
| provisioningState | The provisioning state of the service endpoint resource. | ProvisioningState_STATUS Optional |
| service | The type of the endpoint service. | string 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 |
SubnetPropertiesFormat_PrivateEndpointNetworkPolicies
Used by: VirtualNetworksSubnet_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_STATUS
Used by: VirtualNetworksSubnet_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies
Used by: VirtualNetworksSubnet_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_STATUS
Used by: VirtualNetworksSubnet_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
SubResource
Reference to another subresource.
Used by: DdosSettings, FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, InboundNatPool, InboundNatRule_LoadBalancer_SubResourceEmbedded, LoadBalancerBackendAddress, LoadBalancerBackendAddress, LoadBalancerBackendAddress, LoadBalancersInboundNatRule_Spec, LoadBalancingRule, LoadBalancingRule, LoadBalancingRule, OutboundRule, OutboundRule, PublicIPAddress_Spec, 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, DdosSettings_STATUS, 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, LoadBalancerBackendAddress_STATUS, LoadBalancerBackendAddress_STATUS, LoadBalancerBackendAddress_STATUS, LoadBalancerBackendAddress_STATUS, LoadBalancersInboundNatRule_STATUS, LoadBalancingRule_STATUS, LoadBalancingRule_STATUS, LoadBalancingRule_STATUS, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, OutboundRule_STATUS, OutboundRule_STATUS, Probe_STATUS, PublicIPAddress_STATUS, VirtualNetwork_STATUS, VirtualNetwork_STATUS, VirtualNetworkGateway_STATUS, VirtualNetworkGatewayIPConfiguration_STATUS, VirtualNetworkGatewayIPConfiguration_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 |
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.
| 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 |
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 |
VirtualNetworkGatewayPropertiesFormat_GatewayType
Used by: VirtualNetworkGateway_Spec.
| Value | Description |
|---|---|
| “ExpressRoute” | |
| “LocalGateway” | |
| “Vpn” |
VirtualNetworkGatewayPropertiesFormat_GatewayType_STATUS
Used by: VirtualNetworkGateway_STATUS.
| Value | Description |
|---|---|
| “ExpressRoute” | |
| “LocalGateway” | |
| “Vpn” |
VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration
Used by: VirtualNetworkGateway_Spec.
| Value | Description |
|---|---|
| “Generation1” | |
| “Generation2” | |
| “None” |
VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_STATUS
Used by: VirtualNetworkGateway_STATUS.
| Value | Description |
|---|---|
| “Generation1” | |
| “Generation2” | |
| “None” |
VirtualNetworkGatewayPropertiesFormat_VpnType
Used by: VirtualNetworkGateway_Spec.
| Value | Description |
|---|---|
| “PolicyBased” | |
| “RouteBased” |
VirtualNetworkGatewayPropertiesFormat_VpnType_STATUS
Used by: VirtualNetworkGateway_STATUS.
| 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.
| 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” |
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 |
| 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.
| 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 |
| 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 |
DdosSettings_ProtectionCoverage
Used by: DdosSettings.
| Value | Description |
|---|---|
| “Basic” | |
| “Standard” |
DdosSettings_ProtectionCoverage_STATUS
Used by: DdosSettings_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Standard” |
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” |
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 |
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 |
|---|---|---|
| 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 |
|---|---|---|
| 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” | |
| “Standard” |
LoadBalancerSku_Name_STATUS
Used by: LoadBalancerSku_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “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” |
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” |
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 |
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 |
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 |
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_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 |
VirtualNetworkGatewaySku_Name
Used by: VirtualNetworkGatewaySku.
| Value | Description |
|---|---|
| “Basic” | |
| “ErGw1AZ” | |
| “ErGw2AZ” | |
| “ErGw3AZ” | |
| “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” | |
| “HighPerformance” | |
| “Standard” | |
| “UltraPerformance” | |
| “VpnGw1” | |
| “VpnGw1AZ” | |
| “VpnGw2” | |
| “VpnGw2AZ” | |
| “VpnGw3” | |
| “VpnGw3AZ” | |
| “VpnGw4” | |
| “VpnGw4AZ” | |
| “VpnGw5” | |
| “VpnGw5AZ” |
VirtualNetworkGatewaySku_Tier
Used by: VirtualNetworkGatewaySku.
| Value | Description |
|---|---|
| “Basic” | |
| “ErGw1AZ” | |
| “ErGw2AZ” | |
| “ErGw3AZ” | |
| “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” | |
| “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 |
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 |
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” |
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” |
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” |