network.azure.com/v1api20240301
network.azure.com/v1api20240301
Package v1api20240301 contains API Schema definitions for the network v1api20240301 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2024-03-01" |
AddressSpace
(Appears on:VirtualNetworkGateway_Spec, VirtualNetwork_Spec, VirtualNetworksVirtualNetworkPeering_Spec, VpnClientConfiguration)
AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
Field | Description |
---|---|
addressPrefixes []string |
AddressPrefixes: A list of address blocks reserved for this virtual network in CIDR notation. |
AddressSpace_STATUS
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded, VirtualNetwork_STATUS, VirtualNetworksVirtualNetworkPeering_STATUS, VpnClientConfiguration_STATUS)
AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
Field | Description |
---|---|
addressPrefixes []string |
AddressPrefixes: A list of address blocks reserved for this virtual network in CIDR notation. |
ApplicationGatewayBackendAddressPool_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)
Backend Address Pool of an application gateway.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
ApplicationGatewayBackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)
Backend Address Pool of an application gateway.
Field | Description |
---|---|
id string |
Id: Resource ID. |
ApplicationGatewayIPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded
(Appears on:VirtualNetworksSubnet_STATUS)
IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.
Field | Description |
---|---|
id string |
Id: Resource ID. |
ApplicationGatewayIPConfiguration_VirtualNetworks_Subnet_SubResourceEmbedded
(Appears on:VirtualNetworksSubnet_Spec)
IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
ApplicationSecurityGroupSpec_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)
An application security group in a resource group.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
ApplicationSecurityGroupSpec_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded
(Appears on:NetworkSecurityGroupsSecurityRule_Spec)
An application security group in a resource group.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
ApplicationSecurityGroupSpec_PrivateEndpoint_SubResourceEmbedded
(Appears on:PrivateEndpoint_Spec)
An application security group in a resource group.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
ApplicationSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)
An application security group in a resource group.
Field | Description |
---|---|
id string |
Id: Resource ID. |
ApplicationSecurityGroup_STATUS_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded
(Appears on:NetworkSecurityGroupsSecurityRule_STATUS)
An application security group in a resource group.
Field | Description |
---|---|
id string |
Id: Resource ID. |
ApplicationSecurityGroup_STATUS_PrivateEndpoint_SubResourceEmbedded
(Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)
An application security group in a resource group.
Field | Description |
---|---|
id string |
Id: Resource ID. |
BackendAddressPoolPropertiesFormat_SyncMode
(string
alias)
(Appears on:BackendAddressPool_LoadBalancer_SubResourceEmbedded)
Value | Description |
---|---|
"Automatic" |
|
"Manual" |
BackendAddressPoolPropertiesFormat_SyncMode_STATUS
(string
alias)
(Appears on:BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded)
Value | Description |
---|---|
"Automatic" |
|
"Manual" |
BackendAddressPool_LoadBalancer_SubResourceEmbedded
(Appears on:LoadBalancer_Spec)
Pool of backend IP addresses.
Field | Description |
---|---|
drainPeriodInSeconds int |
DrainPeriodInSeconds: Amount of seconds Load Balancer waits for before sending RESET to client and backend address. |
loadBalancerBackendAddresses []LoadBalancerBackendAddress |
LoadBalancerBackendAddresses: An array of backend addresses. |
location string |
Location: The location of the backend address pool. |
name string |
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. |
syncMode BackendAddressPoolPropertiesFormat_SyncMode |
SyncMode: Backend address synchronous mode for the backend pool |
tunnelInterfaces []GatewayLoadBalancerTunnelInterface |
TunnelInterfaces: An array of gateway load balancer tunnel interfaces. |
virtualNetwork SubResource |
VirtualNetwork: A reference to a virtual network. |
BackendAddressPool_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)
Pool of backend IP addresses.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded
(Appears on:LoadBalancer_STATUS)
Pool of backend IP addresses.
Field | Description |
---|---|
backendIPConfigurations []NetworkInterfaceIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded |
BackendIPConfigurations: An array of references to IP addresses defined in network interfaces. |
drainPeriodInSeconds int |
DrainPeriodInSeconds: Amount of seconds Load Balancer waits for before sending RESET to client and backend address. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
inboundNatRules []SubResource_STATUS |
InboundNatRules: An array of references to inbound NAT rules that use this backend address pool. |
loadBalancerBackendAddresses []LoadBalancerBackendAddress_STATUS |
LoadBalancerBackendAddresses: An array of backend addresses. |
loadBalancingRules []SubResource_STATUS |
LoadBalancingRules: An array of references to load balancing rules that use this backend address pool. |
location string |
Location: The location of the backend address pool. |
name string |
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. |
outboundRule SubResource_STATUS |
OutboundRule: A reference to an outbound rule that uses this backend address pool. |
outboundRules []SubResource_STATUS |
OutboundRules: An array of references to outbound rules that use this backend address pool. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the backend address pool resource. |
syncMode BackendAddressPoolPropertiesFormat_SyncMode_STATUS |
SyncMode: Backend address synchronous mode for the backend pool |
tunnelInterfaces []GatewayLoadBalancerTunnelInterface_STATUS |
TunnelInterfaces: An array of gateway load balancer tunnel interfaces. |
type string |
Type: Type of the resource. |
virtualNetwork SubResource_STATUS |
VirtualNetwork: A reference to a virtual network. |
BackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)
Pool of backend IP addresses.
Field | Description |
---|---|
id string |
Id: Resource ID. |
BastionHost
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/bastionHost.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||
spec BastionHost_Spec |
|
||||||||||||||||||||||||||||||||||||||
status BastionHost_STATUS |
BastionHostIPConfiguration
(Appears on:BastionHost_Spec)
IP configuration of an Bastion Host.
Field | Description |
---|---|
name string |
Name: Name of the resource that is unique within a resource group. This name can be used to access the resource. |
privateIPAllocationMethod IPAllocationMethod |
PrivateIPAllocationMethod: Private IP allocation method. |
publicIPAddress SubResource |
PublicIPAddress: Reference of the PublicIP resource. |
subnet SubResource |
Subnet: Reference of the subnet resource. |
BastionHostIPConfiguration_STATUS
(Appears on:BastionHost_STATUS)
IP configuration of an Bastion Host.
Field | Description |
---|---|
id string |
Id: Resource ID. |
BastionHostOperatorSpec
(Appears on:BastionHost_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
BastionHostPropertiesFormat_NetworkAcls
(Appears on:BastionHost_Spec)
Field | Description |
---|---|
ipRules []IPRule |
IpRules: Sets the IP ACL rules for Developer Bastion Host. |
BastionHostPropertiesFormat_NetworkAcls_STATUS
(Appears on:BastionHost_STATUS)
Field | Description |
---|---|
ipRules []IPRule_STATUS |
IpRules: Sets the IP ACL rules for Developer Bastion Host. |
BastionHost_STATUS
(Appears on:BastionHost)
Bastion Host resource.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
disableCopyPaste bool |
DisableCopyPaste: Enable/Disable Copy/Paste feature of the Bastion Host resource. |
dnsName string |
DnsName: FQDN for the endpoint on which bastion host is accessible. |
enableFileCopy bool |
EnableFileCopy: Enable/Disable File Copy feature of the Bastion Host resource. |
enableIpConnect bool |
EnableIpConnect: Enable/Disable IP Connect feature of the Bastion Host resource. |
enableKerberos bool |
EnableKerberos: Enable/Disable Kerberos feature of the Bastion Host resource. |
enableSessionRecording bool |
EnableSessionRecording: Enable/Disable Session Recording feature of the Bastion Host resource. |
enableShareableLink bool |
EnableShareableLink: Enable/Disable Shareable Link of the Bastion Host resource. |
enableTunneling bool |
EnableTunneling: Enable/Disable Tunneling feature of the Bastion Host resource. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
ipConfigurations []BastionHostIPConfiguration_STATUS |
IpConfigurations: IP configuration of the Bastion Host resource. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
networkAcls BastionHostPropertiesFormat_NetworkAcls_STATUS |
|
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the bastion host resource. |
scaleUnits int |
ScaleUnits: The scale units for the Bastion Host resource. |
sku Sku_STATUS |
Sku: The sku of this Bastion Host. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
virtualNetwork SubResource_STATUS |
VirtualNetwork: Reference to an existing virtual network required for Developer Bastion Host only. |
zones []string |
Zones: A list of availability zones denoting where the resource needs to come from. |
BastionHost_Spec
(Appears on:BastionHost)
Field | Description |
---|---|
azureName string |
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. |
disableCopyPaste bool |
DisableCopyPaste: Enable/Disable Copy/Paste feature of the Bastion Host resource. |
dnsName string |
DnsName: FQDN for the endpoint on which bastion host is accessible. |
enableFileCopy bool |
EnableFileCopy: Enable/Disable File Copy feature of the Bastion Host resource. |
enableIpConnect bool |
EnableIpConnect: Enable/Disable IP Connect feature of the Bastion Host resource. |
enableKerberos bool |
EnableKerberos: Enable/Disable Kerberos feature of the Bastion Host resource. |
enableSessionRecording bool |
EnableSessionRecording: Enable/Disable Session Recording feature of the Bastion Host resource. |
enableShareableLink bool |
EnableShareableLink: Enable/Disable Shareable Link of the Bastion Host resource. |
enableTunneling bool |
EnableTunneling: Enable/Disable Tunneling feature of the Bastion Host resource. |
ipConfigurations []BastionHostIPConfiguration |
IpConfigurations: IP configuration of the Bastion Host resource. |
location string |
Location: Resource location. |
networkAcls BastionHostPropertiesFormat_NetworkAcls |
|
operatorSpec BastionHostOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
scaleUnits int |
ScaleUnits: The scale units for the Bastion Host resource. |
sku Sku |
Sku: The sku of this Bastion Host. |
tags map[string]string |
Tags: Resource tags. |
virtualNetwork SubResource |
VirtualNetwork: Reference to an existing virtual network required for Developer Bastion Host only. |
zones []string |
Zones: A list of availability zones denoting where the resource needs to come from. |
BgpSettings
(Appears on:VirtualNetworkGateway_Spec)
BGP settings details.
Field | Description |
---|---|
asn uint32 |
Asn: The BGP speaker’s ASN. |
bgpPeeringAddress string |
BgpPeeringAddress: The BGP peering address and BGP identifier of this BGP speaker. |
bgpPeeringAddresses []IPConfigurationBgpPeeringAddress |
BgpPeeringAddresses: BGP peering address with IP configuration ID for virtual network gateway. |
peerWeight int |
PeerWeight: The weight added to routes learned from this BGP speaker. |
BgpSettings_STATUS
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
BGP settings details.
Field | Description |
---|---|
asn uint32 |
Asn: The BGP speaker’s ASN. |
bgpPeeringAddress string |
BgpPeeringAddress: The BGP peering address and BGP identifier of this BGP speaker. |
bgpPeeringAddresses []IPConfigurationBgpPeeringAddress_STATUS |
BgpPeeringAddresses: BGP peering address with IP configuration ID for virtual network gateway. |
peerWeight int |
PeerWeight: The weight added to routes learned from this BGP speaker. |
CustomDnsConfigPropertiesFormat_STATUS
(Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)
Contains custom Dns resolution configuration from customer.
Field | Description |
---|---|
fqdn string |
Fqdn: Fqdn that resolves to private endpoint ip address. |
ipAddresses []string |
IpAddresses: A list of private ip addresses of the private endpoint. |
DdosSettings
(Appears on:PublicIPAddress_Spec)
Contains the DDoS protection settings of the public IP.
Field | Description |
---|---|
ddosProtectionPlan SubResource |
DdosProtectionPlan: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled |
protectionMode DdosSettings_ProtectionMode |
ProtectionMode: The DDoS protection mode of the public IP |
DdosSettings_ProtectionMode
(string
alias)
(Appears on:DdosSettings)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
|
"VirtualNetworkInherited" |
DdosSettings_ProtectionMode_STATUS
(string
alias)
(Appears on:DdosSettings_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
|
"VirtualNetworkInherited" |
DdosSettings_STATUS
(Appears on:PublicIPAddress_STATUS)
Contains the DDoS protection settings of the public IP.
Field | Description |
---|---|
ddosProtectionPlan SubResource_STATUS |
DdosProtectionPlan: The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled |
protectionMode DdosSettings_ProtectionMode_STATUS |
ProtectionMode: The DDoS protection mode of the public IP |
Delegation
(Appears on:VirtualNetworksSubnet_Spec)
Details the service to which the subnet is delegated.
Field | Description |
---|---|
name string |
Name: The name of the resource that is unique within a subnet. This name can be used to access the resource. |
serviceName string |
ServiceName: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). |
Delegation_STATUS
(Appears on:VirtualNetworksSubnet_STATUS)
Details the service to which the subnet is delegated.
Field | Description |
---|---|
actions []string |
Actions: The actions permitted to the service upon delegation. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
name string |
Name: The name of the resource that is unique within a subnet. This name can be used to access the resource. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the service delegation resource. |
serviceName string |
ServiceName: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). |
type string |
Type: Resource type. |
DhGroup
(string
alias)
(Appears on:IpsecPolicy)
The DH Groups used in IKE Phase 1 for initial SA.
Value | Description |
---|---|
"DHGroup1" |
|
"DHGroup14" |
|
"DHGroup2" |
|
"DHGroup2048" |
|
"DHGroup24" |
|
"ECP256" |
|
"ECP384" |
|
"None" |
DhGroup_STATUS
(string
alias)
(Appears on:IpsecPolicy_STATUS)
The DH Groups used in IKE Phase 1 for initial SA.
Value | Description |
---|---|
"DHGroup1" |
|
"DHGroup14" |
|
"DHGroup2" |
|
"DHGroup2048" |
|
"DHGroup24" |
|
"ECP256" |
|
"ECP384" |
|
"None" |
DhcpOptions
(Appears on:VirtualNetwork_Spec)
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.
Field | Description |
---|---|
dnsServers []string |
DnsServers: The list of DNS servers IP addresses. |
DhcpOptions_STATUS
(Appears on:VirtualNetwork_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.
Field | Description |
---|---|
dnsServers []string |
DnsServers: The list of DNS servers IP addresses. |
ExtendedLocation
(Appears on:LoadBalancer_Spec, NetworkInterface_Spec, PrivateEndpoint_Spec, PrivateLinkService_Spec, PublicIPAddress_Spec, PublicIPPrefix_Spec, VirtualNetworkGateway_Spec, VirtualNetwork_Spec)
ExtendedLocation complex type.
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType |
Type: The type of the extended location. |
ExtendedLocationType
(string
alias)
(Appears on:ExtendedLocation)
The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources.
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocationType_STATUS
(string
alias)
(Appears on:ExtendedLocation_STATUS)
The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Network resources.
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocation_STATUS
(Appears on:LoadBalancer_STATUS, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded, PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded, PublicIPAddress_STATUS, PublicIPPrefix_STATUS, VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded, VirtualNetwork_STATUS)
ExtendedLocation complex type.
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType_STATUS |
Type: The type of the extended location. |
FlowLog_STATUS_SubResourceEmbedded
(Appears on:VirtualNetwork_STATUS)
A flow log resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded
(Appears on:LoadBalancer_Spec)
Frontend IP address of the load balancer.
Field | Description |
---|---|
gatewayLoadBalancer SubResource |
GatewayLoadBalancer: The reference to gateway load balancer frontend IP. |
name string |
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. |
privateIPAddress string |
PrivateIPAddress: The private IP address of the IP configuration. |
privateIPAddressVersion IPVersion |
PrivateIPAddressVersion: Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. |
privateIPAllocationMethod IPAllocationMethod |
PrivateIPAllocationMethod: The Private IP allocation method. |
publicIPAddress PublicIPAddressSpec_LoadBalancer_SubResourceEmbedded |
PublicIPAddress: The reference to the Public IP resource. |
publicIPPrefix SubResource |
PublicIPPrefix: The reference to the Public IP Prefix resource. |
subnet Subnet_LoadBalancer_SubResourceEmbedded |
Subnet: The reference to the subnet resource. |
zones []string |
Zones: A list of availability zones denoting the IP allocated for the resource needs to come from. |
FrontendIPConfiguration_PrivateLinkService_SubResourceEmbedded
(Appears on:PrivateLinkService_Spec)
Frontend IP address of the load balancer.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded
(Appears on:LoadBalancer_STATUS)
Frontend IP address of the load balancer.
Field | Description |
---|---|
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
gatewayLoadBalancer SubResource_STATUS |
GatewayLoadBalancer: The reference to gateway load balancer frontend IP. |
id string |
Id: Resource ID. |
inboundNatPools []SubResource_STATUS |
InboundNatPools: An array of references to inbound pools that use this frontend IP. |
inboundNatRules []SubResource_STATUS |
InboundNatRules: An array of references to inbound rules that use this frontend IP. |
loadBalancingRules []SubResource_STATUS |
LoadBalancingRules: An array of references to load balancing rules that use this frontend IP. |
name string |
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. |
outboundRules []SubResource_STATUS |
OutboundRules: An array of references to outbound rules that use this frontend IP. |
privateIPAddress string |
PrivateIPAddress: The private IP address of the IP configuration. |
privateIPAddressVersion IPVersion_STATUS |
PrivateIPAddressVersion: Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. |
privateIPAllocationMethod IPAllocationMethod_STATUS |
PrivateIPAllocationMethod: The Private IP allocation method. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the frontend IP configuration resource. |
publicIPAddress PublicIPAddress_STATUS_LoadBalancer_SubResourceEmbedded |
PublicIPAddress: The reference to the Public IP resource. |
publicIPPrefix SubResource_STATUS |
PublicIPPrefix: The reference to the Public IP Prefix resource. |
subnet Subnet_STATUS_LoadBalancer_SubResourceEmbedded |
Subnet: The reference to the subnet resource. |
type string |
Type: Type of the resource. |
zones []string |
Zones: A list of availability zones denoting the IP allocated for the resource needs to come from. |
FrontendIPConfiguration_STATUS_PrivateLinkService_SubResourceEmbedded
(Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)
Frontend IP address of the load balancer.
Field | Description |
---|---|
id string |
Id: Resource ID. |
GatewayLoadBalancerTunnelInterface
(Appears on:BackendAddressPool_LoadBalancer_SubResourceEmbedded)
Gateway load balancer tunnel interface of a load balancer backend address pool.
Field | Description |
---|---|
identifier int |
Identifier: Identifier of gateway load balancer tunnel interface. |
port int |
Port: Port of gateway load balancer tunnel interface. |
protocol GatewayLoadBalancerTunnelInterface_Protocol |
Protocol: Protocol of gateway load balancer tunnel interface. |
type GatewayLoadBalancerTunnelInterface_Type |
Type: Traffic type of gateway load balancer tunnel interface. |
GatewayLoadBalancerTunnelInterface_Protocol
(string
alias)
(Appears on:GatewayLoadBalancerTunnelInterface)
Value | Description |
---|---|
"Native" |
|
"None" |
|
"VXLAN" |
GatewayLoadBalancerTunnelInterface_Protocol_STATUS
(string
alias)
(Appears on:GatewayLoadBalancerTunnelInterface_STATUS)
Value | Description |
---|---|
"Native" |
|
"None" |
|
"VXLAN" |
GatewayLoadBalancerTunnelInterface_STATUS
(Appears on:BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded)
Gateway load balancer tunnel interface of a load balancer backend address pool.
Field | Description |
---|---|
identifier int |
Identifier: Identifier of gateway load balancer tunnel interface. |
port int |
Port: Port of gateway load balancer tunnel interface. |
protocol GatewayLoadBalancerTunnelInterface_Protocol_STATUS |
Protocol: Protocol of gateway load balancer tunnel interface. |
type GatewayLoadBalancerTunnelInterface_Type_STATUS |
Type: Traffic type of gateway load balancer tunnel interface. |
GatewayLoadBalancerTunnelInterface_Type
(string
alias)
(Appears on:GatewayLoadBalancerTunnelInterface)
Value | Description |
---|---|
"External" |
|
"Internal" |
|
"None" |
GatewayLoadBalancerTunnelInterface_Type_STATUS
(string
alias)
(Appears on:GatewayLoadBalancerTunnelInterface_STATUS)
Value | Description |
---|---|
"External" |
|
"Internal" |
|
"None" |
IPAllocationMethod
(string
alias)
(Appears on:BastionHostIPConfiguration, FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded, PrivateLinkServiceIpConfiguration, PublicIPAddress_Spec, VirtualNetworkGatewayIPConfiguration)
IP address allocation method.
Value | Description |
---|---|
"Dynamic" |
|
"Static" |
IPAllocationMethod_STATUS
(string
alias)
(Appears on:FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, PrivateLinkServiceIpConfiguration_STATUS, PublicIPAddress_STATUS, VirtualNetworkGatewayIPConfiguration_STATUS)
IP address allocation method.
Value | Description |
---|---|
"Dynamic" |
|
"Static" |
IPConfigurationBgpPeeringAddress
(Appears on:BgpSettings)
Properties of IPConfigurationBgpPeeringAddress.
Field | Description |
---|---|
customBgpIpAddresses []string |
CustomBgpIpAddresses: The list of custom BGP peering addresses which belong to IP configuration. |
ipconfigurationId string |
IpconfigurationId: The ID of IP configuration which belongs to gateway. |
IPConfigurationBgpPeeringAddress_STATUS
(Appears on:BgpSettings_STATUS)
Properties of IPConfigurationBgpPeeringAddress.
Field | Description |
---|---|
customBgpIpAddresses []string |
CustomBgpIpAddresses: The list of custom BGP peering addresses which belong to IP configuration. |
defaultBgpIpAddresses []string |
DefaultBgpIpAddresses: The list of default BGP peering addresses which belong to IP configuration. |
ipconfigurationId string |
IpconfigurationId: The ID of IP configuration which belongs to gateway. |
tunnelIpAddresses []string |
TunnelIpAddresses: The list of tunnel public IP addresses which belong to IP configuration. |
IPConfigurationProfile_STATUS
(Appears on:VirtualNetworksSubnet_STATUS)
IP configuration profile child resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
IPConfiguration_STATUS_PublicIPAddress_SubResourceEmbedded
(Appears on:PublicIPAddress_STATUS)
IP configuration.
Field | Description |
---|---|
id string |
Id: Resource ID. |
IPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded
(Appears on:VirtualNetworksSubnet_STATUS)
IP configuration.
Field | Description |
---|---|
id string |
Id: Resource ID. |
IPRule
(Appears on:BastionHostPropertiesFormat_NetworkAcls)
Field | Description |
---|---|
addressPrefix string |
AddressPrefix: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. |
IPRule_STATUS
(Appears on:BastionHostPropertiesFormat_NetworkAcls_STATUS)
Field | Description |
---|---|
addressPrefix string |
AddressPrefix: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. |
IPVersion
(string
alias)
(Appears on:FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded, PrivateLinkServiceIpConfiguration, PublicIPAddress_Spec, PublicIPPrefix_Spec)
IP address version.
Value | Description |
---|---|
"IPv4" |
|
"IPv6" |
IPVersion_STATUS
(string
alias)
(Appears on:FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, PrivateLinkServiceIpConfiguration_STATUS, PublicIPAddress_STATUS, PublicIPPrefix_STATUS)
IP address version.
Value | Description |
---|---|
"IPv4" |
|
"IPv6" |
IkeEncryption
(string
alias)
(Appears on:IpsecPolicy)
The IKE encryption algorithm (IKE phase 2).
Value | Description |
---|---|
"AES128" |
|
"AES192" |
|
"AES256" |
|
"DES" |
|
"DES3" |
|
"GCMAES128" |
|
"GCMAES256" |
IkeEncryption_STATUS
(string
alias)
(Appears on:IpsecPolicy_STATUS)
The IKE encryption algorithm (IKE phase 2).
Value | Description |
---|---|
"AES128" |
|
"AES192" |
|
"AES256" |
|
"DES" |
|
"DES3" |
|
"GCMAES128" |
|
"GCMAES256" |
IkeIntegrity
(string
alias)
(Appears on:IpsecPolicy)
The IKE integrity algorithm (IKE phase 2).
Value | Description |
---|---|
"GCMAES128" |
|
"GCMAES256" |
|
"MD5" |
|
"SHA1" |
|
"SHA256" |
|
"SHA384" |
IkeIntegrity_STATUS
(string
alias)
(Appears on:IpsecPolicy_STATUS)
The IKE integrity algorithm (IKE phase 2).
Value | Description |
---|---|
"GCMAES128" |
|
"GCMAES256" |
|
"MD5" |
|
"SHA1" |
|
"SHA256" |
|
"SHA384" |
InboundNatPool
(Appears on:LoadBalancer_Spec)
Inbound NAT pool of the load balancer.
Field | Description |
---|---|
backendPort int |
BackendPort: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. |
enableFloatingIP bool |
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. |
enableTcpReset bool |
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. |
frontendIPConfiguration SubResource |
FrontendIPConfiguration: A reference to frontend IP addresses. |
frontendPortRangeEnd int |
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. |
frontendPortRangeStart int |
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. |
idleTimeoutInMinutes int |
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. |
name string |
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. |
protocol TransportProtocol |
Protocol: The reference to the transport protocol used by the inbound NAT pool. |
InboundNatPool_STATUS
(Appears on:LoadBalancer_STATUS)
Inbound NAT pool of the load balancer.
Field | Description |
---|---|
backendPort int |
BackendPort: The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. |
enableFloatingIP bool |
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. |
enableTcpReset bool |
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. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
frontendIPConfiguration SubResource_STATUS |
FrontendIPConfiguration: A reference to frontend IP addresses. |
frontendPortRangeEnd int |
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. |
frontendPortRangeStart int |
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. |
id string |
Id: Resource ID. |
idleTimeoutInMinutes int |
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. |
name string |
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. |
protocol TransportProtocol_STATUS |
Protocol: The reference to the transport protocol used by the inbound NAT pool. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the inbound NAT pool resource. |
type string |
Type: Type of the resource. |
InboundNatRule_LoadBalancer_SubResourceEmbedded
(Appears on:LoadBalancer_Spec)
Inbound NAT rule of the load balancer.
Field | Description |
---|---|
backendAddressPool SubResource |
BackendAddressPool: A reference to backendAddressPool resource. |
backendPort int |
BackendPort: The port used for the internal endpoint. Acceptable values range from 1 to 65535. |
enableFloatingIP bool |
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. |
enableTcpReset bool |
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. |
frontendIPConfiguration SubResource |
FrontendIPConfiguration: A reference to frontend IP addresses. |
frontendPort int |
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. |
frontendPortRangeEnd int |
FrontendPortRangeEnd: The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. |
frontendPortRangeStart int |
FrontendPortRangeStart: The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. |
idleTimeoutInMinutes int |
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. |
name string |
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. |
protocol TransportProtocol |
Protocol: The reference to the transport protocol used by the load balancing rule. |
InboundNatRule_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)
Inbound NAT rule of the load balancer.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded
(Appears on:LoadBalancer_STATUS)
Inbound NAT rule of the load balancer.
Field | Description |
---|---|
backendAddressPool SubResource_STATUS |
BackendAddressPool: A reference to backendAddressPool resource. |
backendIPConfiguration NetworkInterfaceIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded |
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. |
backendPort int |
BackendPort: The port used for the internal endpoint. Acceptable values range from 1 to 65535. |
enableFloatingIP bool |
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. |
enableTcpReset bool |
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. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
frontendIPConfiguration SubResource_STATUS |
FrontendIPConfiguration: A reference to frontend IP addresses. |
frontendPort int |
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. |
frontendPortRangeEnd int |
FrontendPortRangeEnd: The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. |
frontendPortRangeStart int |
FrontendPortRangeStart: The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. |
id string |
Id: Resource ID. |
idleTimeoutInMinutes int |
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. |
name string |
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. |
protocol TransportProtocol_STATUS |
Protocol: The reference to the transport protocol used by the load balancing rule. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the inbound NAT rule resource. |
type string |
Type: Type of the resource. |
InboundNatRule_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)
Inbound NAT rule of the load balancer.
Field | Description |
---|---|
id string |
Id: Resource ID. |
IpTag
(Appears on:PublicIPAddress_Spec, PublicIPPrefix_Spec)
Contains the IpTag associated with the object.
Field | Description |
---|---|
ipTagType string |
IpTagType: The IP tag type. Example: FirstPartyUsage. |
tag string |
Tag: The value of the IP tag associated with the public IP. Example: SQL. |
IpTag_STATUS
(Appears on:PublicIPAddress_STATUS, PublicIPPrefix_STATUS)
Contains the IpTag associated with the object.
Field | Description |
---|---|
ipTagType string |
IpTagType: The IP tag type. Example: FirstPartyUsage. |
tag string |
Tag: The value of the IP tag associated with the public IP. Example: SQL. |
IpsecEncryption
(string
alias)
(Appears on:IpsecPolicy)
The IPSec encryption algorithm (IKE phase 1).
Value | Description |
---|---|
"AES128" |
|
"AES192" |
|
"AES256" |
|
"DES" |
|
"DES3" |
|
"GCMAES128" |
|
"GCMAES192" |
|
"GCMAES256" |
|
"None" |
IpsecEncryption_STATUS
(string
alias)
(Appears on:IpsecPolicy_STATUS)
The IPSec encryption algorithm (IKE phase 1).
Value | Description |
---|---|
"AES128" |
|
"AES192" |
|
"AES256" |
|
"DES" |
|
"DES3" |
|
"GCMAES128" |
|
"GCMAES192" |
|
"GCMAES256" |
|
"None" |
IpsecIntegrity
(string
alias)
(Appears on:IpsecPolicy)
The IPSec integrity algorithm (IKE phase 1).
Value | Description |
---|---|
"GCMAES128" |
|
"GCMAES192" |
|
"GCMAES256" |
|
"MD5" |
|
"SHA1" |
|
"SHA256" |
IpsecIntegrity_STATUS
(string
alias)
(Appears on:IpsecPolicy_STATUS)
The IPSec integrity algorithm (IKE phase 1).
Value | Description |
---|---|
"GCMAES128" |
|
"GCMAES192" |
|
"GCMAES256" |
|
"MD5" |
|
"SHA1" |
|
"SHA256" |
IpsecPolicy
(Appears on:VpnClientConfiguration)
An IPSec Policy configuration for a virtual network gateway connection.
Field | Description |
---|---|
dhGroup DhGroup |
DhGroup: The DH Group used in IKE Phase 1 for initial SA. |
ikeEncryption IkeEncryption |
IkeEncryption: The IKE encryption algorithm (IKE phase 2). |
ikeIntegrity IkeIntegrity |
IkeIntegrity: The IKE integrity algorithm (IKE phase 2). |
ipsecEncryption IpsecEncryption |
IpsecEncryption: The IPSec encryption algorithm (IKE phase 1). |
ipsecIntegrity IpsecIntegrity |
IpsecIntegrity: The IPSec integrity algorithm (IKE phase 1). |
pfsGroup PfsGroup |
PfsGroup: The Pfs Group used in IKE Phase 2 for new child SA. |
saDataSizeKilobytes int |
SaDataSizeKilobytes: The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. |
saLifeTimeSeconds int |
SaLifeTimeSeconds: The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. |
IpsecPolicy_STATUS
(Appears on:VpnClientConfiguration_STATUS)
An IPSec Policy configuration for a virtual network gateway connection.
Field | Description |
---|---|
dhGroup DhGroup_STATUS |
DhGroup: The DH Group used in IKE Phase 1 for initial SA. |
ikeEncryption IkeEncryption_STATUS |
IkeEncryption: The IKE encryption algorithm (IKE phase 2). |
ikeIntegrity IkeIntegrity_STATUS |
IkeIntegrity: The IKE integrity algorithm (IKE phase 2). |
ipsecEncryption IpsecEncryption_STATUS |
IpsecEncryption: The IPSec encryption algorithm (IKE phase 1). |
ipsecIntegrity IpsecIntegrity_STATUS |
IpsecIntegrity: The IPSec integrity algorithm (IKE phase 1). |
pfsGroup PfsGroup_STATUS |
PfsGroup: The Pfs Group used in IKE Phase 2 for new child SA. |
saDataSizeKilobytes int |
SaDataSizeKilobytes: The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. |
saLifeTimeSeconds int |
SaLifeTimeSeconds: The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. |
LoadBalancer
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/loadBalancer.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}p>
Field | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||
spec LoadBalancer_Spec |
|
||||||||||||||||||||||||||||
status LoadBalancer_STATUS |
LoadBalancerBackendAddress
(Appears on:BackendAddressPool_LoadBalancer_SubResourceEmbedded)
Load balancer backend addresses.
Field | Description |
---|---|
adminState LoadBalancerBackendAddressPropertiesFormat_AdminState |
AdminState: A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections. |
ipAddress string |
IpAddress: IP Address belonging to the referenced virtual network. |
loadBalancerFrontendIPConfiguration SubResource |
LoadBalancerFrontendIPConfiguration: Reference to the frontend ip address configuration defined in regional loadbalancer. |
name string |
Name: Name of the backend address. |
subnet SubResource |
Subnet: Reference to an existing subnet. |
virtualNetwork SubResource |
VirtualNetwork: Reference to an existing virtual network. |
LoadBalancerBackendAddressPropertiesFormat_AdminState
(string
alias)
(Appears on:LoadBalancerBackendAddress)
Value | Description |
---|---|
"Down" |
|
"None" |
|
"Up" |
LoadBalancerBackendAddressPropertiesFormat_AdminState_STATUS
(string
alias)
(Appears on:LoadBalancerBackendAddress_STATUS)
Value | Description |
---|---|
"Down" |
|
"None" |
|
"Up" |
LoadBalancerBackendAddress_STATUS
(Appears on:BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded)
Load balancer backend addresses.
Field | Description |
---|---|
adminState LoadBalancerBackendAddressPropertiesFormat_AdminState_STATUS |
AdminState: A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections. |
inboundNatRulesPortMapping []NatRulePortMapping_STATUS |
InboundNatRulesPortMapping: Collection of inbound NAT rule port mappings. |
ipAddress string |
IpAddress: IP Address belonging to the referenced virtual network. |
loadBalancerFrontendIPConfiguration SubResource_STATUS |
LoadBalancerFrontendIPConfiguration: Reference to the frontend ip address configuration defined in regional loadbalancer. |
name string |
Name: Name of the backend address. |
networkInterfaceIPConfiguration SubResource_STATUS |
NetworkInterfaceIPConfiguration: Reference to IP address defined in network interfaces. |
subnet SubResource_STATUS |
Subnet: Reference to an existing subnet. |
virtualNetwork SubResource_STATUS |
VirtualNetwork: Reference to an existing virtual network. |
LoadBalancerOperatorSpec
(Appears on:LoadBalancer_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
LoadBalancerSku
(Appears on:LoadBalancer_Spec)
SKU of a load balancer.
Field | Description |
---|---|
name LoadBalancerSku_Name |
Name: Name of a load balancer SKU. |
tier LoadBalancerSku_Tier |
Tier: Tier of a load balancer SKU. |
LoadBalancerSku_Name
(string
alias)
(Appears on:LoadBalancerSku)
Value | Description |
---|---|
"Basic" |
|
"Gateway" |
|
"Standard" |
LoadBalancerSku_Name_STATUS
(string
alias)
(Appears on:LoadBalancerSku_STATUS)
Value | Description |
---|---|
"Basic" |
|
"Gateway" |
|
"Standard" |
LoadBalancerSku_STATUS
(Appears on:LoadBalancer_STATUS)
SKU of a load balancer.
Field | Description |
---|---|
name LoadBalancerSku_Name_STATUS |
Name: Name of a load balancer SKU. |
tier LoadBalancerSku_Tier_STATUS |
Tier: Tier of a load balancer SKU. |
LoadBalancerSku_Tier
(string
alias)
(Appears on:LoadBalancerSku)
Value | Description |
---|---|
"Global" |
|
"Regional" |
LoadBalancerSku_Tier_STATUS
(string
alias)
(Appears on:LoadBalancerSku_STATUS)
Value | Description |
---|---|
"Global" |
|
"Regional" |
LoadBalancer_STATUS
(Appears on:LoadBalancer)
LoadBalancer resource.
Field | Description |
---|---|
backendAddressPools []BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded |
BackendAddressPools: Collection of backend address pools used by a load balancer. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
extendedLocation ExtendedLocation_STATUS |
ExtendedLocation: The extended location of the load balancer. |
frontendIPConfigurations []FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded |
FrontendIPConfigurations: Object representing the frontend IPs to be used for the load balancer. |
id string |
Id: Resource ID. |
inboundNatPools []InboundNatPool_STATUS |
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. |
inboundNatRules []InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded |
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. |
loadBalancingRules []LoadBalancingRule_STATUS |
LoadBalancingRules: Object collection representing the load balancing rules Gets the provisioning. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
outboundRules []OutboundRule_STATUS |
OutboundRules: The outbound rules. |
probes []Probe_STATUS |
Probes: Collection of probe objects used in the load balancer. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the load balancer resource. |
resourceGuid string |
ResourceGuid: The resource GUID property of the load balancer resource. |
sku LoadBalancerSku_STATUS |
Sku: The load balancer SKU. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
LoadBalancer_Spec
(Appears on:LoadBalancer)
Field | Description |
---|---|
azureName string |
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. |
backendAddressPools []BackendAddressPool_LoadBalancer_SubResourceEmbedded |
BackendAddressPools: Collection of backend address pools used by a load balancer. |
extendedLocation ExtendedLocation |
ExtendedLocation: The extended location of the load balancer. |
frontendIPConfigurations []FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded |
FrontendIPConfigurations: Object representing the frontend IPs to be used for the load balancer. |
inboundNatPools []InboundNatPool |
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. |
inboundNatRules []InboundNatRule_LoadBalancer_SubResourceEmbedded |
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. |
loadBalancingRules []LoadBalancingRule |
LoadBalancingRules: Object collection representing the load balancing rules Gets the provisioning. |
location string |
Location: Resource location. |
operatorSpec LoadBalancerOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
outboundRules []OutboundRule |
OutboundRules: The outbound rules. |
owner genruntime.KnownResourceReference |
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 |
probes []Probe |
Probes: Collection of probe objects used in the load balancer. |
sku LoadBalancerSku |
Sku: The load balancer SKU. |
tags map[string]string |
Tags: Resource tags. |
LoadBalancersInboundNatRule
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/loadBalancer.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}p>
Field | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||
spec LoadBalancersInboundNatRule_Spec |
|
||||||||||||||||||||||||||
status LoadBalancersInboundNatRule_STATUS |
LoadBalancersInboundNatRuleOperatorSpec
(Appears on:LoadBalancersInboundNatRule_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
LoadBalancersInboundNatRule_STATUS
(Appears on:LoadBalancersInboundNatRule)
Field | Description |
---|---|
backendAddressPool SubResource_STATUS |
BackendAddressPool: A reference to backendAddressPool resource. |
backendIPConfiguration NetworkInterfaceIPConfiguration_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded |
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. |
backendPort int |
BackendPort: The port used for the internal endpoint. Acceptable values range from 1 to 65535. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
enableFloatingIP bool |
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. |
enableTcpReset bool |
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. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
frontendIPConfiguration SubResource_STATUS |
FrontendIPConfiguration: A reference to frontend IP addresses. |
frontendPort int |
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. |
frontendPortRangeEnd int |
FrontendPortRangeEnd: The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. |
frontendPortRangeStart int |
FrontendPortRangeStart: The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. |
id string |
Id: Resource ID. |
idleTimeoutInMinutes int |
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. |
name string |
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. |
protocol TransportProtocol_STATUS |
Protocol: The reference to the transport protocol used by the load balancing rule. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the inbound NAT rule resource. |
type string |
Type: Type of the resource. |
LoadBalancersInboundNatRule_Spec
(Appears on:LoadBalancersInboundNatRule)
Field | Description |
---|---|
azureName string |
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. |
backendAddressPool SubResource |
BackendAddressPool: A reference to backendAddressPool resource. |
backendPort int |
BackendPort: The port used for the internal endpoint. Acceptable values range from 1 to 65535. |
enableFloatingIP bool |
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. |
enableTcpReset bool |
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. |
frontendIPConfiguration SubResource |
FrontendIPConfiguration: A reference to frontend IP addresses. |
frontendPort int |
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. |
frontendPortRangeEnd int |
FrontendPortRangeEnd: The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. |
frontendPortRangeStart int |
FrontendPortRangeStart: The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. |
idleTimeoutInMinutes int |
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. |
operatorSpec LoadBalancersInboundNatRuleOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
protocol TransportProtocol |
Protocol: The reference to the transport protocol used by the load balancing rule. |
LoadBalancingRule
(Appears on:LoadBalancer_Spec)
A load balancing rule for a load balancer.
Field | Description |
---|---|
backendAddressPool SubResource |
BackendAddressPool: A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. |
backendAddressPools []SubResource |
BackendAddressPools: An array of references to pool of DIPs. |
backendPort int |
BackendPort: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables “Any Port”. |
disableOutboundSnat bool |
DisableOutboundSnat: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. |
enableFloatingIP bool |
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. |
enableTcpReset bool |
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. |
frontendIPConfiguration SubResource |
FrontendIPConfiguration: A reference to frontend IP addresses. |
frontendPort int |
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”. |
idleTimeoutInMinutes int |
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. |
loadDistribution LoadBalancingRulePropertiesFormat_LoadDistribution |
LoadDistribution: The load distribution policy for this rule. |
name string |
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. |
probe SubResource |
Probe: The reference to the load balancer probe used by the load balancing rule. |
protocol TransportProtocol |
Protocol: The reference to the transport protocol used by the load balancing rule. |
LoadBalancingRulePropertiesFormat_LoadDistribution
(string
alias)
(Appears on:LoadBalancingRule)
Value | Description |
---|---|
"Default" |
|
"SourceIP" |
|
"SourceIPProtocol" |
LoadBalancingRulePropertiesFormat_LoadDistribution_STATUS
(string
alias)
(Appears on:LoadBalancingRule_STATUS)
Value | Description |
---|---|
"Default" |
|
"SourceIP" |
|
"SourceIPProtocol" |
LoadBalancingRule_STATUS
(Appears on:LoadBalancer_STATUS)
A load balancing rule for a load balancer.
Field | Description |
---|---|
backendAddressPool SubResource_STATUS |
BackendAddressPool: A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. |
backendAddressPools []SubResource_STATUS |
BackendAddressPools: An array of references to pool of DIPs. |
backendPort int |
BackendPort: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables “Any Port”. |
disableOutboundSnat bool |
DisableOutboundSnat: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. |
enableFloatingIP bool |
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. |
enableTcpReset bool |
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. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
frontendIPConfiguration SubResource_STATUS |
FrontendIPConfiguration: A reference to frontend IP addresses. |
frontendPort int |
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”. |
id string |
Id: Resource ID. |
idleTimeoutInMinutes int |
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. |
loadDistribution LoadBalancingRulePropertiesFormat_LoadDistribution_STATUS |
LoadDistribution: The load distribution policy for this rule. |
name string |
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. |
probe SubResource_STATUS |
Probe: The reference to the load balancer probe used by the load balancing rule. |
protocol TransportProtocol_STATUS |
Protocol: The reference to the transport protocol used by the load balancing rule. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the load balancing rule resource. |
type string |
Type: Type of the resource. |
ManagedServiceIdentity
(Appears on:VirtualNetworkGateway_Spec)
Identity for the resource.
Field | Description |
---|---|
type ManagedServiceIdentity_Type |
Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine. |
userAssignedIdentities []UserAssignedIdentityDetails |
UserAssignedIdentities: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.p> |
ManagedServiceIdentity_STATUS
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
Identity for the resource.
Field | Description |
---|---|
principalId string |
PrincipalId: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId string |
TenantId: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. |
type ManagedServiceIdentity_Type_STATUS |
Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine. |
userAssignedIdentities map[string]./api/network/v1api20240301.ManagedServiceIdentity_UserAssignedIdentities_STATUS |
UserAssignedIdentities: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.p> |
ManagedServiceIdentity_Type
(string
alias)
(Appears on:ManagedServiceIdentity)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
ManagedServiceIdentity_Type_STATUS
(string
alias)
(Appears on:ManagedServiceIdentity_STATUS)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
ManagedServiceIdentity_UserAssignedIdentities_STATUS
(Appears on:ManagedServiceIdentity_STATUS)
Field | Description |
---|---|
clientId string |
ClientId: The client id of user assigned identity. |
principalId string |
PrincipalId: The principal id of user assigned identity. |
NatGateway
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/natGateway.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}p>
Field | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||
spec NatGateway_Spec |
|
||||||||||||||||||||
status NatGateway_STATUS |
NatGatewayOperatorSpec
(Appears on:NatGateway_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
NatGatewaySku
(Appears on:NatGateway_Spec)
SKU of nat gateway.
Field | Description |
---|---|
name NatGatewaySku_Name |
Name: Name of Nat Gateway SKU. |
NatGatewaySku_Name
(string
alias)
(Appears on:NatGatewaySku)
Value | Description |
---|---|
"Standard" |
NatGatewaySku_Name_STATUS
(string
alias)
(Appears on:NatGatewaySku_STATUS)
Value | Description |
---|---|
"Standard" |
NatGatewaySku_STATUS
(Appears on:NatGateway_STATUS)
SKU of nat gateway.
Field | Description |
---|---|
name NatGatewaySku_Name_STATUS |
Name: Name of Nat Gateway SKU. |
NatGatewaySpec_PublicIPAddress_SubResourceEmbedded
(Appears on:PublicIPAddress_Spec)
Nat Gateway resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
NatGatewaySpec_PublicIPPrefix_SubResourceEmbedded
(Appears on:PublicIPPrefix_Spec)
Nat Gateway resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
NatGateway_STATUS
(Appears on:NatGateway)
Nat Gateway resource.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
idleTimeoutInMinutes int |
IdleTimeoutInMinutes: The idle timeout of the nat gateway. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the NAT gateway resource. |
publicIpAddresses []SubResource_STATUS |
PublicIpAddresses: An array of public ip addresses associated with the nat gateway resource. |
publicIpPrefixes []SubResource_STATUS |
PublicIpPrefixes: An array of public ip prefixes associated with the nat gateway resource. |
resourceGuid string |
ResourceGuid: The resource GUID property of the NAT gateway resource. |
sku NatGatewaySku_STATUS |
Sku: The nat gateway SKU. |
subnets []SubResource_STATUS |
Subnets: An array of references to the subnets using this nat gateway resource. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
zones []string |
Zones: A list of availability zones denoting the zone in which Nat Gateway should be deployed. |
NatGateway_STATUS_PublicIPAddress_SubResourceEmbedded
(Appears on:PublicIPAddress_STATUS)
Nat Gateway resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
NatGateway_STATUS_PublicIPPrefix_SubResourceEmbedded
(Appears on:PublicIPPrefix_STATUS)
Nat Gateway resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
NatGateway_Spec
(Appears on:NatGateway)
Field | Description |
---|---|
azureName string |
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. |
idleTimeoutInMinutes int |
IdleTimeoutInMinutes: The idle timeout of the nat gateway. |
location string |
Location: Resource location. |
operatorSpec NatGatewayOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
publicIpAddresses []SubResource |
PublicIpAddresses: An array of public ip addresses associated with the nat gateway resource. |
publicIpPrefixes []SubResource |
PublicIpPrefixes: An array of public ip prefixes associated with the nat gateway resource. |
sku NatGatewaySku |
Sku: The nat gateway SKU. |
tags map[string]string |
Tags: Resource tags. |
zones []string |
Zones: A list of availability zones denoting the zone in which Nat Gateway should be deployed. |
NatRulePortMapping_STATUS
(Appears on:LoadBalancerBackendAddress_STATUS)
Individual port mappings for inbound NAT rule created for backend pool.
Field | Description |
---|---|
backendPort int |
BackendPort: Backend port. |
frontendPort int |
FrontendPort: Frontend port. |
inboundNatRuleName string |
InboundNatRuleName: Name of inbound NAT rule. |
NetworkInterface
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/networkInterface.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}p>
Field | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||
spec NetworkInterface_Spec |
|
||||||||||||||||||||||||||||||||||
status NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded |
NetworkInterfaceDnsSettings
(Appears on:NetworkInterface_Spec)
DNS settings of a network interface.
Field | Description |
---|---|
dnsServers []string |
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. |
internalDnsNameLabel string |
InternalDnsNameLabel: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. |
NetworkInterfaceDnsSettings_STATUS
(Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)
DNS settings of a network interface.
Field | Description |
---|---|
appliedDnsServers []string |
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. |
dnsServers []string |
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. |
internalDnsNameLabel string |
InternalDnsNameLabel: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. |
internalDomainNameSuffix string |
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. |
internalFqdn string |
InternalFqdn: Fully qualified DNS name supporting internal communications between VMs in the same virtual network. |
NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties_STATUS
(Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)
PrivateLinkConnection properties for the network interface.
Field | Description |
---|---|
fqdns []string |
Fqdns: List of FQDNs for current private link connection. |
groupId string |
GroupId: The group ID for current private link connection. |
requiredMemberName string |
RequiredMemberName: The required member name for current private link connection. |
NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterface_Spec)
IPConfiguration in a network interface.
Field | Description |
---|---|
applicationGatewayBackendAddressPools []ApplicationGatewayBackendAddressPool_NetworkInterface_SubResourceEmbedded |
ApplicationGatewayBackendAddressPools: The reference to ApplicationGatewayBackendAddressPool resource. |
applicationSecurityGroups []ApplicationSecurityGroupSpec_NetworkInterface_SubResourceEmbedded |
ApplicationSecurityGroups: Application security groups in which the IP configuration is included. |
gatewayLoadBalancer SubResource |
GatewayLoadBalancer: The reference to gateway load balancer frontend IP. |
loadBalancerBackendAddressPools []BackendAddressPool_NetworkInterface_SubResourceEmbedded |
LoadBalancerBackendAddressPools: The reference to LoadBalancerBackendAddressPool resource. |
loadBalancerInboundNatRules []InboundNatRule_NetworkInterface_SubResourceEmbedded |
LoadBalancerInboundNatRules: A list of references of LoadBalancerInboundNatRules. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
primary bool |
Primary: Whether this is a primary customer address on the network interface. |
privateIPAddress string |
PrivateIPAddress: Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format / |
privateIPAddressPrefixLength int |
PrivateIPAddressPrefixLength: The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address. |
privateIPAddressVersion IPVersion |
PrivateIPAddressVersion: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. |
privateIPAllocationMethod IPAllocationMethod |
PrivateIPAllocationMethod: The private IP address allocation method. |
publicIPAddress PublicIPAddressSpec_NetworkInterface_SubResourceEmbedded |
PublicIPAddress: Public IP address bound to the IP configuration. |
subnet Subnet_NetworkInterface_SubResourceEmbedded |
Subnet: Subnet bound to the IP configuration. |
virtualNetworkTaps []VirtualNetworkTapSpec_NetworkInterface_SubResourceEmbedded |
VirtualNetworkTaps: The reference to Virtual Network Taps. |
NetworkInterfaceIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded
(Appears on:BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded)
IPConfiguration in a network interface.
Field | Description |
---|---|
id string |
Id: Resource ID. |
NetworkInterfaceIPConfiguration_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded
(Appears on:LoadBalancersInboundNatRule_STATUS)
IPConfiguration in a network interface.
Field | Description |
---|---|
id string |
Id: Resource ID. |
NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)
IPConfiguration in a network interface.
Field | Description |
---|---|
applicationGatewayBackendAddressPools []ApplicationGatewayBackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded |
ApplicationGatewayBackendAddressPools: The reference to ApplicationGatewayBackendAddressPool resource. |
applicationSecurityGroups []ApplicationSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded |
ApplicationSecurityGroups: Application security groups in which the IP configuration is included. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
gatewayLoadBalancer SubResource_STATUS |
GatewayLoadBalancer: The reference to gateway load balancer frontend IP. |
id string |
Id: Resource ID. |
loadBalancerBackendAddressPools []BackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded |
LoadBalancerBackendAddressPools: The reference to LoadBalancerBackendAddressPool resource. |
loadBalancerInboundNatRules []InboundNatRule_STATUS_NetworkInterface_SubResourceEmbedded |
LoadBalancerInboundNatRules: A list of references of LoadBalancerInboundNatRules. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
primary bool |
Primary: Whether this is a primary customer address on the network interface. |
privateIPAddress string |
PrivateIPAddress: Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format / |
privateIPAddressPrefixLength int |
PrivateIPAddressPrefixLength: The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address. |
privateIPAddressVersion IPVersion_STATUS |
PrivateIPAddressVersion: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. |
privateIPAllocationMethod IPAllocationMethod_STATUS |
PrivateIPAllocationMethod: The private IP address allocation method. |
privateLinkConnectionProperties NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties_STATUS |
PrivateLinkConnectionProperties: PrivateLinkConnection properties for the network interface. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the network interface IP configuration. |
publicIPAddress PublicIPAddress_STATUS_NetworkInterface_SubResourceEmbedded |
PublicIPAddress: Public IP address bound to the IP configuration. |
subnet Subnet_STATUS_NetworkInterface_SubResourceEmbedded |
Subnet: Subnet bound to the IP configuration. |
type string |
Type: Resource type. |
virtualNetworkTaps []VirtualNetworkTap_STATUS_NetworkInterface_SubResourceEmbedded |
VirtualNetworkTaps: The reference to Virtual Network Taps. |
NetworkInterfaceOperatorSpec
(Appears on:NetworkInterface_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
NetworkInterfacePropertiesFormat_AuxiliaryMode
(string
alias)
(Appears on:NetworkInterface_Spec)
Value | Description |
---|---|
"AcceleratedConnections" |
|
"Floating" |
|
"MaxConnections" |
|
"None" |
NetworkInterfacePropertiesFormat_AuxiliaryMode_STATUS
(string
alias)
(Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)
Value | Description |
---|---|
"AcceleratedConnections" |
|
"Floating" |
|
"MaxConnections" |
|
"None" |
NetworkInterfacePropertiesFormat_AuxiliarySku
(string
alias)
(Appears on:NetworkInterface_Spec)
Value | Description |
---|---|
"A1" |
|
"A2" |
|
"A4" |
|
"A8" |
|
"None" |
NetworkInterfacePropertiesFormat_AuxiliarySku_STATUS
(string
alias)
(Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)
Value | Description |
---|---|
"A1" |
|
"A2" |
|
"A4" |
|
"A8" |
|
"None" |
NetworkInterfacePropertiesFormat_MigrationPhase_STATUS
(string
alias)
(Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)
Value | Description |
---|---|
"Abort" |
|
"Commit" |
|
"Committed" |
|
"None" |
|
"Prepare" |
NetworkInterfacePropertiesFormat_NicType
(string
alias)
(Appears on:NetworkInterface_Spec)
Value | Description |
---|---|
"Elastic" |
|
"Standard" |
NetworkInterfacePropertiesFormat_NicType_STATUS
(string
alias)
(Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)
Value | Description |
---|---|
"Elastic" |
|
"Standard" |
NetworkInterfaceTapConfiguration_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)
Tap configuration in a Network Interface.
Field | Description |
---|---|
id string |
Id: Resource ID. |
NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterface)
A network interface in a resource group.
Field | Description |
---|---|
auxiliaryMode NetworkInterfacePropertiesFormat_AuxiliaryMode_STATUS |
AuxiliaryMode: Auxiliary mode of Network Interface resource. |
auxiliarySku NetworkInterfacePropertiesFormat_AuxiliarySku_STATUS |
AuxiliarySku: Auxiliary sku of Network Interface resource. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
disableTcpStateTracking bool |
DisableTcpStateTracking: Indicates whether to disable tcp state tracking. |
dnsSettings NetworkInterfaceDnsSettings_STATUS |
DnsSettings: The DNS settings in network interface. |
dscpConfiguration SubResource_STATUS |
DscpConfiguration: A reference to the dscp configuration to which the network interface is linked. |
enableAcceleratedNetworking bool |
EnableAcceleratedNetworking: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. |
enableIPForwarding bool |
EnableIPForwarding: Indicates whether IP forwarding is enabled on this network interface. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
extendedLocation ExtendedLocation_STATUS |
ExtendedLocation: The extended location of the network interface. |
hostedWorkloads []string |
HostedWorkloads: A list of references to linked BareMetal resources. |
id string |
Id: Resource ID. |
ipConfigurations []NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded |
IpConfigurations: A list of IPConfigurations of the network interface. |
location string |
Location: Resource location. |
macAddress string |
MacAddress: The MAC address of the network interface. |
migrationPhase NetworkInterfacePropertiesFormat_MigrationPhase_STATUS |
MigrationPhase: Migration phase of Network Interface resource. |
name string |
Name: Resource name. |
networkSecurityGroup NetworkSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded |
NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource. |
nicType NetworkInterfacePropertiesFormat_NicType_STATUS |
NicType: Type of Network Interface resource. |
primary bool |
Primary: Whether this is a primary network interface on a virtual machine. |
privateEndpoint PrivateEndpoint_STATUS_NetworkInterface_SubResourceEmbedded |
PrivateEndpoint: A reference to the private endpoint to which the network interface is linked. |
privateLinkService PrivateLinkService_STATUS_NetworkInterface_SubResourceEmbedded |
PrivateLinkService: Privatelinkservice of the network interface resource. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the network interface resource. |
resourceGuid string |
ResourceGuid: The resource GUID property of the network interface resource. |
tags map[string]string |
Tags: Resource tags. |
tapConfigurations []NetworkInterfaceTapConfiguration_STATUS_NetworkInterface_SubResourceEmbedded |
TapConfigurations: A list of TapConfigurations of the network interface. |
type string |
Type: Resource type. |
virtualMachine SubResource_STATUS |
VirtualMachine: The reference to a virtual machine. |
vnetEncryptionSupported bool |
VnetEncryptionSupported: Whether the virtual machine this nic is attached to supports encryption. |
workloadType string |
WorkloadType: WorkloadType of the NetworkInterface for BareMetal resources |
NetworkInterface_STATUS_NetworkSecurityGroup_SubResourceEmbedded
(Appears on:NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded)
A network interface in a resource group.
Field | Description |
---|---|
id string |
Id: Resource ID. |
NetworkInterface_STATUS_PrivateEndpoint_SubResourceEmbedded
(Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)
A network interface in a resource group.
Field | Description |
---|---|
id string |
Id: Resource ID. |
NetworkInterface_STATUS_PrivateLinkService_SubResourceEmbedded
(Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)
A network interface in a resource group.
Field | Description |
---|---|
id string |
Id: Resource ID. |
NetworkInterface_Spec
(Appears on:NetworkInterface)
Field | Description |
---|---|
auxiliaryMode NetworkInterfacePropertiesFormat_AuxiliaryMode |
AuxiliaryMode: Auxiliary mode of Network Interface resource. |
auxiliarySku NetworkInterfacePropertiesFormat_AuxiliarySku |
AuxiliarySku: Auxiliary sku of Network Interface resource. |
azureName string |
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. |
disableTcpStateTracking bool |
DisableTcpStateTracking: Indicates whether to disable tcp state tracking. |
dnsSettings NetworkInterfaceDnsSettings |
DnsSettings: The DNS settings in network interface. |
enableAcceleratedNetworking bool |
EnableAcceleratedNetworking: If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. |
enableIPForwarding bool |
EnableIPForwarding: Indicates whether IP forwarding is enabled on this network interface. |
extendedLocation ExtendedLocation |
ExtendedLocation: The extended location of the network interface. |
ipConfigurations []NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded |
IpConfigurations: A list of IPConfigurations of the network interface. |
location string |
Location: Resource location. |
networkSecurityGroup NetworkSecurityGroupSpec_NetworkInterface_SubResourceEmbedded |
NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource. |
nicType NetworkInterfacePropertiesFormat_NicType |
NicType: Type of Network Interface resource. |
operatorSpec NetworkInterfaceOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
privateLinkService PrivateLinkServiceSpec |
PrivateLinkService: Privatelinkservice of the network interface resource. |
tags map[string]string |
Tags: Resource tags. |
workloadType string |
WorkloadType: WorkloadType of the NetworkInterface for BareMetal resources |
NetworkSecurityGroup
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/networkSecurityGroup.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}p>
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec NetworkSecurityGroup_Spec |
|
||||||||||||
status NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded |
NetworkSecurityGroupOperatorSpec
(Appears on:NetworkSecurityGroup_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
NetworkSecurityGroupSpec_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterface_Spec)
NetworkSecurityGroup resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
NetworkSecurityGroupSpec_VirtualNetworks_Subnet_SubResourceEmbedded
(Appears on:VirtualNetworksSubnet_Spec)
NetworkSecurityGroup resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
NetworkSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)
NetworkSecurityGroup resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded
(Appears on:NetworkSecurityGroup)
NetworkSecurityGroup resource.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
defaultSecurityRules []SecurityRule_STATUS |
DefaultSecurityRules: The default security rules of network security group. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
flushConnection bool |
FlushConnection: When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. |
id string |
Id: Resource ID. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
networkInterfaces []NetworkInterface_STATUS_NetworkSecurityGroup_SubResourceEmbedded |
NetworkInterfaces: A collection of references to network interfaces. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the network security group resource. |
resourceGuid string |
ResourceGuid: The resource GUID property of the network security group resource. |
subnets []Subnet_STATUS_NetworkSecurityGroup_SubResourceEmbedded |
Subnets: A collection of references to subnets. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
NetworkSecurityGroup_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded
(Appears on:VirtualNetworksSubnet_STATUS)
NetworkSecurityGroup resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
NetworkSecurityGroup_Spec
(Appears on:NetworkSecurityGroup)
Field | Description |
---|---|
azureName string |
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. |
flushConnection bool |
FlushConnection: When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. |
location string |
Location: Resource location. |
operatorSpec NetworkSecurityGroupOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
tags map[string]string |
Tags: Resource tags. |
NetworkSecurityGroupsSecurityRule
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/networkSecurityGroup.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||
spec NetworkSecurityGroupsSecurityRule_Spec |
|
||||||||||||||||||||||||||||||||||||
status NetworkSecurityGroupsSecurityRule_STATUS |
NetworkSecurityGroupsSecurityRuleOperatorSpec
(Appears on:NetworkSecurityGroupsSecurityRule_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
NetworkSecurityGroupsSecurityRule_STATUS
(Appears on:NetworkSecurityGroupsSecurityRule)
Field | Description |
---|---|
access SecurityRuleAccess_STATUS |
Access: The network traffic is allowed or denied. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
description string |
Description: A description for this rule. Restricted to 140 chars. |
destinationAddressPrefix string |
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. |
destinationAddressPrefixes []string |
DestinationAddressPrefixes: The destination address prefixes. CIDR or destination IP ranges. |
destinationApplicationSecurityGroups []ApplicationSecurityGroup_STATUS_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded |
DestinationApplicationSecurityGroups: The application security group specified as destination. |
destinationPortRange string |
DestinationPortRange: The destination port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. |
destinationPortRanges []string |
DestinationPortRanges: The destination port ranges. |
direction SecurityRuleDirection_STATUS |
Direction: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
priority int |
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. |
protocol SecurityRulePropertiesFormat_Protocol_STATUS |
Protocol: Network protocol this rule applies to. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the security rule resource. |
sourceAddressPrefix string |
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. |
sourceAddressPrefixes []string |
SourceAddressPrefixes: The CIDR or source IP ranges. |
sourceApplicationSecurityGroups []ApplicationSecurityGroup_STATUS_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded |
SourceApplicationSecurityGroups: The application security group specified as source. |
sourcePortRange string |
SourcePortRange: The source port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. |
sourcePortRanges []string |
SourcePortRanges: The source port ranges. |
type string |
Type: The type of the resource. |
NetworkSecurityGroupsSecurityRule_Spec
(Appears on:NetworkSecurityGroupsSecurityRule)
Field | Description |
---|---|
access SecurityRuleAccess |
Access: The network traffic is allowed or denied. |
azureName string |
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. |
description string |
Description: A description for this rule. Restricted to 140 chars. |
destinationAddressPrefix string |
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. |
destinationAddressPrefixes []string |
DestinationAddressPrefixes: The destination address prefixes. CIDR or destination IP ranges. |
destinationApplicationSecurityGroups []ApplicationSecurityGroupSpec_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded |
DestinationApplicationSecurityGroups: The application security group specified as destination. |
destinationPortRange string |
DestinationPortRange: The destination port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. |
destinationPortRanges []string |
DestinationPortRanges: The destination port ranges. |
direction SecurityRuleDirection |
Direction: The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. |
operatorSpec NetworkSecurityGroupsSecurityRuleOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
priority int |
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. |
protocol SecurityRulePropertiesFormat_Protocol |
Protocol: Network protocol this rule applies to. |
sourceAddressPrefix string |
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. |
sourceAddressPrefixes []string |
SourceAddressPrefixes: The CIDR or source IP ranges. |
sourceApplicationSecurityGroups []ApplicationSecurityGroupSpec_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded |
SourceApplicationSecurityGroups: The application security group specified as source. |
sourcePortRange string |
SourcePortRange: The source port or range. Integer or range between 0 and 65535. Asterisk ‘*’ can also be used to match all ports. |
sourcePortRanges []string |
SourcePortRanges: The source port ranges. |
OutboundRule
(Appears on:LoadBalancer_Spec)
Outbound rule of the load balancer.
Field | Description |
---|---|
allocatedOutboundPorts int |
AllocatedOutboundPorts: The number of outbound ports to be used for NAT. |
backendAddressPool SubResource |
BackendAddressPool: A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. |
enableTcpReset bool |
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. |
frontendIPConfigurations []SubResource |
FrontendIPConfigurations: The Frontend IP addresses of the load balancer. |
idleTimeoutInMinutes int |
IdleTimeoutInMinutes: The timeout for the TCP idle connection. |
name string |
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. |
protocol OutboundRulePropertiesFormat_Protocol |
Protocol: The protocol for the outbound rule in load balancer. |
OutboundRulePropertiesFormat_Protocol
(string
alias)
(Appears on:OutboundRule)
Value | Description |
---|---|
"All" |
|
"Tcp" |
|
"Udp" |
OutboundRulePropertiesFormat_Protocol_STATUS
(string
alias)
(Appears on:OutboundRule_STATUS)
Value | Description |
---|---|
"All" |
|
"Tcp" |
|
"Udp" |
OutboundRule_STATUS
(Appears on:LoadBalancer_STATUS)
Outbound rule of the load balancer.
Field | Description |
---|---|
allocatedOutboundPorts int |
AllocatedOutboundPorts: The number of outbound ports to be used for NAT. |
backendAddressPool SubResource_STATUS |
BackendAddressPool: A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. |
enableTcpReset bool |
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. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
frontendIPConfigurations []SubResource_STATUS |
FrontendIPConfigurations: The Frontend IP addresses of the load balancer. |
id string |
Id: Resource ID. |
idleTimeoutInMinutes int |
IdleTimeoutInMinutes: The timeout for the TCP idle connection. |
name string |
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. |
protocol OutboundRulePropertiesFormat_Protocol_STATUS |
Protocol: The protocol for the outbound rule in load balancer. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the outbound rule resource. |
type string |
Type: Type of the resource. |
PfsGroup
(string
alias)
(Appears on:IpsecPolicy)
The Pfs Groups used in IKE Phase 2 for new child SA.
Value | Description |
---|---|
"ECP256" |
|
"ECP384" |
|
"None" |
|
"PFS1" |
|
"PFS14" |
|
"PFS2" |
|
"PFS2048" |
|
"PFS24" |
|
"PFSMM" |
PfsGroup_STATUS
(string
alias)
(Appears on:IpsecPolicy_STATUS)
The Pfs Groups used in IKE Phase 2 for new child SA.
Value | Description |
---|---|
"ECP256" |
|
"ECP384" |
|
"None" |
|
"PFS1" |
|
"PFS14" |
|
"PFS2" |
|
"PFS2048" |
|
"PFS24" |
|
"PFSMM" |
PrivateDnsZoneConfig
(Appears on:PrivateEndpointsPrivateDnsZoneGroup_Spec)
PrivateDnsZoneConfig resource.
Field | Description |
---|---|
name string |
Name: Name of the resource that is unique within a resource group. This name can be used to access the resource. |
privateDnsZoneReference genruntime.ResourceReference |
PrivateDnsZoneReference: The resource id of the private dns zone. |
PrivateDnsZoneConfig_STATUS
(Appears on:PrivateEndpointsPrivateDnsZoneGroup_STATUS)
PrivateDnsZoneConfig resource.
Field | Description |
---|---|
name string |
Name: Name of the resource that is unique within a resource group. This name can be used to access the resource. |
privateDnsZoneId string |
PrivateDnsZoneId: The resource id of the private dns zone. |
recordSets []RecordSet_STATUS |
RecordSets: A collection of information regarding a recordSet, holding information to identify private resources. |
PrivateEndpoint
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/privateEndpoint.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}p>
Field | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||
spec PrivateEndpoint_Spec |
|
||||||||||||||||||||||||
status PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded |
PrivateEndpointConnection_STATUS
(Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)
PrivateEndpointConnection resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
PrivateEndpointIPConfiguration
(Appears on:PrivateEndpoint_Spec)
An IP Configuration of the private endpoint.
Field | Description |
---|---|
groupId string |
GroupId: The ID of a group obtained from the remote resource that this private endpoint should connect to. |
memberName string |
MemberName: The member name of a group obtained from the remote resource that this private endpoint should connect to. |
name string |
Name: The name of the resource that is unique within a resource group. |
privateIPAddress string |
PrivateIPAddress: A private ip address obtained from the private endpoint’s subnet. |
PrivateEndpointIPConfiguration_STATUS
(Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)
An IP Configuration of the private endpoint.
Field | Description |
---|---|
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
groupId string |
GroupId: The ID of a group obtained from the remote resource that this private endpoint should connect to. |
memberName string |
MemberName: The member name of a group obtained from the remote resource that this private endpoint should connect to. |
name string |
Name: The name of the resource that is unique within a resource group. |
privateIPAddress string |
PrivateIPAddress: A private ip address obtained from the private endpoint’s subnet. |
type string |
Type: The resource type. |
PrivateEndpointOperatorConfigMaps
(Appears on:PrivateEndpointOperatorSpec)
Field | Description |
---|---|
primaryNicPrivateIpAddress genruntime.ConfigMapDestination |
PrimaryNicPrivateIpAddress: indicates where the PrimaryNicPrivateIpAddress config map should be placed. If omitted, no config map will be created. |
PrivateEndpointOperatorSpec
(Appears on:PrivateEndpoint_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
configMaps PrivateEndpointOperatorConfigMaps |
ConfigMaps: configures where to place operator written ConfigMaps. |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
PrivateEndpointVNetPolicies
(string
alias)
(Appears on:VirtualNetwork_Spec)
Private Endpoint VNet Policies.
Value | Description |
---|---|
"Basic" |
|
"Disabled" |
PrivateEndpointVNetPolicies_STATUS
(string
alias)
(Appears on:VirtualNetwork_STATUS)
Private Endpoint VNet Policies.
Value | Description |
---|---|
"Basic" |
|
"Disabled" |
PrivateEndpoint_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)
Private endpoint resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded
(Appears on:PrivateEndpoint)
Private endpoint resource.
Field | Description |
---|---|
applicationSecurityGroups []ApplicationSecurityGroup_STATUS_PrivateEndpoint_SubResourceEmbedded |
ApplicationSecurityGroups: Application security groups in which the private endpoint IP configuration is included. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
customDnsConfigs []CustomDnsConfigPropertiesFormat_STATUS |
CustomDnsConfigs: An array of custom dns configurations. |
customNetworkInterfaceName string |
CustomNetworkInterfaceName: The custom name of the network interface attached to the private endpoint. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
extendedLocation ExtendedLocation_STATUS |
ExtendedLocation: The extended location of the load balancer. |
id string |
Id: Resource ID. |
ipConfigurations []PrivateEndpointIPConfiguration_STATUS |
IpConfigurations: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints. |
location string |
Location: Resource location. |
manualPrivateLinkServiceConnections []PrivateLinkServiceConnection_STATUS |
ManualPrivateLinkServiceConnections: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. |
name string |
Name: Resource name. |
networkInterfaces []NetworkInterface_STATUS_PrivateEndpoint_SubResourceEmbedded |
NetworkInterfaces: An array of references to the network interfaces created for this private endpoint. |
privateLinkServiceConnections []PrivateLinkServiceConnection_STATUS |
PrivateLinkServiceConnections: A grouping of information about the connection to the remote resource. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the private endpoint resource. |
subnet Subnet_STATUS_PrivateEndpoint_SubResourceEmbedded |
Subnet: The ID of the subnet from which the private IP will be allocated. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
PrivateEndpoint_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded
(Appears on:VirtualNetworksSubnet_STATUS)
Private endpoint resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
PrivateEndpoint_Spec
(Appears on:PrivateEndpoint)
Field | Description |
---|---|
applicationSecurityGroups []ApplicationSecurityGroupSpec_PrivateEndpoint_SubResourceEmbedded |
ApplicationSecurityGroups: Application security groups in which the private endpoint IP configuration is included. |
azureName string |
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. |
customNetworkInterfaceName string |
CustomNetworkInterfaceName: The custom name of the network interface attached to the private endpoint. |
extendedLocation ExtendedLocation |
ExtendedLocation: The extended location of the load balancer. |
ipConfigurations []PrivateEndpointIPConfiguration |
IpConfigurations: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints. |
location string |
Location: Resource location. |
manualPrivateLinkServiceConnections []PrivateLinkServiceConnection |
ManualPrivateLinkServiceConnections: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. |
operatorSpec PrivateEndpointOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
privateLinkServiceConnections []PrivateLinkServiceConnection |
PrivateLinkServiceConnections: A grouping of information about the connection to the remote resource. |
subnet Subnet_PrivateEndpoint_SubResourceEmbedded |
Subnet: The ID of the subnet from which the private IP will be allocated. |
tags map[string]string |
Tags: Resource tags. |
PrivateEndpointsPrivateDnsZoneGroup
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/privateEndpoint.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}p>
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec PrivateEndpointsPrivateDnsZoneGroup_Spec |
|
||||||||
status PrivateEndpointsPrivateDnsZoneGroup_STATUS |
PrivateEndpointsPrivateDnsZoneGroupOperatorSpec
(Appears on:PrivateEndpointsPrivateDnsZoneGroup_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
PrivateEndpointsPrivateDnsZoneGroup_STATUS
(Appears on:PrivateEndpointsPrivateDnsZoneGroup)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
name string |
Name: Name of the resource that is unique within a resource group. This name can be used to access the resource. |
privateDnsZoneConfigs []PrivateDnsZoneConfig_STATUS |
PrivateDnsZoneConfigs: A collection of private dns zone configurations of the private dns zone group. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the private dns zone group resource. |
PrivateEndpointsPrivateDnsZoneGroup_Spec
(Appears on:PrivateEndpointsPrivateDnsZoneGroup)
Field | Description |
---|---|
azureName string |
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. |
operatorSpec PrivateEndpointsPrivateDnsZoneGroupOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/PrivateEndpoint resource |
privateDnsZoneConfigs []PrivateDnsZoneConfig |
PrivateDnsZoneConfigs: A collection of private dns zone configurations of the private dns zone group. |
PrivateLinkService
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/privateLinkService.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}p>
Field | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||
spec PrivateLinkService_Spec |
|
||||||||||||||||||||||||||
status PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded |
PrivateLinkServiceConnection
(Appears on:PrivateEndpoint_Spec)
PrivateLinkServiceConnection resource.
Field | Description |
---|---|
groupIds []string |
GroupIds: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
privateLinkServiceConnectionState PrivateLinkServiceConnectionState |
PrivateLinkServiceConnectionState: A collection of read-only information about the state of the connection to the remote resource. |
privateLinkServiceReference genruntime.ResourceReference |
PrivateLinkServiceReference: The resource id of private link service. |
requestMessage string |
RequestMessage: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. |
PrivateLinkServiceConnectionState
(Appears on:PrivateLinkServiceConnection)
A collection of information about the state of the connection between service consumer and provider.
Field | Description |
---|---|
actionsRequired string |
ActionsRequired: A message indicating if changes on the service provider require any updates on the consumer. |
description string |
Description: The reason for approval/rejection of the connection. |
status string |
Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
PrivateLinkServiceConnectionState_STATUS
(Appears on:PrivateLinkServiceConnection_STATUS)
A collection of information about the state of the connection between service consumer and provider.
Field | Description |
---|---|
actionsRequired string |
ActionsRequired: A message indicating if changes on the service provider require any updates on the consumer. |
description string |
Description: The reason for approval/rejection of the connection. |
status string |
Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
PrivateLinkServiceConnection_STATUS
(Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)
PrivateLinkServiceConnection resource.
Field | Description |
---|---|
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
groupIds []string |
GroupIds: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. |
id string |
Id: Resource ID. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
privateLinkServiceConnectionState PrivateLinkServiceConnectionState_STATUS |
PrivateLinkServiceConnectionState: A collection of read-only information about the state of the connection to the remote resource. |
privateLinkServiceId string |
PrivateLinkServiceId: The resource id of private link service. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the private link service connection resource. |
requestMessage string |
RequestMessage: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. |
type string |
Type: The resource type. |
PrivateLinkServiceIpConfiguration
(Appears on:PrivateLinkService_Spec)
The private link service ip configuration.
Field | Description |
---|---|
name string |
Name: The name of private link service ip configuration. |
primary bool |
Primary: Whether the ip configuration is primary or not. |
privateIPAddress string |
PrivateIPAddress: The private IP address of the IP configuration. |
privateIPAddressVersion IPVersion |
PrivateIPAddressVersion: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. |
privateIPAllocationMethod IPAllocationMethod |
PrivateIPAllocationMethod: The private IP address allocation method. |
subnet Subnet_PrivateLinkService_SubResourceEmbedded |
Subnet: The reference to the subnet resource. |
PrivateLinkServiceIpConfiguration_STATUS
(Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)
The private link service ip configuration.
Field | Description |
---|---|
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
name string |
Name: The name of private link service ip configuration. |
primary bool |
Primary: Whether the ip configuration is primary or not. |
privateIPAddress string |
PrivateIPAddress: The private IP address of the IP configuration. |
privateIPAddressVersion IPVersion_STATUS |
PrivateIPAddressVersion: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. |
privateIPAllocationMethod IPAllocationMethod_STATUS |
PrivateIPAllocationMethod: The private IP address allocation method. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the private link service IP configuration resource. |
subnet Subnet_STATUS_PrivateLinkService_SubResourceEmbedded |
Subnet: The reference to the subnet resource. |
type string |
Type: The resource type. |
PrivateLinkServiceOperatorConfigMaps
(Appears on:PrivateLinkServiceOperatorSpec)
Field | Description |
---|---|
alias genruntime.ConfigMapDestination |
Alias: indicates where the Alias config map should be placed. If omitted, no config map will be created. |
PrivateLinkServiceOperatorSpec
(Appears on:PrivateLinkService_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
configMaps PrivateLinkServiceOperatorConfigMaps |
ConfigMaps: configures where to place operator written ConfigMaps. |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
PrivateLinkServiceSpec
(Appears on:NetworkInterface_Spec)
Private link service resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
PrivateLinkService_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)
Private link service resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded
(Appears on:PrivateLinkService)
Private link service resource.
Field | Description |
---|---|
alias string |
Alias: The alias of the private link service. |
autoApproval ResourceSet_STATUS |
AutoApproval: The auto-approval list of the private link service. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
destinationIPAddress string |
DestinationIPAddress: The destination IP address of the private link service. |
enableProxyProtocol bool |
EnableProxyProtocol: Whether the private link service is enabled for proxy protocol or not. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
extendedLocation ExtendedLocation_STATUS |
ExtendedLocation: The extended location of the load balancer. |
fqdns []string |
Fqdns: The list of Fqdn. |
id string |
Id: Resource ID. |
ipConfigurations []PrivateLinkServiceIpConfiguration_STATUS |
IpConfigurations: An array of private link service IP configurations. |
loadBalancerFrontendIpConfigurations []FrontendIPConfiguration_STATUS_PrivateLinkService_SubResourceEmbedded |
LoadBalancerFrontendIpConfigurations: An array of references to the load balancer IP configurations. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
networkInterfaces []NetworkInterface_STATUS_PrivateLinkService_SubResourceEmbedded |
NetworkInterfaces: An array of references to the network interfaces created for this private link service. |
privateEndpointConnections []PrivateEndpointConnection_STATUS |
PrivateEndpointConnections: An array of list about connections to the private endpoint. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the private link service resource. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
visibility ResourceSet_STATUS |
Visibility: The visibility list of the private link service. |
PrivateLinkService_Spec
(Appears on:PrivateLinkService)
Field | Description |
---|---|
autoApproval ResourceSet |
AutoApproval: The auto-approval list of the private link service. |
azureName string |
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. |
destinationIPAddress string |
DestinationIPAddress: The destination IP address of the private link service. |
enableProxyProtocol bool |
EnableProxyProtocol: Whether the private link service is enabled for proxy protocol or not. |
extendedLocation ExtendedLocation |
ExtendedLocation: The extended location of the load balancer. |
fqdns []string |
Fqdns: The list of Fqdn. |
ipConfigurations []PrivateLinkServiceIpConfiguration |
IpConfigurations: An array of private link service IP configurations. |
loadBalancerFrontendIpConfigurations []FrontendIPConfiguration_PrivateLinkService_SubResourceEmbedded |
LoadBalancerFrontendIpConfigurations: An array of references to the load balancer IP configurations. |
location string |
Location: Resource location. |
operatorSpec PrivateLinkServiceOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
tags map[string]string |
Tags: Resource tags. |
visibility ResourceSet |
Visibility: The visibility list of the private link service. |
Probe
(Appears on:LoadBalancer_Spec)
A load balancer probe.
Field | Description |
---|---|
intervalInSeconds int |
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. |
name string |
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. |
noHealthyBackendsBehavior ProbePropertiesFormat_NoHealthyBackendsBehavior |
NoHealthyBackendsBehavior: Determines how new connections are handled by the load balancer when all backend instances are probed down. |
numberOfProbes int |
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. |
port int |
Port: The port for communicating the probe. Possible values range from 1 to 65535, inclusive. |
probeThreshold int |
ProbeThreshold: The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation. |
protocol ProbePropertiesFormat_Protocol |
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. |
requestPath string |
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. |
ProbePropertiesFormat_NoHealthyBackendsBehavior
(string
alias)
(Appears on:Probe)
Value | Description |
---|---|
"AllProbedDown" |
|
"AllProbedUp" |
ProbePropertiesFormat_NoHealthyBackendsBehavior_STATUS
(string
alias)
(Appears on:Probe_STATUS)
Value | Description |
---|---|
"AllProbedDown" |
|
"AllProbedUp" |
ProbePropertiesFormat_Protocol
(string
alias)
(Appears on:Probe)
Value | Description |
---|---|
"Http" |
|
"Https" |
|
"Tcp" |
ProbePropertiesFormat_Protocol_STATUS
(string
alias)
(Appears on:Probe_STATUS)
Value | Description |
---|---|
"Http" |
|
"Https" |
|
"Tcp" |
Probe_STATUS
(Appears on:LoadBalancer_STATUS)
A load balancer probe.
Field | Description |
---|---|
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
intervalInSeconds int |
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. |
loadBalancingRules []SubResource_STATUS |
LoadBalancingRules: The load balancer rules that use this probe. |
name string |
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. |
noHealthyBackendsBehavior ProbePropertiesFormat_NoHealthyBackendsBehavior_STATUS |
NoHealthyBackendsBehavior: Determines how new connections are handled by the load balancer when all backend instances are probed down. |
numberOfProbes int |
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. |
port int |
Port: The port for communicating the probe. Possible values range from 1 to 65535, inclusive. |
probeThreshold int |
ProbeThreshold: The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation. |
protocol ProbePropertiesFormat_Protocol_STATUS |
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. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the probe resource. |
requestPath string |
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. |
type string |
Type: Type of the resource. |
ProvisioningState_STATUS
(string
alias)
(Appears on:BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, BastionHost_STATUS, Delegation_STATUS, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, InboundNatPool_STATUS, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, LoadBalancer_STATUS, LoadBalancersInboundNatRule_STATUS, LoadBalancingRule_STATUS, NatGateway_STATUS, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded, NetworkSecurityGroupsSecurityRule_STATUS, OutboundRule_STATUS, PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded, PrivateEndpointsPrivateDnsZoneGroup_STATUS, PrivateLinkServiceConnection_STATUS, PrivateLinkServiceIpConfiguration_STATUS, PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded, Probe_STATUS, PublicIPAddress_STATUS, PublicIPPrefix_STATUS, RecordSet_STATUS, RouteTable_STATUS, RouteTablesRoute_STATUS, ServiceEndpointPropertiesFormat_STATUS, VirtualNetworkGatewayIPConfiguration_STATUS, VirtualNetworkGatewayNatRule_STATUS, VirtualNetworkGatewayPolicyGroup_STATUS, VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded, VirtualNetwork_STATUS, VirtualNetworksSubnet_STATUS, VirtualNetworksVirtualNetworkPeering_STATUS, VpnClientRevokedCertificate_STATUS, VpnClientRootCertificate_STATUS)
The current provisioning state.
Value | Description |
---|---|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
PublicIPAddress
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/publicIpAddress.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||
spec PublicIPAddress_Spec |
|
||||||||||||||||||||||||||||||||||||||||
status PublicIPAddress_STATUS |
PublicIPAddressDnsSettings
(Appears on:PublicIPAddress_Spec)
Contains FQDN of the DNS record associated with the public IP address.
Field | Description |
---|---|
domainNameLabel string |
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. |
domainNameLabelScope PublicIPAddressDnsSettings_DomainNameLabelScope |
DomainNameLabelScope: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. |
fqdn string |
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. |
reverseFqdn string |
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. |
PublicIPAddressDnsSettings_DomainNameLabelScope
(string
alias)
(Appears on:PublicIPAddressDnsSettings)
Value | Description |
---|---|
"NoReuse" |
|
"ResourceGroupReuse" |
|
"SubscriptionReuse" |
|
"TenantReuse" |
PublicIPAddressDnsSettings_DomainNameLabelScope_STATUS
(string
alias)
(Appears on:PublicIPAddressDnsSettings_STATUS)
Value | Description |
---|---|
"NoReuse" |
|
"ResourceGroupReuse" |
|
"SubscriptionReuse" |
|
"TenantReuse" |
PublicIPAddressDnsSettings_STATUS
(Appears on:PublicIPAddress_STATUS)
Contains FQDN of the DNS record associated with the public IP address.
Field | Description |
---|---|
domainNameLabel string |
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. |
domainNameLabelScope PublicIPAddressDnsSettings_DomainNameLabelScope_STATUS |
DomainNameLabelScope: The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. |
fqdn string |
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. |
reverseFqdn string |
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. |
PublicIPAddressOperatorSpec
(Appears on:PublicIPAddress_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
PublicIPAddressPropertiesFormat_DeleteOption
(string
alias)
(Appears on:PublicIPAddress_Spec)
Value | Description |
---|---|
"Delete" |
|
"Detach" |
PublicIPAddressPropertiesFormat_DeleteOption_STATUS
(string
alias)
(Appears on:PublicIPAddress_STATUS)
Value | Description |
---|---|
"Delete" |
|
"Detach" |
PublicIPAddressPropertiesFormat_MigrationPhase_STATUS
(string
alias)
(Appears on:PublicIPAddress_STATUS)
Value | Description |
---|---|
"Abort" |
|
"Commit" |
|
"Committed" |
|
"None" |
|
"Prepare" |
PublicIPAddressSku
(Appears on:PublicIPAddress_Spec)
SKU of a public IP address.
Field | Description |
---|---|
name PublicIPAddressSku_Name |
Name: Name of a public IP address SKU. |
tier PublicIPAddressSku_Tier |
Tier: Tier of a public IP address SKU. |
PublicIPAddressSku_Name
(string
alias)
(Appears on:PublicIPAddressSku)
Value | Description |
---|---|
"Basic" |
|
"Standard" |
PublicIPAddressSku_Name_STATUS
(string
alias)
(Appears on:PublicIPAddressSku_STATUS)
Value | Description |
---|---|
"Basic" |
|
"Standard" |
PublicIPAddressSku_STATUS
(Appears on:PublicIPAddress_STATUS)
SKU of a public IP address.
Field | Description |
---|---|
name PublicIPAddressSku_Name_STATUS |
Name: Name of a public IP address SKU. |
tier PublicIPAddressSku_Tier_STATUS |
Tier: Tier of a public IP address SKU. |
PublicIPAddressSku_Tier
(string
alias)
(Appears on:PublicIPAddressSku)
Value | Description |
---|---|
"Global" |
|
"Regional" |
PublicIPAddressSku_Tier_STATUS
(string
alias)
(Appears on:PublicIPAddressSku_STATUS)
Value | Description |
---|---|
"Global" |
|
"Regional" |
PublicIPAddressSpec_LoadBalancer_SubResourceEmbedded
(Appears on:FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded)
Public IP address resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
PublicIPAddressSpec_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)
Public IP address resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded
(Appears on:PublicIPAddress_Spec)
Public IP address resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
PublicIPAddress_STATUS
(Appears on:PublicIPAddress)
Public IP address resource.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
ddosSettings DdosSettings_STATUS |
DdosSettings: The DDoS protection custom policy associated with the public IP address. |
deleteOption PublicIPAddressPropertiesFormat_DeleteOption_STATUS |
DeleteOption: Specify what happens to the public IP address when the VM using it is deleted |
dnsSettings PublicIPAddressDnsSettings_STATUS |
DnsSettings: The FQDN of the DNS record associated with the public IP address. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
extendedLocation ExtendedLocation_STATUS |
ExtendedLocation: The extended location of the public ip address. |
id string |
Id: Resource ID. |
idleTimeoutInMinutes int |
IdleTimeoutInMinutes: The idle timeout of the public IP address. |
ipAddress string |
IpAddress: The IP address associated with the public IP address resource. |
ipConfiguration IPConfiguration_STATUS_PublicIPAddress_SubResourceEmbedded |
IpConfiguration: The IP configuration associated with the public IP address. |
ipTags []IpTag_STATUS |
IpTags: The list of tags associated with the public IP address. |
location string |
Location: Resource location. |
migrationPhase PublicIPAddressPropertiesFormat_MigrationPhase_STATUS |
MigrationPhase: Migration phase of Public IP Address. |
name string |
Name: Resource name. |
natGateway NatGateway_STATUS_PublicIPAddress_SubResourceEmbedded |
NatGateway: The NatGateway for the Public IP address. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the public IP address resource. |
publicIPAddressVersion IPVersion_STATUS |
PublicIPAddressVersion: The public IP address version. |
publicIPAllocationMethod IPAllocationMethod_STATUS |
PublicIPAllocationMethod: The public IP address allocation method. |
publicIPPrefix SubResource_STATUS |
PublicIPPrefix: The Public IP Prefix this Public IP Address should be allocated from. |
resourceGuid string |
ResourceGuid: The resource GUID property of the public IP address resource. |
sku PublicIPAddressSku_STATUS |
Sku: The public IP address SKU. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
zones []string |
Zones: A list of availability zones denoting the IP allocated for the resource needs to come from. |
PublicIPAddress_STATUS_LoadBalancer_SubResourceEmbedded
(Appears on:FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded)
Public IP address resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
PublicIPAddress_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)
Public IP address resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
PublicIPAddress_Spec
(Appears on:PublicIPAddress)
Field | Description |
---|---|
azureName string |
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. |
ddosSettings DdosSettings |
DdosSettings: The DDoS protection custom policy associated with the public IP address. |
deleteOption PublicIPAddressPropertiesFormat_DeleteOption |
DeleteOption: Specify what happens to the public IP address when the VM using it is deleted |
dnsSettings PublicIPAddressDnsSettings |
DnsSettings: The FQDN of the DNS record associated with the public IP address. |
extendedLocation ExtendedLocation |
ExtendedLocation: The extended location of the public ip address. |
idleTimeoutInMinutes int |
IdleTimeoutInMinutes: The idle timeout of the public IP address. |
ipAddress string |
IpAddress: The IP address associated with the public IP address resource. |
ipTags []IpTag |
IpTags: The list of tags associated with the public IP address. |
linkedPublicIPAddress PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded |
LinkedPublicIPAddress: The linked public IP address of the public IP address resource. |
location string |
Location: Resource location. |
natGateway NatGatewaySpec_PublicIPAddress_SubResourceEmbedded |
NatGateway: The NatGateway for the Public IP address. |
operatorSpec PublicIPAddressOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
publicIPAddressVersion IPVersion |
PublicIPAddressVersion: The public IP address version. |
publicIPAllocationMethod IPAllocationMethod |
PublicIPAllocationMethod: The public IP address allocation method. |
publicIPPrefix SubResource |
PublicIPPrefix: The Public IP Prefix this Public IP Address should be allocated from. |
servicePublicIPAddress PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded |
ServicePublicIPAddress: The service public IP address of the public IP address resource. |
sku PublicIPAddressSku |
Sku: The public IP address SKU. |
tags map[string]string |
Tags: Resource tags. |
zones []string |
Zones: A list of availability zones denoting the IP allocated for the resource needs to come from. |
PublicIPPrefix
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/publicIpPrefix.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}p>
Field | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||
spec PublicIPPrefix_Spec |
|
||||||||||||||||||||||||||
status PublicIPPrefix_STATUS |
PublicIPPrefixOperatorSpec
(Appears on:PublicIPPrefix_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
PublicIPPrefixSku
(Appears on:PublicIPPrefix_Spec)
SKU of a public IP prefix.
Field | Description |
---|---|
name PublicIPPrefixSku_Name |
Name: Name of a public IP prefix SKU. |
tier PublicIPPrefixSku_Tier |
Tier: Tier of a public IP prefix SKU. |
PublicIPPrefixSku_Name
(string
alias)
(Appears on:PublicIPPrefixSku)
Value | Description |
---|---|
"Standard" |
PublicIPPrefixSku_Name_STATUS
(string
alias)
(Appears on:PublicIPPrefixSku_STATUS)
Value | Description |
---|---|
"Standard" |
PublicIPPrefixSku_STATUS
(Appears on:PublicIPPrefix_STATUS)
SKU of a public IP prefix.
Field | Description |
---|---|
name PublicIPPrefixSku_Name_STATUS |
Name: Name of a public IP prefix SKU. |
tier PublicIPPrefixSku_Tier_STATUS |
Tier: Tier of a public IP prefix SKU. |
PublicIPPrefixSku_Tier
(string
alias)
(Appears on:PublicIPPrefixSku)
Value | Description |
---|---|
"Global" |
|
"Regional" |
PublicIPPrefixSku_Tier_STATUS
(string
alias)
(Appears on:PublicIPPrefixSku_STATUS)
Value | Description |
---|---|
"Global" |
|
"Regional" |
PublicIPPrefix_STATUS
(Appears on:PublicIPPrefix)
Public IP prefix resource.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
customIPPrefix SubResource_STATUS |
CustomIPPrefix: The customIpPrefix that this prefix is associated with. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
extendedLocation ExtendedLocation_STATUS |
ExtendedLocation: The extended location of the public ip address. |
id string |
Id: Resource ID. |
ipPrefix string |
IpPrefix: The allocated Prefix. |
ipTags []IpTag_STATUS |
IpTags: The list of tags associated with the public IP prefix. |
loadBalancerFrontendIpConfiguration SubResource_STATUS |
LoadBalancerFrontendIpConfiguration: The reference to load balancer frontend IP configuration associated with the public IP prefix. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
natGateway NatGateway_STATUS_PublicIPPrefix_SubResourceEmbedded |
NatGateway: NatGateway of Public IP Prefix. |
prefixLength int |
PrefixLength: The Length of the Public IP Prefix. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the public IP prefix resource. |
publicIPAddressVersion IPVersion_STATUS |
PublicIPAddressVersion: The public IP address version. |
publicIPAddresses []ReferencedPublicIpAddress_STATUS |
PublicIPAddresses: The list of all referenced PublicIPAddresses. |
resourceGuid string |
ResourceGuid: The resource GUID property of the public IP prefix resource. |
sku PublicIPPrefixSku_STATUS |
Sku: The public IP prefix SKU. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
zones []string |
Zones: A list of availability zones denoting the IP allocated for the resource needs to come from. |
PublicIPPrefix_Spec
(Appears on:PublicIPPrefix)
Field | Description |
---|---|
azureName string |
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. |
customIPPrefix SubResource |
CustomIPPrefix: The customIpPrefix that this prefix is associated with. |
extendedLocation ExtendedLocation |
ExtendedLocation: The extended location of the public ip address. |
ipTags []IpTag |
IpTags: The list of tags associated with the public IP prefix. |
location string |
Location: Resource location. |
natGateway NatGatewaySpec_PublicIPPrefix_SubResourceEmbedded |
NatGateway: NatGateway of Public IP Prefix. |
operatorSpec PublicIPPrefixOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
prefixLength int |
PrefixLength: The Length of the Public IP Prefix. |
publicIPAddressVersion IPVersion |
PublicIPAddressVersion: The public IP address version. |
sku PublicIPPrefixSku |
Sku: The public IP prefix SKU. |
tags map[string]string |
Tags: Resource tags. |
zones []string |
Zones: A list of availability zones denoting the IP allocated for the resource needs to come from. |
RadiusServer
(Appears on:VpnClientConfiguration)
Radius Server Settings.
Field | Description |
---|---|
radiusServerAddress string |
RadiusServerAddress: The address of this radius server. |
radiusServerScore int |
RadiusServerScore: The initial score assigned to this radius server. |
radiusServerSecret string |
RadiusServerSecret: The secret used for this radius server. |
RadiusServer_STATUS
(Appears on:VpnClientConfiguration_STATUS)
Radius Server Settings.
Field | Description |
---|---|
radiusServerAddress string |
RadiusServerAddress: The address of this radius server. |
radiusServerScore int |
RadiusServerScore: The initial score assigned to this radius server. |
radiusServerSecret string |
RadiusServerSecret: The secret used for this radius server. |
RecordSet_STATUS
(Appears on:PrivateDnsZoneConfig_STATUS)
A collective group of information about the record set information.
Field | Description |
---|---|
fqdn string |
Fqdn: Fqdn that resolves to private endpoint ip address. |
ipAddresses []string |
IpAddresses: The private ip address of the private endpoint. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the recordset. |
recordSetName string |
RecordSetName: Recordset name. |
recordType string |
RecordType: Resource record type. |
ttl int |
Ttl: Recordset time to live. |
ReferencedPublicIpAddress_STATUS
(Appears on:PublicIPPrefix_STATUS)
Reference to a public IP address.
Field | Description |
---|---|
id string |
Id: The PublicIPAddress Reference. |
ResourceNavigationLink_STATUS
(Appears on:VirtualNetworksSubnet_STATUS)
ResourceNavigationLink resource.
Field | Description |
---|---|
id string |
Id: Resource navigation link identifier. |
ResourceSet
(Appears on:PrivateLinkService_Spec)
The base resource set for visibility and auto-approval.
Field | Description |
---|---|
subscriptions []string |
Subscriptions: The list of subscriptions. |
ResourceSet_STATUS
(Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)
The base resource set for visibility and auto-approval.
Field | Description |
---|---|
subscriptions []string |
Subscriptions: The list of subscriptions. |
RouteNextHopType
(string
alias)
(Appears on:RouteTablesRoute_Spec)
The type of Azure hop the packet should be sent to.
Value | Description |
---|---|
"Internet" |
|
"None" |
|
"VirtualAppliance" |
|
"VirtualNetworkGateway" |
|
"VnetLocal" |
RouteNextHopType_STATUS
(string
alias)
(Appears on:RouteTablesRoute_STATUS)
The type of Azure hop the packet should be sent to.
Value | Description |
---|---|
"Internet" |
|
"None" |
|
"VirtualAppliance" |
|
"VirtualNetworkGateway" |
|
"VnetLocal" |
RouteTable
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/routeTable.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}p>
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec RouteTable_Spec |
|
||||||||||||
status RouteTable_STATUS |
RouteTableOperatorSpec
(Appears on:RouteTable_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
RouteTableSpec_VirtualNetworks_Subnet_SubResourceEmbedded
(Appears on:VirtualNetworksSubnet_Spec)
Route table resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
RouteTable_STATUS
(Appears on:RouteTable)
Route table resource.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
disableBgpRoutePropagation bool |
DisableBgpRoutePropagation: Whether to disable the routes learned by BGP on that route table. True means disable. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the route table resource. |
resourceGuid string |
ResourceGuid: The resource GUID property of the route table. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
RouteTable_STATUS_SubResourceEmbedded
(Appears on:VirtualNetworksSubnet_STATUS)
Route table resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
RouteTable_Spec
(Appears on:RouteTable)
Field | Description |
---|---|
azureName string |
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. |
disableBgpRoutePropagation bool |
DisableBgpRoutePropagation: Whether to disable the routes learned by BGP on that route table. True means disable. |
location string |
Location: Resource location. |
operatorSpec RouteTableOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
tags map[string]string |
Tags: Resource tags. |
RouteTablesRoute
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/routeTable.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}p>
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec RouteTablesRoute_Spec |
|
||||||||||||
status RouteTablesRoute_STATUS |
RouteTablesRouteOperatorSpec
(Appears on:RouteTablesRoute_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
RouteTablesRoute_STATUS
(Appears on:RouteTablesRoute)
Field | Description |
---|---|
addressPrefix string |
AddressPrefix: The destination CIDR to which the route applies. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
hasBgpOverride bool |
HasBgpOverride: A value indicating whether this route overrides overlapping BGP routes regardless of LPM. |
id string |
Id: Resource ID. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
nextHopIpAddress string |
NextHopIpAddress: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. |
nextHopType RouteNextHopType_STATUS |
NextHopType: The type of Azure hop the packet should be sent to. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the route resource. |
type string |
Type: The type of the resource. |
RouteTablesRoute_Spec
(Appears on:RouteTablesRoute)
Field | Description |
---|---|
addressPrefix string |
AddressPrefix: The destination CIDR to which the route applies. |
azureName string |
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. |
nextHopIpAddress string |
NextHopIpAddress: The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. |
nextHopType RouteNextHopType |
NextHopType: The type of Azure hop the packet should be sent to. |
operatorSpec RouteTablesRouteOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
SecurityRuleAccess
(string
alias)
(Appears on:NetworkSecurityGroupsSecurityRule_Spec)
Whether network traffic is allowed or denied.
Value | Description |
---|---|
"Allow" |
|
"Deny" |
SecurityRuleAccess_STATUS
(string
alias)
(Appears on:NetworkSecurityGroupsSecurityRule_STATUS)
Whether network traffic is allowed or denied.
Value | Description |
---|---|
"Allow" |
|
"Deny" |
SecurityRuleDirection
(string
alias)
(Appears on:NetworkSecurityGroupsSecurityRule_Spec)
The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.
Value | Description |
---|---|
"Inbound" |
|
"Outbound" |
SecurityRuleDirection_STATUS
(string
alias)
(Appears on:NetworkSecurityGroupsSecurityRule_STATUS)
The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.
Value | Description |
---|---|
"Inbound" |
|
"Outbound" |
SecurityRulePropertiesFormat_Protocol
(string
alias)
(Appears on:NetworkSecurityGroupsSecurityRule_Spec)
Value | Description |
---|---|
"Ah" |
|
"Esp" |
|
"Icmp" |
|
"*" |
|
"Tcp" |
|
"Udp" |
SecurityRulePropertiesFormat_Protocol_STATUS
(string
alias)
(Appears on:NetworkSecurityGroupsSecurityRule_STATUS)
Value | Description |
---|---|
"Ah" |
|
"Esp" |
|
"Icmp" |
|
"*" |
|
"Tcp" |
|
"Udp" |
SecurityRule_STATUS
(Appears on:NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded)
Network security rule.
Field | Description |
---|---|
id string |
Id: Resource ID. |
ServiceAssociationLink_STATUS
(Appears on:VirtualNetworksSubnet_STATUS)
ServiceAssociationLink resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
ServiceEndpointPolicySpec_VirtualNetworks_Subnet_SubResourceEmbedded
(Appears on:VirtualNetworksSubnet_Spec)
Service End point policy resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
ServiceEndpointPolicy_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded
(Appears on:VirtualNetworksSubnet_STATUS)
Service End point policy resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
ServiceEndpointPropertiesFormat
(Appears on:VirtualNetworksSubnet_Spec)
The service endpoint properties.
Field | Description |
---|---|
locations []string |
Locations: A list of locations. |
networkIdentifier SubResource |
NetworkIdentifier: SubResource as network identifier. |
service string |
Service: The type of the endpoint service. |
ServiceEndpointPropertiesFormat_STATUS
(Appears on:VirtualNetworksSubnet_STATUS)
The service endpoint properties.
Field | Description |
---|---|
locations []string |
Locations: A list of locations. |
networkIdentifier SubResource_STATUS |
NetworkIdentifier: SubResource as network identifier. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the service endpoint resource. |
service string |
Service: The type of the endpoint service. |
Sku
(Appears on:BastionHost_Spec)
The sku of this Bastion Host.
Field | Description |
---|---|
name Sku_Name |
Name: The name of the sku of this Bastion Host. |
Sku_Name
(string
alias)
(Appears on:Sku)
Value | Description |
---|---|
"Basic" |
|
"Developer" |
|
"Premium" |
|
"Standard" |
Sku_Name_STATUS
(string
alias)
(Appears on:Sku_STATUS)
Value | Description |
---|---|
"Basic" |
|
"Developer" |
|
"Premium" |
|
"Standard" |
Sku_STATUS
(Appears on:BastionHost_STATUS)
The sku of this Bastion Host.
Field | Description |
---|---|
name Sku_Name_STATUS |
Name: The name of the sku of this Bastion Host. |
SubResource
(Appears on:BackendAddressPool_LoadBalancer_SubResourceEmbedded, BastionHostIPConfiguration, BastionHost_Spec, DdosSettings, FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, InboundNatPool, InboundNatRule_LoadBalancer_SubResourceEmbedded, LoadBalancerBackendAddress, LoadBalancersInboundNatRule_Spec, LoadBalancingRule, NatGateway_Spec, NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded, OutboundRule, PublicIPAddress_Spec, PublicIPPrefix_Spec, ServiceEndpointPropertiesFormat, VirtualNetworkGatewayIPConfiguration, VirtualNetworkGateway_Spec, VirtualNetwork_Spec, VirtualNetworksSubnet_Spec, VirtualNetworksVirtualNetworkPeering_Spec)
Reference to another subresource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
SubResource_STATUS
(Appears on:BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, BastionHost_STATUS, DdosSettings_STATUS, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, InboundNatPool_STATUS, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, LoadBalancerBackendAddress_STATUS, LoadBalancersInboundNatRule_STATUS, LoadBalancingRule_STATUS, NatGateway_STATUS, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, OutboundRule_STATUS, Probe_STATUS, PublicIPAddress_STATUS, PublicIPPrefix_STATUS, ServiceEndpointPropertiesFormat_STATUS, VirtualNetworkGatewayIPConfiguration_STATUS, VirtualNetworkGatewayPolicyGroup_STATUS, VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded, VirtualNetwork_STATUS, VirtualNetworksSubnet_STATUS, VirtualNetworksVirtualNetworkPeering_STATUS)
Reference to another subresource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
SubnetPropertiesFormat_PrivateEndpointNetworkPolicies
(string
alias)
(Appears on:VirtualNetworksSubnet_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
|
"NetworkSecurityGroupEnabled" |
|
"RouteTableEnabled" |
SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_STATUS
(string
alias)
(Appears on:VirtualNetworksSubnet_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
|
"NetworkSecurityGroupEnabled" |
|
"RouteTableEnabled" |
SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies
(string
alias)
(Appears on:VirtualNetworksSubnet_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_STATUS
(string
alias)
(Appears on:VirtualNetworksSubnet_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
SubnetPropertiesFormat_SharingScope
(string
alias)
(Appears on:VirtualNetworksSubnet_Spec)
Value | Description |
---|---|
"DelegatedServices" |
|
"Tenant" |
SubnetPropertiesFormat_SharingScope_STATUS
(string
alias)
(Appears on:VirtualNetworksSubnet_STATUS)
Value | Description |
---|---|
"DelegatedServices" |
|
"Tenant" |
Subnet_LoadBalancer_SubResourceEmbedded
(Appears on:FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded)
Subnet in a virtual network resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
Subnet_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)
Subnet in a virtual network resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
Subnet_PrivateEndpoint_SubResourceEmbedded
(Appears on:PrivateEndpoint_Spec)
Subnet in a virtual network resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
Subnet_PrivateLinkService_SubResourceEmbedded
(Appears on:PrivateLinkServiceIpConfiguration)
Subnet in a virtual network resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
Subnet_STATUS_LoadBalancer_SubResourceEmbedded
(Appears on:FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded)
Subnet in a virtual network resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
Subnet_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)
Subnet in a virtual network resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
Subnet_STATUS_NetworkSecurityGroup_SubResourceEmbedded
(Appears on:NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded)
Subnet in a virtual network resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
Subnet_STATUS_PrivateEndpoint_SubResourceEmbedded
(Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)
Subnet in a virtual network resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
Subnet_STATUS_PrivateLinkService_SubResourceEmbedded
(Appears on:PrivateLinkServiceIpConfiguration_STATUS)
Subnet in a virtual network resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
TransportProtocol
(string
alias)
(Appears on:InboundNatPool, InboundNatRule_LoadBalancer_SubResourceEmbedded, LoadBalancersInboundNatRule_Spec, LoadBalancingRule)
The transport protocol for the endpoint.
Value | Description |
---|---|
"All" |
|
"Tcp" |
|
"Udp" |
TransportProtocol_STATUS
(string
alias)
(Appears on:InboundNatPool_STATUS, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, LoadBalancersInboundNatRule_STATUS, LoadBalancingRule_STATUS)
The transport protocol for the endpoint.
Value | Description |
---|---|
"All" |
|
"Tcp" |
|
"Udp" |
UserAssignedIdentityDetails
(Appears on:ManagedServiceIdentity)
Information about the user assigned identity for the resource
Field | Description |
---|---|
reference genruntime.ResourceReference |
VirtualNetwork
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}p>
Field | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||
spec VirtualNetwork_Spec |
|
||||||||||||||||||||||||||||||||
status VirtualNetwork_STATUS |
VirtualNetworkBgpCommunities
(Appears on:VirtualNetwork_Spec, VirtualNetworksVirtualNetworkPeering_Spec)
Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.
Field | Description |
---|---|
virtualNetworkCommunity string |
VirtualNetworkCommunity: The BGP community associated with the virtual network. |
VirtualNetworkBgpCommunities_STATUS
(Appears on:VirtualNetwork_STATUS, VirtualNetworksVirtualNetworkPeering_STATUS)
Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.
Field | Description |
---|---|
regionalCommunity string |
RegionalCommunity: The BGP community associated with the region of the virtual network. |
virtualNetworkCommunity string |
VirtualNetworkCommunity: The BGP community associated with the virtual network. |
VirtualNetworkEncryption
(Appears on:VirtualNetwork_Spec)
Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet.
Field | Description |
---|---|
enabled bool |
Enabled: Indicates if encryption is enabled on the virtual network. |
enforcement VirtualNetworkEncryption_Enforcement |
Enforcement: If the encrypted VNet allows VM that does not support encryption. This field is for future support, AllowUnencrypted is the only supported value at general availability. |
VirtualNetworkEncryption_Enforcement
(string
alias)
(Appears on:VirtualNetworkEncryption)
Value | Description |
---|---|
"AllowUnencrypted" |
|
"DropUnencrypted" |
VirtualNetworkEncryption_Enforcement_STATUS
(string
alias)
(Appears on:VirtualNetworkEncryption_STATUS)
Value | Description |
---|---|
"AllowUnencrypted" |
|
"DropUnencrypted" |
VirtualNetworkEncryption_STATUS
(Appears on:VirtualNetwork_STATUS, VirtualNetworksVirtualNetworkPeering_STATUS)
Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet.
Field | Description |
---|---|
enabled bool |
Enabled: Indicates if encryption is enabled on the virtual network. |
enforcement VirtualNetworkEncryption_Enforcement_STATUS |
Enforcement: If the encrypted VNet allows VM that does not support encryption. This field is for future support, AllowUnencrypted is the only supported value at general availability. |
VirtualNetworkGateway
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetworkGateway.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spec VirtualNetworkGateway_Spec |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded |
VirtualNetworkGatewayAutoScaleBounds
(Appears on:VirtualNetworkGatewayAutoScaleConfiguration)
Field | Description |
---|---|
max int |
Max: Maximum Scale Units for Autoscale configuration |
min int |
Min: Minimum scale Units for Autoscale configuration |
VirtualNetworkGatewayAutoScaleBounds_STATUS
(Appears on:VirtualNetworkGatewayAutoScaleConfiguration_STATUS)
Field | Description |
---|---|
max int |
Max: Maximum Scale Units for Autoscale configuration |
min int |
Min: Minimum scale Units for Autoscale configuration |
VirtualNetworkGatewayAutoScaleConfiguration
(Appears on:VirtualNetworkGateway_Spec)
Virtual Network Gateway Autoscale Configuration details
Field | Description |
---|---|
bounds VirtualNetworkGatewayAutoScaleBounds |
Bounds: The bounds of the autoscale configuration |
VirtualNetworkGatewayAutoScaleConfiguration_STATUS
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
Virtual Network Gateway Autoscale Configuration details
Field | Description |
---|---|
bounds VirtualNetworkGatewayAutoScaleBounds_STATUS |
Bounds: The bounds of the autoscale configuration |
VirtualNetworkGatewayIPConfiguration
(Appears on:VirtualNetworkGateway_Spec)
IP configuration for virtual network gateway.
Field | Description |
---|---|
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
privateIPAllocationMethod IPAllocationMethod |
PrivateIPAllocationMethod: The private IP address allocation method. |
publicIPAddress SubResource |
PublicIPAddress: The reference to the public IP resource. |
subnet SubResource |
Subnet: The reference to the subnet resource. |
VirtualNetworkGatewayIPConfiguration_STATUS
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
IP configuration for virtual network gateway.
Field | Description |
---|---|
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
privateIPAddress string |
PrivateIPAddress: Private IP Address for this gateway. |
privateIPAllocationMethod IPAllocationMethod_STATUS |
PrivateIPAllocationMethod: The private IP address allocation method. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the virtual network gateway IP configuration resource. |
publicIPAddress SubResource_STATUS |
PublicIPAddress: The reference to the public IP resource. |
subnet SubResource_STATUS |
Subnet: The reference to the subnet resource. |
VirtualNetworkGatewayNatRule
(Appears on:VirtualNetworkGateway_Spec)
VirtualNetworkGatewayNatRule Resource.
Field | Description |
---|---|
externalMappings []VpnNatRuleMapping |
ExternalMappings: The private IP address external mapping for NAT. |
internalMappings []VpnNatRuleMapping |
InternalMappings: The private IP address internal mapping for NAT. |
ipConfigurationId string |
IpConfigurationId: The IP Configuration ID this NAT rule applies to. |
mode VirtualNetworkGatewayNatRuleProperties_Mode |
Mode: The Source NAT direction of a VPN NAT. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
type VirtualNetworkGatewayNatRuleProperties_Type |
Type: The type of NAT rule for VPN NAT. |
VirtualNetworkGatewayNatRuleProperties_Mode
(string
alias)
(Appears on:VirtualNetworkGatewayNatRule)
Value | Description |
---|---|
"EgressSnat" |
|
"IngressSnat" |
VirtualNetworkGatewayNatRuleProperties_Mode_STATUS
(string
alias)
(Appears on:VirtualNetworkGatewayNatRule_STATUS)
Value | Description |
---|---|
"EgressSnat" |
|
"IngressSnat" |
VirtualNetworkGatewayNatRuleProperties_Type
(string
alias)
(Appears on:VirtualNetworkGatewayNatRule)
Value | Description |
---|---|
"Dynamic" |
|
"Static" |
VirtualNetworkGatewayNatRuleProperties_Type_STATUS
(string
alias)
(Appears on:VirtualNetworkGatewayNatRule_STATUS)
Value | Description |
---|---|
"Dynamic" |
|
"Static" |
VirtualNetworkGatewayNatRule_STATUS
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
VirtualNetworkGatewayNatRule Resource.
Field | Description |
---|---|
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
externalMappings []VpnNatRuleMapping_STATUS |
ExternalMappings: The private IP address external mapping for NAT. |
id string |
Id: Resource ID. |
internalMappings []VpnNatRuleMapping_STATUS |
InternalMappings: The private IP address internal mapping for NAT. |
ipConfigurationId string |
IpConfigurationId: The IP Configuration ID this NAT rule applies to. |
mode VirtualNetworkGatewayNatRuleProperties_Mode_STATUS |
Mode: The Source NAT direction of a VPN NAT. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
properties_type VirtualNetworkGatewayNatRuleProperties_Type_STATUS |
PropertiesType: The type of NAT rule for VPN NAT. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the NAT Rule resource. |
type string |
Type: Resource type. |
VirtualNetworkGatewayOperatorSpec
(Appears on:VirtualNetworkGateway_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
VirtualNetworkGatewayPolicyGroup
(Appears on:VirtualNetworkGateway_Spec)
Parameters for VirtualNetworkGatewayPolicyGroup.
Field | Description |
---|---|
isDefault bool |
IsDefault: Shows if this is a Default VirtualNetworkGatewayPolicyGroup or not. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
policyMembers []VirtualNetworkGatewayPolicyGroupMember |
PolicyMembers: Multiple PolicyMembers for VirtualNetworkGatewayPolicyGroup. |
priority int |
Priority: Priority for VirtualNetworkGatewayPolicyGroup. |
VirtualNetworkGatewayPolicyGroupMember
(Appears on:VirtualNetworkGatewayPolicyGroup)
Vpn Client Connection configuration PolicyGroup member
Field | Description |
---|---|
attributeType VirtualNetworkGatewayPolicyGroupMember_AttributeType |
AttributeType: The Vpn Policy member attribute type. |
attributeValue string |
AttributeValue: The value of Attribute used for this VirtualNetworkGatewayPolicyGroupMember. |
name string |
Name: Name of the VirtualNetworkGatewayPolicyGroupMember. |
VirtualNetworkGatewayPolicyGroupMember_AttributeType
(string
alias)
(Appears on:VirtualNetworkGatewayPolicyGroupMember)
Value | Description |
---|---|
"AADGroupId" |
|
"CertificateGroupId" |
|
"RadiusAzureGroupId" |
VirtualNetworkGatewayPolicyGroupMember_AttributeType_STATUS
(string
alias)
(Appears on:VirtualNetworkGatewayPolicyGroupMember_STATUS)
Value | Description |
---|---|
"AADGroupId" |
|
"CertificateGroupId" |
|
"RadiusAzureGroupId" |
VirtualNetworkGatewayPolicyGroupMember_STATUS
(Appears on:VirtualNetworkGatewayPolicyGroup_STATUS)
Vpn Client Connection configuration PolicyGroup member
Field | Description |
---|---|
attributeType VirtualNetworkGatewayPolicyGroupMember_AttributeType_STATUS |
AttributeType: The Vpn Policy member attribute type. |
attributeValue string |
AttributeValue: The value of Attribute used for this VirtualNetworkGatewayPolicyGroupMember. |
name string |
Name: Name of the VirtualNetworkGatewayPolicyGroupMember. |
VirtualNetworkGatewayPolicyGroup_STATUS
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
Parameters for VirtualNetworkGatewayPolicyGroup.
Field | Description |
---|---|
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
isDefault bool |
IsDefault: Shows if this is a Default VirtualNetworkGatewayPolicyGroup or not. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
policyMembers []VirtualNetworkGatewayPolicyGroupMember_STATUS |
PolicyMembers: Multiple PolicyMembers for VirtualNetworkGatewayPolicyGroup. |
priority int |
Priority: Priority for VirtualNetworkGatewayPolicyGroup. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the VirtualNetworkGatewayPolicyGroup resource. |
vngClientConnectionConfigurations []SubResource_STATUS |
VngClientConnectionConfigurations: List of references to vngClientConnectionConfigurations. |
VirtualNetworkGatewayPropertiesFormat_AdminState
(string
alias)
(Appears on:VirtualNetworkGateway_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
VirtualNetworkGatewayPropertiesFormat_AdminState_STATUS
(string
alias)
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
VirtualNetworkGatewayPropertiesFormat_GatewayType
(string
alias)
(Appears on:VirtualNetworkGateway_Spec)
Value | Description |
---|---|
"ExpressRoute" |
|
"LocalGateway" |
|
"Vpn" |
VirtualNetworkGatewayPropertiesFormat_GatewayType_STATUS
(string
alias)
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
Value | Description |
---|---|
"ExpressRoute" |
|
"LocalGateway" |
|
"Vpn" |
VirtualNetworkGatewayPropertiesFormat_ResiliencyModel
(string
alias)
(Appears on:VirtualNetworkGateway_Spec)
Value | Description |
---|---|
"MultiHomed" |
|
"SingleHomed" |
VirtualNetworkGatewayPropertiesFormat_ResiliencyModel_STATUS
(string
alias)
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
Value | Description |
---|---|
"MultiHomed" |
|
"SingleHomed" |
VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration
(string
alias)
(Appears on:VirtualNetworkGateway_Spec)
Value | Description |
---|---|
"Generation1" |
|
"Generation2" |
|
"None" |
VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_STATUS
(string
alias)
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
Value | Description |
---|---|
"Generation1" |
|
"Generation2" |
|
"None" |
VirtualNetworkGatewayPropertiesFormat_VpnType
(string
alias)
(Appears on:VirtualNetworkGateway_Spec)
Value | Description |
---|---|
"PolicyBased" |
|
"RouteBased" |
VirtualNetworkGatewayPropertiesFormat_VpnType_STATUS
(string
alias)
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
Value | Description |
---|---|
"PolicyBased" |
|
"RouteBased" |
VirtualNetworkGatewaySku
(Appears on:VirtualNetworkGateway_Spec)
VirtualNetworkGatewaySku details.
Field | Description |
---|---|
name VirtualNetworkGatewaySku_Name |
Name: Gateway SKU name. |
tier VirtualNetworkGatewaySku_Tier |
Tier: Gateway SKU tier. |
VirtualNetworkGatewaySku_Name
(string
alias)
(Appears on:VirtualNetworkGatewaySku)
Value | Description |
---|---|
"Basic" |
|
"ErGw1AZ" |
|
"ErGw2AZ" |
|
"ErGw3AZ" |
|
"ErGwScale" |
|
"HighPerformance" |
|
"Standard" |
|
"UltraPerformance" |
|
"VpnGw1" |
|
"VpnGw1AZ" |
|
"VpnGw2" |
|
"VpnGw2AZ" |
|
"VpnGw3" |
|
"VpnGw3AZ" |
|
"VpnGw4" |
|
"VpnGw4AZ" |
|
"VpnGw5" |
|
"VpnGw5AZ" |
VirtualNetworkGatewaySku_Name_STATUS
(string
alias)
(Appears on:VirtualNetworkGatewaySku_STATUS)
Value | Description |
---|---|
"Basic" |
|
"ErGw1AZ" |
|
"ErGw2AZ" |
|
"ErGw3AZ" |
|
"ErGwScale" |
|
"HighPerformance" |
|
"Standard" |
|
"UltraPerformance" |
|
"VpnGw1" |
|
"VpnGw1AZ" |
|
"VpnGw2" |
|
"VpnGw2AZ" |
|
"VpnGw3" |
|
"VpnGw3AZ" |
|
"VpnGw4" |
|
"VpnGw4AZ" |
|
"VpnGw5" |
|
"VpnGw5AZ" |
VirtualNetworkGatewaySku_STATUS
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
VirtualNetworkGatewaySku details.
Field | Description |
---|---|
capacity int |
Capacity: The capacity. |
name VirtualNetworkGatewaySku_Name_STATUS |
Name: Gateway SKU name. |
tier VirtualNetworkGatewaySku_Tier_STATUS |
Tier: Gateway SKU tier. |
VirtualNetworkGatewaySku_Tier
(string
alias)
(Appears on:VirtualNetworkGatewaySku)
Value | Description |
---|---|
"Basic" |
|
"ErGw1AZ" |
|
"ErGw2AZ" |
|
"ErGw3AZ" |
|
"ErGwScale" |
|
"HighPerformance" |
|
"Standard" |
|
"UltraPerformance" |
|
"VpnGw1" |
|
"VpnGw1AZ" |
|
"VpnGw2" |
|
"VpnGw2AZ" |
|
"VpnGw3" |
|
"VpnGw3AZ" |
|
"VpnGw4" |
|
"VpnGw4AZ" |
|
"VpnGw5" |
|
"VpnGw5AZ" |
VirtualNetworkGatewaySku_Tier_STATUS
(string
alias)
(Appears on:VirtualNetworkGatewaySku_STATUS)
Value | Description |
---|---|
"Basic" |
|
"ErGw1AZ" |
|
"ErGw2AZ" |
|
"ErGw3AZ" |
|
"ErGwScale" |
|
"HighPerformance" |
|
"Standard" |
|
"UltraPerformance" |
|
"VpnGw1" |
|
"VpnGw1AZ" |
|
"VpnGw2" |
|
"VpnGw2AZ" |
|
"VpnGw3" |
|
"VpnGw3AZ" |
|
"VpnGw4" |
|
"VpnGw4AZ" |
|
"VpnGw5" |
|
"VpnGw5AZ" |
VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded
(Appears on:VirtualNetworkGateway)
A common class for general resource information.
Field | Description |
---|---|
activeActive bool |
ActiveActive: ActiveActive flag. |
adminState VirtualNetworkGatewayPropertiesFormat_AdminState_STATUS |
AdminState: Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet |
allowRemoteVnetTraffic bool |
AllowRemoteVnetTraffic: Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN. |
allowVirtualWanTraffic bool |
AllowVirtualWanTraffic: Configures this gateway to accept traffic from remote Virtual WAN networks. |
autoScaleConfiguration VirtualNetworkGatewayAutoScaleConfiguration_STATUS |
AutoScaleConfiguration: Autoscale configuration for virutal network gateway |
bgpSettings BgpSettings_STATUS |
BgpSettings: Virtual network gateway’s BGP speaker settings. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
customRoutes AddressSpace_STATUS |
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. |
disableIPSecReplayProtection bool |
DisableIPSecReplayProtection: disableIPSecReplayProtection flag. |
enableBgp bool |
EnableBgp: Whether BGP is enabled for this virtual network gateway or not. |
enableBgpRouteTranslationForNat bool |
EnableBgpRouteTranslationForNat: EnableBgpRouteTranslationForNat flag. |
enableDnsForwarding bool |
EnableDnsForwarding: Whether dns forwarding is enabled or not. |
enablePrivateIpAddress bool |
EnablePrivateIpAddress: Whether private IP needs to be enabled on this gateway for connections or not. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
extendedLocation ExtendedLocation_STATUS |
ExtendedLocation: The extended location of type local virtual network gateway. |
gatewayDefaultSite SubResource_STATUS |
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. |
gatewayType VirtualNetworkGatewayPropertiesFormat_GatewayType_STATUS |
GatewayType: The type of this virtual network gateway. |
id string |
Id: Resource ID. |
identity ManagedServiceIdentity_STATUS |
Identity: The identity of the virtual network gateway, if configured. |
inboundDnsForwardingEndpoint string |
InboundDnsForwardingEndpoint: The IP address allocated by the gateway to which dns requests can be sent. |
ipConfigurations []VirtualNetworkGatewayIPConfiguration_STATUS |
IpConfigurations: IP configurations for virtual network gateway. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
natRules []VirtualNetworkGatewayNatRule_STATUS |
NatRules: NatRules for virtual network gateway. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the virtual network gateway resource. |
resiliencyModel VirtualNetworkGatewayPropertiesFormat_ResiliencyModel_STATUS |
ResiliencyModel: Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed |
resourceGuid string |
ResourceGuid: The resource GUID property of the virtual network gateway resource. |
sku VirtualNetworkGatewaySku_STATUS |
Sku: The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
vNetExtendedLocationResourceId string |
VNetExtendedLocationResourceId: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. |
virtualNetworkGatewayPolicyGroups []VirtualNetworkGatewayPolicyGroup_STATUS |
VirtualNetworkGatewayPolicyGroups: The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway. |
vpnClientConfiguration VpnClientConfiguration_STATUS |
VpnClientConfiguration: The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations. |
vpnGatewayGeneration VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_STATUS |
VpnGatewayGeneration: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. |
vpnType VirtualNetworkGatewayPropertiesFormat_VpnType_STATUS |
VpnType: The type of this virtual network gateway. |
VirtualNetworkGateway_Spec
(Appears on:VirtualNetworkGateway)
Field | Description |
---|---|
activeActive bool |
ActiveActive: ActiveActive flag. |
adminState VirtualNetworkGatewayPropertiesFormat_AdminState |
AdminState: Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet |
allowRemoteVnetTraffic bool |
AllowRemoteVnetTraffic: Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN. |
allowVirtualWanTraffic bool |
AllowVirtualWanTraffic: Configures this gateway to accept traffic from remote Virtual WAN networks. |
autoScaleConfiguration VirtualNetworkGatewayAutoScaleConfiguration |
AutoScaleConfiguration: Autoscale configuration for virutal network gateway |
azureName string |
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. |
bgpSettings BgpSettings |
BgpSettings: Virtual network gateway’s BGP speaker settings. |
customRoutes AddressSpace |
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. |
disableIPSecReplayProtection bool |
DisableIPSecReplayProtection: disableIPSecReplayProtection flag. |
enableBgp bool |
EnableBgp: Whether BGP is enabled for this virtual network gateway or not. |
enableBgpRouteTranslationForNat bool |
EnableBgpRouteTranslationForNat: EnableBgpRouteTranslationForNat flag. |
enableDnsForwarding bool |
EnableDnsForwarding: Whether dns forwarding is enabled or not. |
enablePrivateIpAddress bool |
EnablePrivateIpAddress: Whether private IP needs to be enabled on this gateway for connections or not. |
extendedLocation ExtendedLocation |
ExtendedLocation: The extended location of type local virtual network gateway. |
gatewayDefaultSite SubResource |
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. |
gatewayType VirtualNetworkGatewayPropertiesFormat_GatewayType |
GatewayType: The type of this virtual network gateway. |
identity ManagedServiceIdentity |
Identity: The identity of the virtual network gateway, if configured. |
ipConfigurations []VirtualNetworkGatewayIPConfiguration |
IpConfigurations: IP configurations for virtual network gateway. |
location string |
Location: Resource location. |
natRules []VirtualNetworkGatewayNatRule |
NatRules: NatRules for virtual network gateway. |
operatorSpec VirtualNetworkGatewayOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
resiliencyModel VirtualNetworkGatewayPropertiesFormat_ResiliencyModel |
ResiliencyModel: Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed |
sku VirtualNetworkGatewaySku |
Sku: The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. |
tags map[string]string |
Tags: Resource tags. |
vNetExtendedLocationResourceReference genruntime.ResourceReference |
VNetExtendedLocationResourceReference: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. |
virtualNetworkGatewayPolicyGroups []VirtualNetworkGatewayPolicyGroup |
VirtualNetworkGatewayPolicyGroups: The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway. |
vpnClientConfiguration VpnClientConfiguration |
VpnClientConfiguration: The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations. |
vpnGatewayGeneration VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration |
VpnGatewayGeneration: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. |
vpnType VirtualNetworkGatewayPropertiesFormat_VpnType |
VpnType: The type of this virtual network gateway. |
VirtualNetworkOperatorSpec
(Appears on:VirtualNetwork_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
VirtualNetworkPeeringPropertiesFormat_PeeringState
(string
alias)
(Appears on:VirtualNetworksVirtualNetworkPeering_Spec)
Value | Description |
---|---|
"Connected" |
|
"Disconnected" |
|
"Initiated" |
VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS
(string
alias)
(Appears on:VirtualNetworksVirtualNetworkPeering_STATUS)
Value | Description |
---|---|
"Connected" |
|
"Disconnected" |
|
"Initiated" |
VirtualNetworkPeeringPropertiesFormat_PeeringSyncLevel
(string
alias)
(Appears on:VirtualNetworksVirtualNetworkPeering_Spec)
Value | Description |
---|---|
"FullyInSync" |
|
"LocalAndRemoteNotInSync" |
|
"LocalNotInSync" |
|
"RemoteNotInSync" |
VirtualNetworkPeeringPropertiesFormat_PeeringSyncLevel_STATUS
(string
alias)
(Appears on:VirtualNetworksVirtualNetworkPeering_STATUS)
Value | Description |
---|---|
"FullyInSync" |
|
"LocalAndRemoteNotInSync" |
|
"LocalNotInSync" |
|
"RemoteNotInSync" |
VirtualNetworkTapSpec_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)
Virtual Network Tap resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
VirtualNetworkTap_STATUS_NetworkInterface_SubResourceEmbedded
(Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)
Virtual Network Tap resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
VirtualNetwork_STATUS
(Appears on:VirtualNetwork)
Virtual Network resource.
Field | Description |
---|---|
addressSpace AddressSpace_STATUS |
AddressSpace: The AddressSpace that contains an array of IP address ranges that can be used by subnets. |
bgpCommunities VirtualNetworkBgpCommunities_STATUS |
BgpCommunities: Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
ddosProtectionPlan SubResource_STATUS |
DdosProtectionPlan: The DDoS protection plan associated with the virtual network. |
dhcpOptions DhcpOptions_STATUS |
DhcpOptions: The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. |
enableDdosProtection bool |
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. |
enableVmProtection bool |
EnableVmProtection: Indicates if VM protection is enabled for all the subnets in the virtual network. |
encryption VirtualNetworkEncryption_STATUS |
Encryption: Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
extendedLocation ExtendedLocation_STATUS |
ExtendedLocation: The extended location of the virtual network. |
flowLogs []FlowLog_STATUS_SubResourceEmbedded |
FlowLogs: A collection of references to flow log resources. |
flowTimeoutInMinutes int |
FlowTimeoutInMinutes: The FlowTimeout value (in minutes) for the Virtual Network |
id string |
Id: Resource ID. |
ipAllocations []SubResource_STATUS |
IpAllocations: Array of IpAllocation which reference this VNET. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
privateEndpointVNetPolicies PrivateEndpointVNetPolicies_STATUS |
PrivateEndpointVNetPolicies: Private Endpoint VNet Policies. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the virtual network resource. |
resourceGuid string |
ResourceGuid: The resourceGuid property of the Virtual Network resource. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
VirtualNetwork_Spec
(Appears on:VirtualNetwork)
Field | Description |
---|---|
addressSpace AddressSpace |
AddressSpace: The AddressSpace that contains an array of IP address ranges that can be used by subnets. |
azureName string |
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. |
bgpCommunities VirtualNetworkBgpCommunities |
BgpCommunities: Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. |
ddosProtectionPlan SubResource |
DdosProtectionPlan: The DDoS protection plan associated with the virtual network. |
dhcpOptions DhcpOptions |
DhcpOptions: The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. |
enableDdosProtection bool |
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. |
enableVmProtection bool |
EnableVmProtection: Indicates if VM protection is enabled for all the subnets in the virtual network. |
encryption VirtualNetworkEncryption |
Encryption: Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. |
extendedLocation ExtendedLocation |
ExtendedLocation: The extended location of the virtual network. |
flowTimeoutInMinutes int |
FlowTimeoutInMinutes: The FlowTimeout value (in minutes) for the Virtual Network |
ipAllocations []SubResource |
IpAllocations: Array of IpAllocation which reference this VNET. |
location string |
Location: Resource location. |
operatorSpec VirtualNetworkOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
privateEndpointVNetPolicies PrivateEndpointVNetPolicies |
PrivateEndpointVNetPolicies: Private Endpoint VNet Policies. |
tags map[string]string |
Tags: Resource tags. |
VirtualNetworksSubnet
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}p>
Field | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||
spec VirtualNetworksSubnet_Spec |
|
||||||||||||||||||||||||||||||||||
status VirtualNetworksSubnet_STATUS |
VirtualNetworksSubnetOperatorSpec
(Appears on:VirtualNetworksSubnet_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
VirtualNetworksSubnet_STATUS
(Appears on:VirtualNetworksSubnet)
Field | Description |
---|---|
addressPrefix string |
AddressPrefix: The address prefix for the subnet. |
addressPrefixes []string |
AddressPrefixes: List of address prefixes for the subnet. |
applicationGatewayIPConfigurations []ApplicationGatewayIPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded |
ApplicationGatewayIPConfigurations: Application gateway IP configurations of virtual network resource. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
defaultOutboundAccess bool |
DefaultOutboundAccess: Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet. |
delegations []Delegation_STATUS |
Delegations: An array of references to the delegations on the subnet. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
ipAllocations []SubResource_STATUS |
IpAllocations: Array of IpAllocation which reference this subnet. |
ipConfigurationProfiles []IPConfigurationProfile_STATUS |
IpConfigurationProfiles: Array of IP configuration profiles which reference this subnet. |
ipConfigurations []IPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded |
IpConfigurations: An array of references to the network interface IP configurations using subnet. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
natGateway SubResource_STATUS |
NatGateway: Nat gateway associated with this subnet. |
networkSecurityGroup NetworkSecurityGroup_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded |
NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource. |
privateEndpointNetworkPolicies SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_STATUS |
PrivateEndpointNetworkPolicies: Enable or Disable apply network policies on private end point in the subnet. |
privateEndpoints []PrivateEndpoint_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded |
PrivateEndpoints: An array of references to private endpoints. |
privateLinkServiceNetworkPolicies SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_STATUS |
PrivateLinkServiceNetworkPolicies: Enable or Disable apply network policies on private link service in the subnet. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the subnet resource. |
purpose string |
Purpose: A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. |
resourceNavigationLinks []ResourceNavigationLink_STATUS |
ResourceNavigationLinks: An array of references to the external resources using subnet. |
routeTable RouteTable_STATUS_SubResourceEmbedded |
RouteTable: The reference to the RouteTable resource. |
serviceAssociationLinks []ServiceAssociationLink_STATUS |
ServiceAssociationLinks: An array of references to services injecting into this subnet. |
serviceEndpointPolicies []ServiceEndpointPolicy_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded |
ServiceEndpointPolicies: An array of service endpoint policies. |
serviceEndpoints []ServiceEndpointPropertiesFormat_STATUS |
ServiceEndpoints: An array of service endpoints. |
sharingScope SubnetPropertiesFormat_SharingScope_STATUS |
SharingScope: Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. |
type string |
Type: Resource type. |
VirtualNetworksSubnet_Spec
(Appears on:VirtualNetworksSubnet)
Field | Description |
---|---|
addressPrefix string |
AddressPrefix: The address prefix for the subnet. |
addressPrefixes []string |
AddressPrefixes: List of address prefixes for the subnet. |
applicationGatewayIPConfigurations []ApplicationGatewayIPConfiguration_VirtualNetworks_Subnet_SubResourceEmbedded |
ApplicationGatewayIPConfigurations: Application gateway IP configurations of virtual network resource. |
azureName string |
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. |
defaultOutboundAccess bool |
DefaultOutboundAccess: Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet. |
delegations []Delegation |
Delegations: An array of references to the delegations on the subnet. |
ipAllocations []SubResource |
IpAllocations: Array of IpAllocation which reference this subnet. |
natGateway SubResource |
NatGateway: Nat gateway associated with this subnet. |
networkSecurityGroup NetworkSecurityGroupSpec_VirtualNetworks_Subnet_SubResourceEmbedded |
NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource. |
operatorSpec VirtualNetworksSubnetOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
privateEndpointNetworkPolicies SubnetPropertiesFormat_PrivateEndpointNetworkPolicies |
PrivateEndpointNetworkPolicies: Enable or Disable apply network policies on private end point in the subnet. |
privateLinkServiceNetworkPolicies SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies |
PrivateLinkServiceNetworkPolicies: Enable or Disable apply network policies on private link service in the subnet. |
routeTable RouteTableSpec_VirtualNetworks_Subnet_SubResourceEmbedded |
RouteTable: The reference to the RouteTable resource. |
serviceEndpointPolicies []ServiceEndpointPolicySpec_VirtualNetworks_Subnet_SubResourceEmbedded |
ServiceEndpointPolicies: An array of service endpoint policies. |
serviceEndpoints []ServiceEndpointPropertiesFormat |
ServiceEndpoints: An array of service endpoints. |
sharingScope SubnetPropertiesFormat_SharingScope |
SharingScope: Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. |
VirtualNetworksVirtualNetworkPeering
Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2024-03-01/virtualNetwork.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||
spec VirtualNetworksVirtualNetworkPeering_Spec |
|
||||||||||||||||||||||||||||||||||||||||
status VirtualNetworksVirtualNetworkPeering_STATUS |
VirtualNetworksVirtualNetworkPeeringOperatorSpec
(Appears on:VirtualNetworksVirtualNetworkPeering_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
VirtualNetworksVirtualNetworkPeering_STATUS
(Appears on:VirtualNetworksVirtualNetworkPeering)
Field | Description |
---|---|
allowForwardedTraffic bool |
AllowForwardedTraffic: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. |
allowGatewayTransit bool |
AllowGatewayTransit: If gateway links can be used in remote virtual networking to link to this virtual network. |
allowVirtualNetworkAccess bool |
AllowVirtualNetworkAccess: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
doNotVerifyRemoteGateways bool |
DoNotVerifyRemoteGateways: If we need to verify the provisioning state of the remote gateway. |
enableOnlyIPv6Peering bool |
EnableOnlyIPv6Peering: Whether only Ipv6 address space is peered for subnet peering. |
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
localAddressSpace AddressSpace_STATUS |
LocalAddressSpace: The local address space of the local virtual network that is peered. |
localSubnetNames []string |
LocalSubnetNames: List of local subnet names that are subnet peered with remote virtual network. |
localVirtualNetworkAddressSpace AddressSpace_STATUS |
LocalVirtualNetworkAddressSpace: The current local address space of the local virtual network that is peered. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
peerCompleteVnets bool |
PeerCompleteVnets: Whether complete virtual network address space is peered. |
peeringState VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS |
PeeringState: The status of the virtual network peering. |
peeringSyncLevel VirtualNetworkPeeringPropertiesFormat_PeeringSyncLevel_STATUS |
PeeringSyncLevel: The peering sync status of the virtual network peering. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the virtual network peering resource. |
remoteAddressSpace AddressSpace_STATUS |
RemoteAddressSpace: The reference to the address space peered with the remote virtual network. |
remoteBgpCommunities VirtualNetworkBgpCommunities_STATUS |
RemoteBgpCommunities: The reference to the remote virtual network’s Bgp Communities. |
remoteSubnetNames []string |
RemoteSubnetNames: List of remote subnet names from remote virtual network that are subnet peered. |
remoteVirtualNetwork SubResource_STATUS |
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). |
remoteVirtualNetworkAddressSpace AddressSpace_STATUS |
RemoteVirtualNetworkAddressSpace: The reference to the current address space of the remote virtual network. |
remoteVirtualNetworkEncryption VirtualNetworkEncryption_STATUS |
RemoteVirtualNetworkEncryption: The reference to the remote virtual network’s encryption |
resourceGuid string |
ResourceGuid: The resourceGuid property of the Virtual Network peering resource. |
type string |
Type: Resource type. |
useRemoteGateways bool |
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. |
VirtualNetworksVirtualNetworkPeering_Spec
(Appears on:VirtualNetworksVirtualNetworkPeering)
Field | Description |
---|---|
allowForwardedTraffic bool |
AllowForwardedTraffic: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. |
allowGatewayTransit bool |
AllowGatewayTransit: If gateway links can be used in remote virtual networking to link to this virtual network. |
allowVirtualNetworkAccess bool |
AllowVirtualNetworkAccess: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. |
azureName string |
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. |
doNotVerifyRemoteGateways bool |
DoNotVerifyRemoteGateways: If we need to verify the provisioning state of the remote gateway. |
enableOnlyIPv6Peering bool |
EnableOnlyIPv6Peering: Whether only Ipv6 address space is peered for subnet peering. |
localAddressSpace AddressSpace |
LocalAddressSpace: The local address space of the local virtual network that is peered. |
localSubnetNames []string |
LocalSubnetNames: List of local subnet names that are subnet peered with remote virtual network. |
localVirtualNetworkAddressSpace AddressSpace |
LocalVirtualNetworkAddressSpace: The current local address space of the local virtual network that is peered. |
operatorSpec VirtualNetworksVirtualNetworkPeeringOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
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 |
peerCompleteVnets bool |
PeerCompleteVnets: Whether complete virtual network address space is peered. |
peeringState VirtualNetworkPeeringPropertiesFormat_PeeringState |
PeeringState: The status of the virtual network peering. |
peeringSyncLevel VirtualNetworkPeeringPropertiesFormat_PeeringSyncLevel |
PeeringSyncLevel: The peering sync status of the virtual network peering. |
remoteAddressSpace AddressSpace |
RemoteAddressSpace: The reference to the address space peered with the remote virtual network. |
remoteBgpCommunities VirtualNetworkBgpCommunities |
RemoteBgpCommunities: The reference to the remote virtual network’s Bgp Communities. |
remoteSubnetNames []string |
RemoteSubnetNames: List of remote subnet names from remote virtual network that are subnet peered. |
remoteVirtualNetwork SubResource |
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). |
remoteVirtualNetworkAddressSpace AddressSpace |
RemoteVirtualNetworkAddressSpace: The reference to the current address space of the remote virtual network. |
useRemoteGateways bool |
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. |
VngClientConnectionConfiguration
(Appears on:VpnClientConfiguration)
A vpn client connection configuration for client connection configuration.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
VngClientConnectionConfiguration_STATUS
(Appears on:VpnClientConfiguration_STATUS)
A vpn client connection configuration for client connection configuration.
Field | Description |
---|---|
id string |
Id: Resource ID. |
VpnClientConfiguration
(Appears on:VirtualNetworkGateway_Spec)
VpnClientConfiguration for P2S client.
Field | Description |
---|---|
aadAudience string |
AadAudience: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. |
aadIssuer string |
AadIssuer: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. |
aadTenant string |
AadTenant: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. |
radiusServerAddress string |
RadiusServerAddress: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. |
radiusServerSecret string |
RadiusServerSecret: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. |
radiusServers []RadiusServer |
RadiusServers: The radiusServers property for multiple radius server configuration. |
vngClientConnectionConfigurations []VngClientConnectionConfiguration |
VngClientConnectionConfigurations: per ip address pool connection policy for virtual network gateway P2S client. |
vpnAuthenticationTypes []VpnClientConfiguration_VpnAuthenticationTypes |
VpnAuthenticationTypes: VPN authentication types for the virtual network gateway.. |
vpnClientAddressPool AddressSpace |
VpnClientAddressPool: The reference to the address space resource which represents Address space for P2S VpnClient. |
vpnClientIpsecPolicies []IpsecPolicy |
VpnClientIpsecPolicies: VpnClientIpsecPolicies for virtual network gateway P2S client. |
vpnClientProtocols []VpnClientConfiguration_VpnClientProtocols |
VpnClientProtocols: VpnClientProtocols for Virtual network gateway. |
vpnClientRevokedCertificates []VpnClientRevokedCertificate |
VpnClientRevokedCertificates: VpnClientRevokedCertificate for Virtual network gateway. |
vpnClientRootCertificates []VpnClientRootCertificate |
VpnClientRootCertificates: VpnClientRootCertificate for virtual network gateway. |
VpnClientConfiguration_STATUS
(Appears on:VirtualNetworkGateway_STATUS_VirtualNetworkGateway_SubResourceEmbedded)
VpnClientConfiguration for P2S client.
Field | Description |
---|---|
aadAudience string |
AadAudience: The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. |
aadIssuer string |
AadIssuer: The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. |
aadTenant string |
AadTenant: The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. |
radiusServerAddress string |
RadiusServerAddress: The radius server address property of the VirtualNetworkGateway resource for vpn client connection. |
radiusServerSecret string |
RadiusServerSecret: The radius secret property of the VirtualNetworkGateway resource for vpn client connection. |
radiusServers []RadiusServer_STATUS |
RadiusServers: The radiusServers property for multiple radius server configuration. |
vngClientConnectionConfigurations []VngClientConnectionConfiguration_STATUS |
VngClientConnectionConfigurations: per ip address pool connection policy for virtual network gateway P2S client. |
vpnAuthenticationTypes []VpnClientConfiguration_VpnAuthenticationTypes_STATUS |
VpnAuthenticationTypes: VPN authentication types for the virtual network gateway.. |
vpnClientAddressPool AddressSpace_STATUS |
VpnClientAddressPool: The reference to the address space resource which represents Address space for P2S VpnClient. |
vpnClientIpsecPolicies []IpsecPolicy_STATUS |
VpnClientIpsecPolicies: VpnClientIpsecPolicies for virtual network gateway P2S client. |
vpnClientProtocols []VpnClientConfiguration_VpnClientProtocols_STATUS |
VpnClientProtocols: VpnClientProtocols for Virtual network gateway. |
vpnClientRevokedCertificates []VpnClientRevokedCertificate_STATUS |
VpnClientRevokedCertificates: VpnClientRevokedCertificate for Virtual network gateway. |
vpnClientRootCertificates []VpnClientRootCertificate_STATUS |
VpnClientRootCertificates: VpnClientRootCertificate for virtual network gateway. |
VpnClientConfiguration_VpnAuthenticationTypes
(string
alias)
(Appears on:VpnClientConfiguration)
Value | Description |
---|---|
"AAD" |
|
"Certificate" |
|
"Radius" |
VpnClientConfiguration_VpnAuthenticationTypes_STATUS
(string
alias)
(Appears on:VpnClientConfiguration_STATUS)
Value | Description |
---|---|
"AAD" |
|
"Certificate" |
|
"Radius" |
VpnClientConfiguration_VpnClientProtocols
(string
alias)
(Appears on:VpnClientConfiguration)
Value | Description |
---|---|
"IkeV2" |
|
"OpenVPN" |
|
"SSTP" |
VpnClientConfiguration_VpnClientProtocols_STATUS
(string
alias)
(Appears on:VpnClientConfiguration_STATUS)
Value | Description |
---|---|
"IkeV2" |
|
"OpenVPN" |
|
"SSTP" |
VpnClientRevokedCertificate
(Appears on:VpnClientConfiguration)
VPN client revoked certificate of virtual network gateway.
Field | Description |
---|---|
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
thumbprint string |
Thumbprint: The revoked VPN client certificate thumbprint. |
VpnClientRevokedCertificate_STATUS
(Appears on:VpnClientConfiguration_STATUS)
VPN client revoked certificate of virtual network gateway.
Field | Description |
---|---|
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the VPN client revoked certificate resource. |
thumbprint string |
Thumbprint: The revoked VPN client certificate thumbprint. |
VpnClientRootCertificate
(Appears on:VpnClientConfiguration)
VPN client root certificate of virtual network gateway.
Field | Description |
---|---|
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
publicCertData string |
PublicCertData: The certificate public data. |
VpnClientRootCertificate_STATUS
(Appears on:VpnClientConfiguration_STATUS)
VPN client root certificate of virtual network gateway.
Field | Description |
---|---|
etag string |
Etag: A unique read-only string that changes whenever the resource is updated. |
id string |
Id: Resource ID. |
name string |
Name: The name of the resource that is unique within a resource group. This name can be used to access the resource. |
provisioningState ProvisioningState_STATUS |
ProvisioningState: The provisioning state of the VPN client root certificate resource. |
publicCertData string |
PublicCertData: The certificate public data. |
VpnNatRuleMapping
(Appears on:VirtualNetworkGatewayNatRule)
Vpn NatRule mapping.
Field | Description |
---|---|
addressSpace string |
AddressSpace: Address space for Vpn NatRule mapping. |
portRange string |
PortRange: Port range for Vpn NatRule mapping. |
VpnNatRuleMapping_STATUS
(Appears on:VirtualNetworkGatewayNatRule_STATUS)
Vpn NatRule mapping.
Field | Description |
---|---|
addressSpace string |
AddressSpace: Address space for Vpn NatRule mapping. |
portRange string |
PortRange: Port range for Vpn NatRule mapping. |