network.azure.com/v1api20201101

network.azure.com/v1api20201101

Package v1api20201101 contains API Schema definitions for the network v1api20201101 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2020-11-01"

    AddressSpace

    (Appears on:VirtualNetworkGateway_Spec, VirtualNetwork_Spec, VirtualNetworks_VirtualNetworkPeering_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_ARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_ARM, VirtualNetworkPeeringPropertiesFormat_ARM, VirtualNetworkPropertiesFormat_ARM, VpnClientConfiguration_ARM)

    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, VirtualNetwork_STATUS, VirtualNetworks_VirtualNetworkPeering_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.

    AddressSpace_STATUS_ARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_STATUS_ARM, VirtualNetworkPeeringPropertiesFormat_STATUS_ARM, VirtualNetworkPropertiesFormat_STATUS_ARM, VpnClientConfiguration_STATUS_ARM)

    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_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_ARM)

    Backend Address Pool of an application gateway.

    Field Description
    id
    string

    ApplicationGatewayBackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)

    Backend Address Pool of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayBackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM)

    Backend Address Pool of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayIPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded

    (Appears on:VirtualNetworks_Subnet_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_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

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

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayIPConfiguration_VirtualNetwork_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM)

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

    Field Description
    id
    string

    ApplicationGatewayIPConfiguration_VirtualNetworks_Subnet_SubResourceEmbedded

    (Appears on:VirtualNetworks_Subnet_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.

    ApplicationGatewayIPConfiguration_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM)

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

    Field Description
    id
    string

    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_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_ARM)

    An application security group in a resource group.

    Field Description
    id
    string

    ApplicationSecurityGroupSpec_NetworkSecurityGroup_SubResourceEmbedded_ARM

    (Appears on:SecurityRulePropertiesFormat_NetworkSecurityGroup_SubResourceEmbedded_ARM)

    An application security group in a resource group.

    Field Description
    id
    string

    ApplicationSecurityGroupSpec_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded

    (Appears on:NetworkSecurityGroups_SecurityRule_Spec)

    An application security group in a resource group.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    ApplicationSecurityGroupSpec_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded_ARM

    (Appears on:SecurityRulePropertiesFormat_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded_ARM)

    An application security group in a resource group.

    Field Description
    id
    string

    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_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM)

    An application security group in a resource group.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationSecurityGroup_STATUS_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded

    (Appears on:NetworkSecurityGroups_SecurityRule_STATUS)

    An application security group in a resource group.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationSecurityGroup_STATUS_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded_ARM

    (Appears on:SecurityRulePropertiesFormat_STATUS_ARM)

    An application security group in a resource group.

    Field Description
    id
    string

    Id: Resource ID.

    BackendAddressPoolPropertiesFormat_ARM

    (Appears on:BackendAddressPool_LoadBalancer_SubResourceEmbedded_ARM)

    Properties of the backend address pool.

    Field Description
    loadBalancerBackendAddresses
    []LoadBalancerBackendAddress_ARM

    LoadBalancerBackendAddresses: An array of backend addresses.

    BackendAddressPoolPropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded_ARM)

    Properties of the backend address pool.

    Field Description
    backendIPConfigurations
    []NetworkInterfaceIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    BackendIPConfigurations: An array of references to IP addresses defined in network interfaces.

    loadBalancerBackendAddresses
    []LoadBalancerBackendAddress_STATUS_ARM

    LoadBalancerBackendAddresses: An array of backend addresses.

    loadBalancingRules
    []SubResource_STATUS_ARM

    LoadBalancingRules: An array of references to load balancing rules that use this backend address pool.

    outboundRule
    SubResource_STATUS_ARM

    OutboundRule: A reference to an outbound rule that uses this backend address pool.

    outboundRules
    []SubResource_STATUS_ARM

    OutboundRules: An array of references to outbound rules that use this backend address pool.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the backend address pool resource.

    BackendAddressPool_LoadBalancer_SubResourceEmbedded

    (Appears on:LoadBalancer_Spec)

    Pool of backend IP addresses.

    Field Description
    loadBalancerBackendAddresses
    []LoadBalancerBackendAddress

    LoadBalancerBackendAddresses: An array of backend addresses.

    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.

    BackendAddressPool_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:LoadBalancerPropertiesFormat_ARM)

    Pool of backend IP addresses.

    Field Description
    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.

    properties
    BackendAddressPoolPropertiesFormat_ARM

    Properties: Properties of load balancer backend address pool.

    BackendAddressPool_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)

    Pool of backend IP addresses.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    BackendAddressPool_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_ARM)

    Pool of backend IP addresses.

    Field Description
    id
    string

    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.

    etag
    string

    Etag: A unique read-only string that changes whenever the resource is updated.

    id
    string

    Id: Resource ID.

    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.

    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.

    type
    string

    Type: Type of the resource.

    BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:LoadBalancerPropertiesFormat_STATUS_ARM)

    Pool of backend IP addresses.

    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 the set of backend address pools used by the load balancer. This name can be used to access the resource.

    properties
    BackendAddressPoolPropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    Properties: Properties of load balancer backend address pool.

    type
    string

    Type: Type of the resource.

    BackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)

    Pool of backend IP addresses.

    Field Description
    id
    string

    Id: Resource ID.

    BackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM)

    Pool of backend IP addresses.

    Field Description
    id
    string

    Id: Resource ID.

    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_ARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_ARM)

    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_ARM

    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)

    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.

    BgpSettings_STATUS_ARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_STATUS_ARM)

    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_ARM

    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.

    DdosSettings

    (Appears on:PublicIPAddress_Spec)

    Contains the DDoS protection settings of the public IP.

    Field Description
    ddosCustomPolicy
    SubResource

    DdosCustomPolicy: The DDoS custom policy associated with the public IP.

    protectedIP
    bool

    ProtectedIP: Enables DDoS protection on the public IP.

    protectionCoverage
    DdosSettings_ProtectionCoverage

    ProtectionCoverage: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

    DdosSettings_ARM

    (Appears on:PublicIPAddressPropertiesFormat_ARM)

    Contains the DDoS protection settings of the public IP.

    Field Description
    ddosCustomPolicy
    SubResource_ARM

    DdosCustomPolicy: The DDoS custom policy associated with the public IP.

    protectedIP
    bool

    ProtectedIP: Enables DDoS protection on the public IP.

    protectionCoverage
    DdosSettings_ProtectionCoverage_ARM

    ProtectionCoverage: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

    DdosSettings_ProtectionCoverage (string alias)

    (Appears on:DdosSettings)

    Value Description

    "Basic"

    "Standard"

    DdosSettings_ProtectionCoverage_ARM (string alias)

    (Appears on:DdosSettings_ARM)

    Value Description

    "Basic"

    "Standard"

    DdosSettings_ProtectionCoverage_STATUS (string alias)

    (Appears on:DdosSettings_STATUS)

    Value Description

    "Basic"

    "Standard"

    DdosSettings_ProtectionCoverage_STATUS_ARM (string alias)

    (Appears on:DdosSettings_STATUS_ARM)

    Value Description

    "Basic"

    "Standard"

    DdosSettings_STATUS

    (Appears on:PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded)

    Contains the DDoS protection settings of the public IP.

    Field Description
    ddosCustomPolicy
    SubResource_STATUS

    DdosCustomPolicy: The DDoS custom policy associated with the public IP.

    protectedIP
    bool

    ProtectedIP: Enables DDoS protection on the public IP.

    protectionCoverage
    DdosSettings_ProtectionCoverage_STATUS

    ProtectionCoverage: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

    DdosSettings_STATUS_ARM

    (Appears on:PublicIPAddressPropertiesFormat_STATUS_ARM)

    Contains the DDoS protection settings of the public IP.

    Field Description
    ddosCustomPolicy
    SubResource_STATUS_ARM

    DdosCustomPolicy: The DDoS custom policy associated with the public IP.

    protectedIP
    bool

    ProtectedIP: Enables DDoS protection on the public IP.

    protectionCoverage
    DdosSettings_ProtectionCoverage_STATUS_ARM

    ProtectionCoverage: The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

    Delegation

    (Appears on:VirtualNetworks_Subnet_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_ARM

    (Appears on:SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM, SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM)

    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.

    properties
    ServiceDelegationPropertiesFormat_ARM

    Properties: Properties of the subnet.

    Delegation_STATUS

    (Appears on:VirtualNetworks_Subnet_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.

    Delegation_STATUS_ARM

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    Details the service to which the subnet is delegated.

    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 subnet. This name can be used to access the resource.

    properties
    ServiceDelegationPropertiesFormat_STATUS_ARM

    Properties: Properties of the subnet.

    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_ARM (string alias)

    (Appears on:IpsecPolicy_ARM)

    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"

    DhGroup_STATUS_ARM (string alias)

    (Appears on:IpsecPolicy_STATUS_ARM)

    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_ARM

    (Appears on:VirtualNetworkPropertiesFormat_ARM)

    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.

    DhcpOptions_STATUS_ARM

    (Appears on:VirtualNetworkPropertiesFormat_STATUS_ARM)

    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, PublicIPAddress_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_ARM (string alias)

    (Appears on:ExtendedLocation_ARM)

    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"

    ExtendedLocationType_STATUS_ARM (string alias)

    (Appears on:ExtendedLocation_STATUS_ARM)

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

    Value Description

    "EdgeZone"

    ExtendedLocation_ARM

    (Appears on:LoadBalancer_Spec_ARM, NetworkInterface_Spec_ARM, PublicIPAddress_Spec_ARM, VirtualNetworkGateway_Spec_ARM, VirtualNetwork_Spec_ARM)

    ExtendedLocation complex type.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_ARM

    Type: The type of the extended location.

    ExtendedLocation_STATUS

    (Appears on:LoadBalancer_STATUS, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded, VirtualNetworkGateway_STATUS, 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.

    ExtendedLocation_STATUS_ARM

    (Appears on:LoadBalancer_STATUS_ARM, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded_ARM, PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded_ARM, VirtualNetworkGateway_STATUS_ARM, VirtualNetwork_STATUS_ARM)

    ExtendedLocation complex type.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_STATUS_ARM

    Type: The type of the extended location.

    FlowLog_STATUS

    (Appears on:NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded)

    A flow log resource.

    Field Description
    id
    string

    Id: Resource ID.

    FlowLog_STATUS_ARM

    (Appears on:NetworkSecurityGroupPropertiesFormat_STATUS_ARM)

    A flow log resource.

    Field Description
    id
    string

    Id: Resource ID.

    FrontendIPConfigurationPropertiesFormat_ARM

    (Appears on:FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded_ARM)

    Properties of Frontend IP Configuration of the load balancer.

    Field Description
    privateIPAddress
    string

    PrivateIPAddress: The private IP address of the IP configuration.

    privateIPAddressVersion
    IPVersion_ARM

    PrivateIPAddressVersion: Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.

    privateIPAllocationMethod
    IPAllocationMethod_ARM

    PrivateIPAllocationMethod: The Private IP allocation method.

    publicIPAddress
    PublicIPAddressSpec_LoadBalancer_SubResourceEmbedded_ARM

    PublicIPAddress: The reference to the Public IP resource.

    publicIPPrefix
    SubResource_ARM

    PublicIPPrefix: The reference to the Public IP Prefix resource.

    subnet
    Subnet_LoadBalancer_SubResourceEmbedded_ARM

    Subnet: The reference to the subnet resource.

    FrontendIPConfigurationPropertiesFormat_STATUS_ARM

    (Appears on:FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded_ARM)

    Properties of Frontend IP Configuration of the load balancer.

    Field Description
    inboundNatPools
    []SubResource_STATUS_ARM

    InboundNatPools: An array of references to inbound pools that use this frontend IP.

    inboundNatRules
    []SubResource_STATUS_ARM

    InboundNatRules: An array of references to inbound rules that use this frontend IP.

    loadBalancingRules
    []SubResource_STATUS_ARM

    LoadBalancingRules: An array of references to load balancing rules that use this frontend IP.

    outboundRules
    []SubResource_STATUS_ARM

    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_ARM

    PrivateIPAddressVersion: Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.

    privateIPAllocationMethod
    IPAllocationMethod_STATUS_ARM

    PrivateIPAllocationMethod: The Private IP allocation method.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the frontend IP configuration resource.

    publicIPAddress
    PublicIPAddress_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    PublicIPAddress: The reference to the Public IP resource.

    publicIPPrefix
    SubResource_STATUS_ARM

    PublicIPPrefix: The reference to the Public IP Prefix resource.

    subnet
    Subnet_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    Subnet: The reference to the subnet resource.

    FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded

    (Appears on:LoadBalancer_Spec)

    Frontend IP address of the load balancer.

    Field Description
    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_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:LoadBalancerPropertiesFormat_ARM)

    Frontend IP address of the load balancer.

    Field Description
    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.

    properties
    FrontendIPConfigurationPropertiesFormat_ARM

    Properties: Properties of the load balancer probe.

    zones
    []string

    Zones: A list of availability zones denoting the IP allocated for the resource needs to come from.

    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.

    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_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:LoadBalancerPropertiesFormat_STATUS_ARM)

    Frontend IP address of the load balancer.

    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 the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.

    properties
    FrontendIPConfigurationPropertiesFormat_STATUS_ARM

    Properties: Properties of the load balancer probe.

    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.

    IPAllocationMethod (string alias)

    (Appears on:FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded, PublicIPAddress_Spec, VirtualNetworkGatewayIPConfiguration)

    IP address allocation method.

    Value Description

    "Dynamic"

    "Static"

    IPAllocationMethod_ARM (string alias)

    (Appears on:FrontendIPConfigurationPropertiesFormat_ARM, NetworkInterfaceIPConfigurationPropertiesFormat_ARM, PublicIPAddressPropertiesFormat_ARM, VirtualNetworkGatewayIPConfigurationPropertiesFormat_ARM)

    IP address allocation method.

    Value Description

    "Dynamic"

    "Static"

    IPAllocationMethod_STATUS (string alias)

    (Appears on:FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded, VirtualNetworkGatewayIPConfiguration_STATUS)

    IP address allocation method.

    Value Description

    "Dynamic"

    "Static"

    IPAllocationMethod_STATUS_ARM (string alias)

    (Appears on:FrontendIPConfigurationPropertiesFormat_STATUS_ARM, NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM, PublicIPAddressPropertiesFormat_STATUS_ARM, VirtualNetworkGatewayIPConfigurationPropertiesFormat_STATUS_ARM)

    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_ARM

    (Appears on:BgpSettings_ARM)

    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.

    IPConfigurationBgpPeeringAddress_STATUS_ARM

    (Appears on:BgpSettings_STATUS_ARM)

    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:VirtualNetworks_Subnet_STATUS)

    IP configuration profile child resource.

    Field Description
    id
    string

    Id: Resource ID.

    IPConfigurationProfile_STATUS_ARM

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    IP configuration profile child resource.

    Field Description
    id
    string

    Id: Resource ID.

    IPConfiguration_STATUS_PublicIPAddress_SubResourceEmbedded

    (Appears on:PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded)

    IP configuration.

    Field Description
    id
    string

    Id: Resource ID.

    IPConfiguration_STATUS_PublicIPAddress_SubResourceEmbedded_ARM

    (Appears on:PublicIPAddressPropertiesFormat_STATUS_ARM)

    IP configuration.

    Field Description
    id
    string

    Id: Resource ID.

    IPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded

    (Appears on:VirtualNetworks_Subnet_STATUS)

    IP configuration.

    Field Description
    id
    string

    Id: Resource ID.

    IPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    IP configuration.

    Field Description
    id
    string

    Id: Resource ID.

    IPVersion (string alias)

    (Appears on:FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded, PublicIPAddress_Spec)

    IP address version.

    Value Description

    "IPv4"

    "IPv6"

    IPVersion_ARM (string alias)

    (Appears on:FrontendIPConfigurationPropertiesFormat_ARM, NetworkInterfaceIPConfigurationPropertiesFormat_ARM, PublicIPAddressPropertiesFormat_ARM)

    IP address version.

    Value Description

    "IPv4"

    "IPv6"

    IPVersion_STATUS (string alias)

    (Appears on:FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded)

    IP address version.

    Value Description

    "IPv4"

    "IPv6"

    IPVersion_STATUS_ARM (string alias)

    (Appears on:FrontendIPConfigurationPropertiesFormat_STATUS_ARM, NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM, PublicIPAddressPropertiesFormat_STATUS_ARM)

    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_ARM (string alias)

    (Appears on:IpsecPolicy_ARM)

    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"

    IkeEncryption_STATUS_ARM (string alias)

    (Appears on:IpsecPolicy_STATUS_ARM)

    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_ARM (string alias)

    (Appears on:IpsecPolicy_ARM)

    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"

    IkeIntegrity_STATUS_ARM (string alias)

    (Appears on:IpsecPolicy_STATUS_ARM)

    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.

    InboundNatPoolPropertiesFormat_ARM

    (Appears on:InboundNatPool_ARM)

    Properties of Inbound NAT pool.

    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_ARM

    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.

    protocol
    TransportProtocol_ARM

    Protocol: The reference to the transport protocol used by the inbound NAT pool.

    InboundNatPoolPropertiesFormat_STATUS_ARM

    (Appears on:InboundNatPool_STATUS_ARM)

    Properties of Inbound NAT pool.

    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_STATUS_ARM

    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.

    protocol
    TransportProtocol_STATUS_ARM

    Protocol: The reference to the transport protocol used by the inbound NAT pool.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the inbound NAT pool resource.

    InboundNatPool_ARM

    (Appears on:LoadBalancerPropertiesFormat_ARM)

    Inbound NAT pool of the load balancer.

    Field Description
    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.

    properties
    InboundNatPoolPropertiesFormat_ARM

    Properties: Properties of load balancer 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.

    InboundNatPool_STATUS_ARM

    (Appears on:LoadBalancerPropertiesFormat_STATUS_ARM)

    Inbound NAT pool of the load balancer.

    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 the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.

    properties
    InboundNatPoolPropertiesFormat_STATUS_ARM

    Properties: Properties of load balancer inbound nat pool.

    type
    string

    Type: Type of the resource.

    InboundNatRulePropertiesFormat_ARM

    (Appears on:InboundNatRule_LoadBalancer_SubResourceEmbedded_ARM, LoadBalancers_InboundNatRule_Spec_ARM)

    Properties of the inbound NAT rule.

    Field Description
    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_ARM

    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.

    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.

    protocol
    TransportProtocol_ARM

    Protocol: The reference to the transport protocol used by the load balancing rule.

    InboundNatRulePropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded_ARM)

    Properties of the inbound NAT rule.

    Field Description
    backendIPConfiguration
    NetworkInterfaceIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    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.

    frontendIPConfiguration
    SubResource_STATUS_ARM

    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.

    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.

    protocol
    TransportProtocol_STATUS_ARM

    Protocol: The reference to the transport protocol used by the load balancing rule.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the inbound NAT rule resource.

    InboundNatRulePropertiesFormat_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded_ARM

    (Appears on:LoadBalancers_InboundNatRule_STATUS_ARM)

    Properties of the inbound NAT rule.

    Field Description
    backendIPConfiguration
    NetworkInterfaceIPConfiguration_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded_ARM

    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.

    frontendIPConfiguration
    SubResource_STATUS_ARM

    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.

    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.

    protocol
    TransportProtocol_STATUS_ARM

    Protocol: The reference to the transport protocol used by the load balancing rule.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the inbound NAT rule resource.

    InboundNatRule_LoadBalancer_SubResourceEmbedded

    (Appears on:LoadBalancer_Spec)

    Inbound NAT rule of the load balancer.

    Field Description
    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.

    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_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:LoadBalancerPropertiesFormat_ARM)

    Inbound NAT rule of the load balancer.

    Field Description
    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.

    properties
    InboundNatRulePropertiesFormat_ARM

    Properties: Properties of load balancer inbound nat 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_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_ARM)

    Inbound NAT rule of the load balancer.

    Field Description
    id
    string

    InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded

    (Appears on:LoadBalancer_STATUS)

    Inbound NAT rule of the load balancer.

    Field Description
    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.

    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_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:LoadBalancerPropertiesFormat_STATUS_ARM)

    Inbound NAT rule of the load balancer.

    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 the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.

    properties
    InboundNatRulePropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    Properties: Properties of load balancer inbound nat rule.

    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.

    InboundNatRule_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM)

    Inbound NAT rule of the load balancer.

    Field Description
    id
    string

    Id: Resource ID.

    IpTag

    (Appears on:PublicIPAddress_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_ARM

    (Appears on:PublicIPAddressPropertiesFormat_ARM)

    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_PublicIPAddress_SubResourceEmbedded)

    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_ARM

    (Appears on:PublicIPAddressPropertiesFormat_STATUS_ARM)

    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_ARM (string alias)

    (Appears on:IpsecPolicy_ARM)

    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"

    IpsecEncryption_STATUS_ARM (string alias)

    (Appears on:IpsecPolicy_STATUS_ARM)

    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_ARM (string alias)

    (Appears on:IpsecPolicy_ARM)

    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"

    IpsecIntegrity_STATUS_ARM (string alias)

    (Appears on:IpsecPolicy_STATUS_ARM)

    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_ARM

    (Appears on:VpnClientConfiguration_ARM)

    An IPSec Policy configuration for a virtual network gateway connection.

    Field Description
    dhGroup
    DhGroup_ARM

    DhGroup: The DH Group used in IKE Phase 1 for initial SA.

    ikeEncryption
    IkeEncryption_ARM

    IkeEncryption: The IKE encryption algorithm (IKE phase 2).

    ikeIntegrity
    IkeIntegrity_ARM

    IkeIntegrity: The IKE integrity algorithm (IKE phase 2).

    ipsecEncryption
    IpsecEncryption_ARM

    IpsecEncryption: The IPSec encryption algorithm (IKE phase 1).

    ipsecIntegrity
    IpsecIntegrity_ARM

    IpsecIntegrity: The IPSec integrity algorithm (IKE phase 1).

    pfsGroup
    PfsGroup_ARM

    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.

    IpsecPolicy_STATUS_ARM

    (Appears on:VpnClientConfiguration_STATUS_ARM)

    An IPSec Policy configuration for a virtual network gateway connection.

    Field Description
    dhGroup
    DhGroup_STATUS_ARM

    DhGroup: The DH Group used in IKE Phase 1 for initial SA.

    ikeEncryption
    IkeEncryption_STATUS_ARM

    IkeEncryption: The IKE encryption algorithm (IKE phase 2).

    ikeIntegrity
    IkeIntegrity_STATUS_ARM

    IkeIntegrity: The IKE integrity algorithm (IKE phase 2).

    ipsecEncryption
    IpsecEncryption_STATUS_ARM

    IpsecEncryption: The IPSec encryption algorithm (IKE phase 1).

    ipsecIntegrity
    IpsecIntegrity_STATUS_ARM

    IpsecIntegrity: The IPSec integrity algorithm (IKE phase 1).

    pfsGroup
    PfsGroup_STATUS_ARM

    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/2020-11-01/loadBalancer.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​loadBalancers/​{loadBalancerName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    LoadBalancer_Spec


    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.

    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.

    status
    LoadBalancer_STATUS

    LoadBalancerBackendAddress

    (Appears on:BackendAddressPool_LoadBalancer_SubResourceEmbedded)

    Load balancer backend addresses.

    Field Description
    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_ARM

    (Appears on:LoadBalancerBackendAddress_ARM)

    Properties of the load balancer backend addresses.

    Field Description
    ipAddress
    string

    IpAddress: IP Address belonging to the referenced virtual network.

    loadBalancerFrontendIPConfiguration
    SubResource_ARM

    LoadBalancerFrontendIPConfiguration: Reference to the frontend ip address configuration defined in regional loadbalancer.

    subnet
    SubResource_ARM

    Subnet: Reference to an existing subnet.

    virtualNetwork
    SubResource_ARM

    VirtualNetwork: Reference to an existing virtual network.

    LoadBalancerBackendAddressPropertiesFormat_STATUS_ARM

    (Appears on:LoadBalancerBackendAddress_STATUS_ARM)

    Properties of the load balancer backend addresses.

    Field Description
    ipAddress
    string

    IpAddress: IP Address belonging to the referenced virtual network.

    loadBalancerFrontendIPConfiguration
    SubResource_STATUS_ARM

    LoadBalancerFrontendIPConfiguration: Reference to the frontend ip address configuration defined in regional loadbalancer.

    networkInterfaceIPConfiguration
    SubResource_STATUS_ARM

    NetworkInterfaceIPConfiguration: Reference to IP address defined in network interfaces.

    subnet
    SubResource_STATUS_ARM

    Subnet: Reference to an existing subnet.

    virtualNetwork
    SubResource_STATUS_ARM

    VirtualNetwork: Reference to an existing virtual network.

    LoadBalancerBackendAddress_ARM

    (Appears on:BackendAddressPoolPropertiesFormat_ARM)

    Load balancer backend addresses.

    Field Description
    name
    string

    Name: Name of the backend address.

    properties
    LoadBalancerBackendAddressPropertiesFormat_ARM

    Properties: Properties of load balancer backend address pool.

    LoadBalancerBackendAddress_STATUS

    (Appears on:BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded)

    Load balancer backend addresses.

    Field Description
    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.

    LoadBalancerBackendAddress_STATUS_ARM

    (Appears on:BackendAddressPoolPropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM)

    Load balancer backend addresses.

    Field Description
    name
    string

    Name: Name of the backend address.

    properties
    LoadBalancerBackendAddressPropertiesFormat_STATUS_ARM

    Properties: Properties of load balancer backend address pool.

    LoadBalancerPropertiesFormat_ARM

    (Appears on:LoadBalancer_Spec_ARM)

    Properties of the load balancer.

    Field Description
    backendAddressPools
    []BackendAddressPool_LoadBalancer_SubResourceEmbedded_ARM

    BackendAddressPools: Collection of backend address pools used by a load balancer.

    frontendIPConfigurations
    []FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded_ARM

    FrontendIPConfigurations: Object representing the frontend IPs to be used for the load balancer.

    inboundNatPools
    []InboundNatPool_ARM

    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_ARM

    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_ARM

    LoadBalancingRules: Object collection representing the load balancing rules Gets the provisioning.

    outboundRules
    []OutboundRule_ARM

    OutboundRules: The outbound rules.

    probes
    []Probe_ARM

    Probes: Collection of probe objects used in the load balancer.

    LoadBalancerPropertiesFormat_STATUS_ARM

    (Appears on:LoadBalancer_STATUS_ARM)

    Properties of the load balancer.

    Field Description
    backendAddressPools
    []BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    BackendAddressPools: Collection of backend address pools used by a load balancer.

    frontendIPConfigurations
    []FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    FrontendIPConfigurations: Object representing the frontend IPs to be used for the load balancer.

    inboundNatPools
    []InboundNatPool_STATUS_ARM

    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_ARM

    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_ARM

    LoadBalancingRules: Object collection representing the load balancing rules Gets the provisioning.

    outboundRules
    []OutboundRule_STATUS_ARM

    OutboundRules: The outbound rules.

    probes
    []Probe_STATUS_ARM

    Probes: Collection of probe objects used in the load balancer.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the load balancer resource.

    resourceGuid
    string

    ResourceGuid: The resource GUID property of the load balancer resource.

    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_ARM

    (Appears on:LoadBalancer_Spec_ARM)

    SKU of a load balancer.

    Field Description
    name
    LoadBalancerSku_Name_ARM

    Name: Name of a load balancer SKU.

    tier
    LoadBalancerSku_Tier_ARM

    Tier: Tier of a load balancer SKU.

    LoadBalancerSku_Name (string alias)

    (Appears on:LoadBalancerSku)

    Value Description

    "Basic"

    "Standard"

    LoadBalancerSku_Name_ARM (string alias)

    (Appears on:LoadBalancerSku_ARM)

    Value Description

    "Basic"

    "Standard"

    LoadBalancerSku_Name_STATUS (string alias)

    (Appears on:LoadBalancerSku_STATUS)

    Value Description

    "Basic"

    "Standard"

    LoadBalancerSku_Name_STATUS_ARM (string alias)

    (Appears on:LoadBalancerSku_STATUS_ARM)

    Value Description

    "Basic"

    "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_STATUS_ARM

    (Appears on:LoadBalancer_STATUS_ARM)

    SKU of a load balancer.

    Field Description
    name
    LoadBalancerSku_Name_STATUS_ARM

    Name: Name of a load balancer SKU.

    tier
    LoadBalancerSku_Tier_STATUS_ARM

    Tier: Tier of a load balancer SKU.

    LoadBalancerSku_Tier (string alias)

    (Appears on:LoadBalancerSku)

    Value Description

    "Global"

    "Regional"

    LoadBalancerSku_Tier_ARM (string alias)

    (Appears on:LoadBalancerSku_ARM)

    Value Description

    "Global"

    "Regional"

    LoadBalancerSku_Tier_STATUS (string alias)

    (Appears on:LoadBalancerSku_STATUS)

    Value Description

    "Global"

    "Regional"

    LoadBalancerSku_Tier_STATUS_ARM (string alias)

    (Appears on:LoadBalancerSku_STATUS_ARM)

    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_STATUS_ARM

    LoadBalancer resource.

    Field Description
    etag
    string

    Etag: A unique read-only string that changes whenever the resource is updated.

    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of the load balancer.

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    LoadBalancerPropertiesFormat_STATUS_ARM

    Properties: Properties of load balancer.

    sku
    LoadBalancerSku_STATUS_ARM

    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.

    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.

    LoadBalancer_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of the load balancer.

    location
    string

    Location: Resource location.

    name
    string
    properties
    LoadBalancerPropertiesFormat_ARM

    Properties: Properties of load balancer.

    sku
    LoadBalancerSku_ARM

    Sku: The load balancer SKU.

    tags
    map[string]string

    Tags: Resource tags.

    LoadBalancersInboundNatRule

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    LoadBalancers_InboundNatRule_Spec


    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.

    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.

    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.

    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.

    status
    LoadBalancers_InboundNatRule_STATUS

    LoadBalancers_InboundNatRule_STATUS

    (Appears on:LoadBalancersInboundNatRule)

    Field Description
    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.

    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.

    LoadBalancers_InboundNatRule_STATUS_ARM

    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 the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.

    properties
    InboundNatRulePropertiesFormat_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded_ARM

    Properties: Properties of load balancer inbound nat rule.

    type
    string

    Type: Type of the resource.

    LoadBalancers_InboundNatRule_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.

    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.

    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.

    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.

    LoadBalancers_InboundNatRule_Spec_ARM

    Field Description
    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.

    properties
    InboundNatRulePropertiesFormat_ARM

    Properties: Properties of load balancer inbound nat 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.

    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_ARM

    (Appears on:LoadBalancingRule_ARM)

    Properties of the load balancer.

    Field Description
    backendAddressPool
    SubResource_ARM

    BackendAddressPool: A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.

    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_ARM

    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_ARM

    LoadDistribution: The load distribution policy for this rule.

    probe
    SubResource_ARM

    Probe: The reference to the load balancer probe used by the load balancing rule.

    protocol
    TransportProtocol_ARM

    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_ARM (string alias)

    (Appears on:LoadBalancingRulePropertiesFormat_ARM)

    Value Description

    "Default"

    "SourceIP"

    "SourceIPProtocol"

    LoadBalancingRulePropertiesFormat_LoadDistribution_STATUS (string alias)

    (Appears on:LoadBalancingRule_STATUS)

    Value Description

    "Default"

    "SourceIP"

    "SourceIPProtocol"

    LoadBalancingRulePropertiesFormat_LoadDistribution_STATUS_ARM (string alias)

    (Appears on:LoadBalancingRulePropertiesFormat_STATUS_ARM)

    Value Description

    "Default"

    "SourceIP"

    "SourceIPProtocol"

    LoadBalancingRulePropertiesFormat_STATUS_ARM

    (Appears on:LoadBalancingRule_STATUS_ARM)

    Properties of the load balancer.

    Field Description
    backendAddressPool
    SubResource_STATUS_ARM

    BackendAddressPool: A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.

    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_STATUS_ARM

    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_STATUS_ARM

    LoadDistribution: The load distribution policy for this rule.

    probe
    SubResource_STATUS_ARM

    Probe: The reference to the load balancer probe used by the load balancing rule.

    protocol
    TransportProtocol_STATUS_ARM

    Protocol: The reference to the transport protocol used by the load balancing rule.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the load balancing rule resource.

    LoadBalancingRule_ARM

    (Appears on:LoadBalancerPropertiesFormat_ARM)

    A load balancing rule for a load balancer.

    Field Description
    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.

    properties
    LoadBalancingRulePropertiesFormat_ARM

    Properties: Properties of load balancer load balancing rule.

    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.

    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.

    LoadBalancingRule_STATUS_ARM

    (Appears on:LoadBalancerPropertiesFormat_STATUS_ARM)

    A load balancing rule for a load balancer.

    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 the set of load balancing rules used by the load balancer. This name can be used to access the resource.

    properties
    LoadBalancingRulePropertiesFormat_STATUS_ARM

    Properties: Properties of load balancer load balancing rule.

    type
    string

    Type: Type of the resource.

    NatGatewaySpec_PublicIPAddress_SubResourceEmbedded

    (Appears on:PublicIPAddress_Spec)

    Nat Gateway resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    NatGatewaySpec_PublicIPAddress_SubResourceEmbedded_ARM

    (Appears on:PublicIPAddressPropertiesFormat_ARM)

    Nat Gateway resource.

    Field Description
    id
    string

    NatGateway_STATUS_PublicIPAddress_SubResourceEmbedded

    (Appears on:PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded)

    Nat Gateway resource.

    Field Description
    id
    string

    Id: Resource ID.

    NatGateway_STATUS_PublicIPAddress_SubResourceEmbedded_ARM

    (Appears on:PublicIPAddressPropertiesFormat_STATUS_ARM)

    Nat Gateway resource.

    Field Description
    id
    string

    Id: Resource ID.

    NetworkInterface

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NetworkInterface_Spec


    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.

    dnsSettings
    NetworkInterfaceDnsSettings

    DnsSettings: The DNS settings in network interface.

    enableAcceleratedNetworking
    bool

    EnableAcceleratedNetworking: If the network interface is accelerated networking enabled.

    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.

    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.

    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_ARM

    (Appears on:NetworkInterfacePropertiesFormat_ARM)

    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.

    NetworkInterfaceDnsSettings_STATUS_ARM

    (Appears on:NetworkInterfacePropertiesFormat_STATUS_ARM)

    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.

    NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties_STATUS_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM)

    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.

    NetworkInterfaceIPConfigurationPropertiesFormat_ARM

    (Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded_ARM)

    Properties of IP configuration.

    Field Description
    applicationGatewayBackendAddressPools
    []ApplicationGatewayBackendAddressPool_NetworkInterface_SubResourceEmbedded_ARM

    ApplicationGatewayBackendAddressPools: The reference to ApplicationGatewayBackendAddressPool resource.

    applicationSecurityGroups
    []ApplicationSecurityGroupSpec_NetworkInterface_SubResourceEmbedded_ARM

    ApplicationSecurityGroups: Application security groups in which the IP configuration is included.

    loadBalancerBackendAddressPools
    []BackendAddressPool_NetworkInterface_SubResourceEmbedded_ARM

    LoadBalancerBackendAddressPools: The reference to LoadBalancerBackendAddressPool resource.

    loadBalancerInboundNatRules
    []InboundNatRule_NetworkInterface_SubResourceEmbedded_ARM

    LoadBalancerInboundNatRules: A list of references of LoadBalancerInboundNatRules.

    primary
    bool

    Primary: Whether this is a primary customer address on the network interface.

    privateIPAddress
    string

    PrivateIPAddress: Private IP address of the IP configuration.

    privateIPAddressVersion
    IPVersion_ARM

    PrivateIPAddressVersion: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.

    privateIPAllocationMethod
    IPAllocationMethod_ARM

    PrivateIPAllocationMethod: The private IP address allocation method.

    publicIPAddress
    PublicIPAddressSpec_NetworkInterface_SubResourceEmbedded_ARM

    PublicIPAddress: Public IP address bound to the IP configuration.

    subnet
    Subnet_NetworkInterface_SubResourceEmbedded_ARM

    Subnet: Subnet bound to the IP configuration.

    virtualNetworkTaps
    []VirtualNetworkTapSpec_NetworkInterface_SubResourceEmbedded_ARM

    VirtualNetworkTaps: The reference to Virtual Network Taps.

    NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM

    (Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded_ARM)

    Properties of IP configuration.

    Field Description
    applicationGatewayBackendAddressPools
    []ApplicationGatewayBackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    ApplicationGatewayBackendAddressPools: The reference to ApplicationGatewayBackendAddressPool resource.

    applicationSecurityGroups
    []ApplicationSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    ApplicationSecurityGroups: Application security groups in which the IP configuration is included.

    loadBalancerBackendAddressPools
    []BackendAddressPool_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    LoadBalancerBackendAddressPools: The reference to LoadBalancerBackendAddressPool resource.

    loadBalancerInboundNatRules
    []InboundNatRule_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    LoadBalancerInboundNatRules: A list of references of LoadBalancerInboundNatRules.

    primary
    bool

    Primary: Whether this is a primary customer address on the network interface.

    privateIPAddress
    string

    PrivateIPAddress: Private IP address of the IP configuration.

    privateIPAddressVersion
    IPVersion_STATUS_ARM

    PrivateIPAddressVersion: Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.

    privateIPAllocationMethod
    IPAllocationMethod_STATUS_ARM

    PrivateIPAllocationMethod: The private IP address allocation method.

    privateLinkConnectionProperties
    NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties_STATUS_ARM

    PrivateLinkConnectionProperties: PrivateLinkConnection properties for the network interface.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the network interface IP configuration.

    publicIPAddress
    PublicIPAddress_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    PublicIPAddress: Public IP address bound to the IP configuration.

    subnet
    Subnet_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    Subnet: Subnet bound to the IP configuration.

    virtualNetworkTaps
    []VirtualNetworkTap_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    VirtualNetworkTaps: The reference to Virtual Network Taps.

    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.

    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.

    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_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfacePropertiesFormat_ARM)

    IPConfiguration in a network interface.

    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.

    properties
    NetworkInterfaceIPConfigurationPropertiesFormat_ARM

    Properties: Network interface IP configuration properties.

    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_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:BackendAddressPoolPropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM, InboundNatRulePropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM)

    IPConfiguration in a network interface.

    Field Description
    id
    string

    Id: Resource ID.

    NetworkInterfaceIPConfiguration_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded

    (Appears on:LoadBalancers_InboundNatRule_STATUS)

    IPConfiguration in a network interface.

    Field Description
    id
    string

    Id: Resource ID.

    NetworkInterfaceIPConfiguration_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded_ARM

    (Appears on:InboundNatRulePropertiesFormat_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded_ARM)

    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.

    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.

    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.

    NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfacePropertiesFormat_STATUS_ARM)

    IPConfiguration in a network interface.

    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.

    properties
    NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM

    Properties: Network interface IP configuration properties.

    type
    string

    Type: Resource type.

    NetworkInterfacePropertiesFormat_ARM

    (Appears on:NetworkInterface_Spec_ARM)

    NetworkInterface properties.

    Field Description
    dnsSettings
    NetworkInterfaceDnsSettings_ARM

    DnsSettings: The DNS settings in network interface.

    enableAcceleratedNetworking
    bool

    EnableAcceleratedNetworking: If the network interface is accelerated networking enabled.

    enableIPForwarding
    bool

    EnableIPForwarding: Indicates whether IP forwarding is enabled on this network interface.

    ipConfigurations
    []NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded_ARM

    IpConfigurations: A list of IPConfigurations of the network interface.

    networkSecurityGroup
    NetworkSecurityGroupSpec_NetworkInterface_SubResourceEmbedded_ARM

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    nicType
    NetworkInterfacePropertiesFormat_NicType_ARM

    NicType: Type of Network Interface resource.

    privateLinkService
    PrivateLinkServiceSpec_ARM

    PrivateLinkService: Privatelinkservice of the network interface resource.

    NetworkInterfacePropertiesFormat_MigrationPhase_STATUS (string alias)

    (Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)

    Value Description

    "Abort"

    "Commit"

    "Committed"

    "None"

    "Prepare"

    NetworkInterfacePropertiesFormat_MigrationPhase_STATUS_ARM (string alias)

    (Appears on:NetworkInterfacePropertiesFormat_STATUS_ARM)

    Value Description

    "Abort"

    "Commit"

    "Committed"

    "None"

    "Prepare"

    NetworkInterfacePropertiesFormat_NicType (string alias)

    (Appears on:NetworkInterface_Spec)

    Value Description

    "Elastic"

    "Standard"

    NetworkInterfacePropertiesFormat_NicType_ARM (string alias)

    (Appears on:NetworkInterfacePropertiesFormat_ARM)

    Value Description

    "Elastic"

    "Standard"

    NetworkInterfacePropertiesFormat_NicType_STATUS (string alias)

    (Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)

    Value Description

    "Elastic"

    "Standard"

    NetworkInterfacePropertiesFormat_NicType_STATUS_ARM (string alias)

    (Appears on:NetworkInterfacePropertiesFormat_STATUS_ARM)

    Value Description

    "Elastic"

    "Standard"

    NetworkInterfacePropertiesFormat_STATUS_ARM

    (Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded_ARM)

    NetworkInterface properties.

    Field Description
    dnsSettings
    NetworkInterfaceDnsSettings_STATUS_ARM

    DnsSettings: The DNS settings in network interface.

    dscpConfiguration
    SubResource_STATUS_ARM

    DscpConfiguration: A reference to the dscp configuration to which the network interface is linked.

    enableAcceleratedNetworking
    bool

    EnableAcceleratedNetworking: If the network interface is accelerated networking enabled.

    enableIPForwarding
    bool

    EnableIPForwarding: Indicates whether IP forwarding is enabled on this network interface.

    hostedWorkloads
    []string

    HostedWorkloads: A list of references to linked BareMetal resources.

    ipConfigurations
    []NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    IpConfigurations: A list of IPConfigurations of the network interface.

    macAddress
    string

    MacAddress: The MAC address of the network interface.

    migrationPhase
    NetworkInterfacePropertiesFormat_MigrationPhase_STATUS_ARM

    MigrationPhase: Migration phase of Network Interface resource.

    networkSecurityGroup
    NetworkSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    nicType
    NetworkInterfacePropertiesFormat_NicType_STATUS_ARM

    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_ARM

    PrivateEndpoint: A reference to the private endpoint to which the network interface is linked.

    privateLinkService
    PrivateLinkService_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    PrivateLinkService: Privatelinkservice of the network interface resource.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the network interface resource.

    resourceGuid
    string

    ResourceGuid: The resource GUID property of the network interface resource.

    tapConfigurations
    []NetworkInterfaceTapConfiguration_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    TapConfigurations: A list of TapConfigurations of the network interface.

    virtualMachine
    SubResource_STATUS_ARM

    VirtualMachine: The reference to a virtual machine.

    NetworkInterfaceTapConfiguration_STATUS_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)

    Tap configuration in a Network Interface.

    Field Description
    id
    string

    Id: Resource ID.

    NetworkInterfaceTapConfiguration_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfacePropertiesFormat_STATUS_ARM)

    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
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    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 accelerated networking enabled.

    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.

    NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    A network interface in a resource group.

    Field Description
    etag
    string

    Etag: A unique read-only string that changes whenever the resource is updated.

    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of the network interface.

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    NetworkInterfacePropertiesFormat_STATUS_ARM

    Properties: Properties of the network interface.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    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_NetworkSecurityGroup_SubResourceEmbedded_ARM

    (Appears on:NetworkSecurityGroupPropertiesFormat_STATUS_ARM)

    A network interface in a resource group.

    Field Description
    id
    string

    Id: Resource ID.

    NetworkInterface_Spec

    (Appears on:NetworkInterface)

    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.

    dnsSettings
    NetworkInterfaceDnsSettings

    DnsSettings: The DNS settings in network interface.

    enableAcceleratedNetworking
    bool

    EnableAcceleratedNetworking: If the network interface is accelerated networking enabled.

    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.

    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.

    NetworkInterface_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of the network interface.

    location
    string

    Location: Resource location.

    name
    string
    properties
    NetworkInterfacePropertiesFormat_ARM

    Properties: Properties of the network interface.

    tags
    map[string]string

    Tags: Resource tags.

    NetworkSecurityGroup

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NetworkSecurityGroup_Spec


    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.

    location
    string

    Location: Resource location.

    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.

    status
    NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded

    NetworkSecurityGroupPropertiesFormat_ARM

    (Appears on:NetworkSecurityGroup_Spec_ARM)

    Network Security Group resource.

    Field Description
    securityRules
    []SecurityRule_ARM

    SecurityRules: A collection of security rules of the network security group.

    NetworkSecurityGroupPropertiesFormat_STATUS_ARM

    (Appears on:NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded_ARM)

    Network Security Group resource.

    Field Description
    defaultSecurityRules
    []SecurityRule_STATUS_ARM

    DefaultSecurityRules: The default security rules of network security group.

    flowLogs
    []FlowLog_STATUS_ARM

    FlowLogs: A collection of references to flow log resources.

    networkInterfaces
    []NetworkInterface_STATUS_NetworkSecurityGroup_SubResourceEmbedded_ARM

    NetworkInterfaces: A collection of references to network interfaces.

    provisioningState
    ProvisioningState_STATUS_ARM

    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_ARM

    Subnets: A collection of references to subnets.

    NetworkSecurityGroupSpec_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface_Spec)

    NetworkSecurityGroup resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    NetworkSecurityGroupSpec_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfacePropertiesFormat_ARM)

    NetworkSecurityGroup resource.

    Field Description
    id
    string

    NetworkSecurityGroupSpec_VirtualNetwork_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM)

    NetworkSecurityGroup resource.

    Field Description
    id
    string

    NetworkSecurityGroupSpec_VirtualNetworks_Subnet_SubResourceEmbedded

    (Appears on:VirtualNetworks_Subnet_Spec)

    NetworkSecurityGroup resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    NetworkSecurityGroupSpec_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM)

    NetworkSecurityGroup resource.

    Field Description
    id
    string

    NetworkSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)

    NetworkSecurityGroup resource.

    Field Description
    id
    string

    Id: Resource ID.

    NetworkSecurityGroup_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfacePropertiesFormat_STATUS_ARM)

    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.

    flowLogs
    []FlowLog_STATUS

    FlowLogs: A collection of references to flow log resources.

    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_NetworkSecurityGroup_SubResourceEmbedded_ARM

    NetworkSecurityGroup resource.

    Field Description
    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.

    properties
    NetworkSecurityGroupPropertiesFormat_STATUS_ARM

    Properties: Properties of the network security group.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    NetworkSecurityGroup_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded

    (Appears on:VirtualNetworks_Subnet_STATUS)

    NetworkSecurityGroup resource.

    Field Description
    id
    string

    Id: Resource ID.

    NetworkSecurityGroup_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    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.

    location
    string

    Location: Resource location.

    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.

    NetworkSecurityGroup_Spec_ARM

    Field Description
    location
    string

    Location: Resource location.

    name
    string
    properties
    NetworkSecurityGroupPropertiesFormat_ARM

    Properties: Properties of the network security group.

    tags
    map[string]string

    Tags: Resource tags.

    NetworkSecurityGroupsSecurityRule

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NetworkSecurityGroups_SecurityRule_Spec


    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.

    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.

    status
    NetworkSecurityGroups_SecurityRule_STATUS

    NetworkSecurityGroups_SecurityRule_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.

    NetworkSecurityGroups_SecurityRule_STATUS_ARM

    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.

    properties
    SecurityRulePropertiesFormat_STATUS_ARM

    Properties: Properties of the security rule.

    type
    string

    Type: The type of the resource.

    NetworkSecurityGroups_SecurityRule_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.

    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.

    NetworkSecurityGroups_SecurityRule_Spec_ARM

    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.

    properties
    SecurityRulePropertiesFormat_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded_ARM

    Properties: Properties of the security rule.

    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_ARM

    (Appears on:OutboundRule_ARM)

    Outbound rule of the load balancer.

    Field Description
    allocatedOutboundPorts
    int

    AllocatedOutboundPorts: The number of outbound ports to be used for NAT.

    backendAddressPool
    SubResource_ARM

    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_ARM

    FrontendIPConfigurations: The Frontend IP addresses of the load balancer.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The timeout for the TCP idle connection.

    protocol
    OutboundRulePropertiesFormat_Protocol_ARM

    Protocol: The protocol for the outbound rule in load balancer.

    OutboundRulePropertiesFormat_Protocol (string alias)

    (Appears on:OutboundRule)

    Value Description

    "All"

    "Tcp"

    "Udp"

    OutboundRulePropertiesFormat_Protocol_ARM (string alias)

    (Appears on:OutboundRulePropertiesFormat_ARM)

    Value Description

    "All"

    "Tcp"

    "Udp"

    OutboundRulePropertiesFormat_Protocol_STATUS (string alias)

    (Appears on:OutboundRule_STATUS)

    Value Description

    "All"

    "Tcp"

    "Udp"

    OutboundRulePropertiesFormat_Protocol_STATUS_ARM (string alias)

    (Appears on:OutboundRulePropertiesFormat_STATUS_ARM)

    Value Description

    "All"

    "Tcp"

    "Udp"

    OutboundRulePropertiesFormat_STATUS_ARM

    (Appears on:OutboundRule_STATUS_ARM)

    Outbound rule of the load balancer.

    Field Description
    allocatedOutboundPorts
    int

    AllocatedOutboundPorts: The number of outbound ports to be used for NAT.

    backendAddressPool
    SubResource_STATUS_ARM

    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_STATUS_ARM

    FrontendIPConfigurations: The Frontend IP addresses of the load balancer.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The timeout for the TCP idle connection.

    protocol
    OutboundRulePropertiesFormat_Protocol_STATUS_ARM

    Protocol: The protocol for the outbound rule in load balancer.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the outbound rule resource.

    OutboundRule_ARM

    (Appears on:LoadBalancerPropertiesFormat_ARM)

    Outbound rule of the load balancer.

    Field Description
    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.

    properties
    OutboundRulePropertiesFormat_ARM

    Properties: Properties of load balancer outbound rule.

    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.

    OutboundRule_STATUS_ARM

    (Appears on:LoadBalancerPropertiesFormat_STATUS_ARM)

    Outbound rule of the load balancer.

    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 the set of outbound rules used by the load balancer. This name can be used to access the resource.

    properties
    OutboundRulePropertiesFormat_STATUS_ARM

    Properties: Properties of load balancer outbound rule.

    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_ARM (string alias)

    (Appears on:IpsecPolicy_ARM)

    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"

    PfsGroup_STATUS_ARM (string alias)

    (Appears on:IpsecPolicy_STATUS_ARM)

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

    Value Description

    "ECP256"

    "ECP384"

    "None"

    "PFS1"

    "PFS14"

    "PFS2"

    "PFS2048"

    "PFS24"

    "PFSMM"

    PrivateEndpoint_STATUS_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)

    Private endpoint resource.

    Field Description
    id
    string

    Id: Resource ID.

    PrivateEndpoint_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfacePropertiesFormat_STATUS_ARM)

    Private endpoint resource.

    Field Description
    id
    string

    Id: Resource ID.

    PrivateEndpoint_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded

    (Appears on:VirtualNetworks_Subnet_STATUS)

    Private endpoint resource.

    Field Description
    id
    string

    Id: Resource ID.

    PrivateEndpoint_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    Private endpoint resource.

    Field Description
    id
    string

    Id: Resource ID.

    PrivateLinkServiceSpec

    (Appears on:NetworkInterface_Spec)

    Private link service resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    PrivateLinkServiceSpec_ARM

    (Appears on:NetworkInterfacePropertiesFormat_ARM)

    Private link service resource.

    Field Description
    id
    string

    PrivateLinkService_STATUS_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded)

    Private link service resource.

    Field Description
    id
    string

    Id: Resource ID.

    PrivateLinkService_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfacePropertiesFormat_STATUS_ARM)

    Private link service resource.

    Field Description
    id
    string

    Id: Resource ID.

    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.

    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.

    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_ARM

    (Appears on:Probe_ARM)

    Load balancer probe resource.

    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.

    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.

    protocol
    ProbePropertiesFormat_Protocol_ARM

    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_Protocol (string alias)

    (Appears on:Probe)

    Value Description

    "Http"

    "Https"

    "Tcp"

    ProbePropertiesFormat_Protocol_ARM (string alias)

    (Appears on:ProbePropertiesFormat_ARM)

    Value Description

    "Http"

    "Https"

    "Tcp"

    ProbePropertiesFormat_Protocol_STATUS (string alias)

    (Appears on:Probe_STATUS)

    Value Description

    "Http"

    "Https"

    "Tcp"

    ProbePropertiesFormat_Protocol_STATUS_ARM (string alias)

    (Appears on:ProbePropertiesFormat_STATUS_ARM)

    Value Description

    "Http"

    "Https"

    "Tcp"

    ProbePropertiesFormat_STATUS_ARM

    (Appears on:Probe_STATUS_ARM)

    Load balancer probe resource.

    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.

    loadBalancingRules
    []SubResource_STATUS_ARM

    LoadBalancingRules: The load balancer rules that use this probe.

    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.

    protocol
    ProbePropertiesFormat_Protocol_STATUS_ARM

    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_ARM

    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.

    Probe_ARM

    (Appears on:LoadBalancerPropertiesFormat_ARM)

    A load balancer probe.

    Field Description
    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.

    properties
    ProbePropertiesFormat_ARM

    Properties: Properties of load balancer probe.

    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.

    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.

    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.

    Probe_STATUS_ARM

    (Appears on:LoadBalancerPropertiesFormat_STATUS_ARM)

    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.

    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.

    properties
    ProbePropertiesFormat_STATUS_ARM

    Properties: Properties of load balancer probe.

    type
    string

    Type: Type of the resource.

    ProvisioningState_STATUS (string alias)

    (Appears on:BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, Delegation_STATUS, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, InboundNatPool_STATUS, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, LoadBalancer_STATUS, LoadBalancers_InboundNatRule_STATUS, LoadBalancingRule_STATUS, NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded, NetworkSecurityGroups_SecurityRule_STATUS, OutboundRule_STATUS, Probe_STATUS, PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded, RouteTable_STATUS, RouteTables_Route_STATUS, ServiceEndpointPropertiesFormat_STATUS, VirtualNetworkGatewayIPConfiguration_STATUS, VirtualNetworkGateway_STATUS, VirtualNetwork_STATUS, VirtualNetworks_Subnet_STATUS, VirtualNetworks_VirtualNetworkPeering_STATUS, VpnClientRevokedCertificate_STATUS, VpnClientRootCertificate_STATUS)

    The current provisioning state.

    Value Description

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    ProvisioningState_STATUS_ARM (string alias)

    (Appears on:BackendAddressPoolPropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM, FrontendIPConfigurationPropertiesFormat_STATUS_ARM, InboundNatPoolPropertiesFormat_STATUS_ARM, InboundNatRulePropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM, InboundNatRulePropertiesFormat_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded_ARM, LoadBalancerPropertiesFormat_STATUS_ARM, LoadBalancingRulePropertiesFormat_STATUS_ARM, NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM, NetworkInterfacePropertiesFormat_STATUS_ARM, NetworkSecurityGroupPropertiesFormat_STATUS_ARM, OutboundRulePropertiesFormat_STATUS_ARM, ProbePropertiesFormat_STATUS_ARM, PublicIPAddressPropertiesFormat_STATUS_ARM, RoutePropertiesFormat_STATUS_ARM, RouteTablePropertiesFormat_STATUS_ARM, SecurityRulePropertiesFormat_STATUS_ARM, ServiceDelegationPropertiesFormat_STATUS_ARM, ServiceEndpointPropertiesFormat_STATUS_ARM, SubnetPropertiesFormat_STATUS_ARM, VirtualNetworkGatewayIPConfigurationPropertiesFormat_STATUS_ARM, VirtualNetworkGatewayPropertiesFormat_STATUS_ARM, VirtualNetworkPeeringPropertiesFormat_STATUS_ARM, VirtualNetworkPropertiesFormat_STATUS_ARM, VpnClientRevokedCertificatePropertiesFormat_STATUS_ARM, VpnClientRootCertificatePropertiesFormat_STATUS_ARM)

    The current provisioning state.

    Value Description

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    PublicIPAddress

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    PublicIPAddress_Spec


    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.

    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.

    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.

    status
    PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded

    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.

    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_ARM

    (Appears on:PublicIPAddressPropertiesFormat_ARM)

    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.

    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_STATUS

    (Appears on:PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded)

    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.

    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_STATUS_ARM

    (Appears on:PublicIPAddressPropertiesFormat_STATUS_ARM)

    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.

    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.

    PublicIPAddressPropertiesFormat_ARM

    (Appears on:PublicIPAddress_Spec_ARM)

    Public IP address properties.

    Field Description
    ddosSettings
    DdosSettings_ARM

    DdosSettings: The DDoS protection custom policy associated with the public IP address.

    dnsSettings
    PublicIPAddressDnsSettings_ARM

    DnsSettings: The FQDN of the DNS record associated with 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_ARM

    IpTags: The list of tags associated with the public IP address.

    linkedPublicIPAddress
    PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded_ARM

    LinkedPublicIPAddress: The linked public IP address of the public IP address resource.

    natGateway
    NatGatewaySpec_PublicIPAddress_SubResourceEmbedded_ARM

    NatGateway: The NatGateway for the Public IP address.

    publicIPAddressVersion
    IPVersion_ARM

    PublicIPAddressVersion: The public IP address version.

    publicIPAllocationMethod
    IPAllocationMethod_ARM

    PublicIPAllocationMethod: The public IP address allocation method.

    publicIPPrefix
    SubResource_ARM

    PublicIPPrefix: The Public IP Prefix this Public IP Address should be allocated from.

    servicePublicIPAddress
    PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded_ARM

    ServicePublicIPAddress: The service public IP address of the public IP address resource.

    PublicIPAddressPropertiesFormat_MigrationPhase_STATUS (string alias)

    (Appears on:PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded)

    Value Description

    "Abort"

    "Commit"

    "Committed"

    "None"

    "Prepare"

    PublicIPAddressPropertiesFormat_MigrationPhase_STATUS_ARM (string alias)

    (Appears on:PublicIPAddressPropertiesFormat_STATUS_ARM)

    Value Description

    "Abort"

    "Commit"

    "Committed"

    "None"

    "Prepare"

    PublicIPAddressPropertiesFormat_STATUS_ARM

    (Appears on:PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded_ARM)

    Public IP address properties.

    Field Description
    ddosSettings
    DdosSettings_STATUS_ARM

    DdosSettings: The DDoS protection custom policy associated with the public IP address.

    dnsSettings
    PublicIPAddressDnsSettings_STATUS_ARM

    DnsSettings: The FQDN of the DNS record associated with 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.

    ipConfiguration
    IPConfiguration_STATUS_PublicIPAddress_SubResourceEmbedded_ARM

    IpConfiguration: The IP configuration associated with the public IP address.

    ipTags
    []IpTag_STATUS_ARM

    IpTags: The list of tags associated with the public IP address.

    migrationPhase
    PublicIPAddressPropertiesFormat_MigrationPhase_STATUS_ARM

    MigrationPhase: Migration phase of Public IP Address.

    natGateway
    NatGateway_STATUS_PublicIPAddress_SubResourceEmbedded_ARM

    NatGateway: The NatGateway for the Public IP address.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the public IP address resource.

    publicIPAddressVersion
    IPVersion_STATUS_ARM

    PublicIPAddressVersion: The public IP address version.

    publicIPAllocationMethod
    IPAllocationMethod_STATUS_ARM

    PublicIPAllocationMethod: The public IP address allocation method.

    publicIPPrefix
    SubResource_STATUS_ARM

    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.

    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_ARM

    (Appears on:PublicIPAddress_Spec_ARM)

    SKU of a public IP address.

    Field Description
    name
    PublicIPAddressSku_Name_ARM

    Name: Name of a public IP address SKU.

    tier
    PublicIPAddressSku_Tier_ARM

    Tier: Tier of a public IP address SKU.

    PublicIPAddressSku_Name (string alias)

    (Appears on:PublicIPAddressSku)

    Value Description

    "Basic"

    "Standard"

    PublicIPAddressSku_Name_ARM (string alias)

    (Appears on:PublicIPAddressSku_ARM)

    Value Description

    "Basic"

    "Standard"

    PublicIPAddressSku_Name_STATUS (string alias)

    (Appears on:PublicIPAddressSku_STATUS)

    Value Description

    "Basic"

    "Standard"

    PublicIPAddressSku_Name_STATUS_ARM (string alias)

    (Appears on:PublicIPAddressSku_STATUS_ARM)

    Value Description

    "Basic"

    "Standard"

    PublicIPAddressSku_STATUS

    (Appears on:PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded)

    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_STATUS_ARM

    (Appears on:PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded_ARM)

    SKU of a public IP address.

    Field Description
    name
    PublicIPAddressSku_Name_STATUS_ARM

    Name: Name of a public IP address SKU.

    tier
    PublicIPAddressSku_Tier_STATUS_ARM

    Tier: Tier of a public IP address SKU.

    PublicIPAddressSku_Tier (string alias)

    (Appears on:PublicIPAddressSku)

    Value Description

    "Global"

    "Regional"

    PublicIPAddressSku_Tier_ARM (string alias)

    (Appears on:PublicIPAddressSku_ARM)

    Value Description

    "Global"

    "Regional"

    PublicIPAddressSku_Tier_STATUS (string alias)

    (Appears on:PublicIPAddressSku_STATUS)

    Value Description

    "Global"

    "Regional"

    PublicIPAddressSku_Tier_STATUS_ARM (string alias)

    (Appears on:PublicIPAddressSku_STATUS_ARM)

    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_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:FrontendIPConfigurationPropertiesFormat_ARM)

    Public IP address resource.

    Field Description
    id
    string

    PublicIPAddressSpec_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)

    Public IP address resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    PublicIPAddressSpec_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_ARM)

    Public IP address resource.

    Field Description
    id
    string

    PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded

    (Appears on:PublicIPAddress_Spec)

    Public IP address resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    PublicIPAddressSpec_PublicIPAddress_SubResourceEmbedded_ARM

    (Appears on:PublicIPAddressPropertiesFormat_ARM)

    Public IP address resource.

    Field Description
    id
    string

    PublicIPAddress_STATUS_LoadBalancer_SubResourceEmbedded

    (Appears on:FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded)

    Public IP address resource.

    Field Description
    id
    string

    Id: Resource ID.

    PublicIPAddress_STATUS_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:FrontendIPConfigurationPropertiesFormat_STATUS_ARM)

    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_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM)

    Public IP address resource.

    Field Description
    id
    string

    Id: Resource ID.

    PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded

    (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.

    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_PublicIPAddress_SubResourceEmbedded_ARM

    Public IP address resource.

    Field Description
    etag
    string

    Etag: A unique read-only string that changes whenever the resource is updated.

    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of the public ip address.

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    PublicIPAddressPropertiesFormat_STATUS_ARM

    Properties: Public IP address properties.

    sku
    PublicIPAddressSku_STATUS_ARM

    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_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.

    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.

    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.

    PublicIPAddress_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of the public ip address.

    location
    string

    Location: Resource location.

    name
    string
    properties
    PublicIPAddressPropertiesFormat_ARM

    Properties: Public IP address properties.

    sku
    PublicIPAddressSku_ARM

    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.

    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_ARM

    (Appears on:VpnClientConfiguration_ARM)

    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.

    RadiusServer_STATUS_ARM

    (Appears on:VpnClientConfiguration_STATUS_ARM)

    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.

    (Appears on:VirtualNetworks_Subnet_STATUS)

    ResourceNavigationLink resource.

    Field Description
    id
    string

    Id: Resource navigation link identifier.

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    ResourceNavigationLink resource.

    Field Description
    id
    string

    Id: Resource navigation link identifier.

    RouteNextHopType (string alias)

    (Appears on:RouteTables_Route_Spec)

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

    Value Description

    "Internet"

    "None"

    "VirtualAppliance"

    "VirtualNetworkGateway"

    "VnetLocal"

    RouteNextHopType_ARM (string alias)

    (Appears on:RoutePropertiesFormat_ARM)

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

    Value Description

    "Internet"

    "None"

    "VirtualAppliance"

    "VirtualNetworkGateway"

    "VnetLocal"

    RouteNextHopType_STATUS (string alias)

    (Appears on:RouteTables_Route_STATUS)

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

    Value Description

    "Internet"

    "None"

    "VirtualAppliance"

    "VirtualNetworkGateway"

    "VnetLocal"

    RouteNextHopType_STATUS_ARM (string alias)

    (Appears on:RoutePropertiesFormat_STATUS_ARM)

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

    Value Description

    "Internet"

    "None"

    "VirtualAppliance"

    "VirtualNetworkGateway"

    "VnetLocal"

    RoutePropertiesFormat_ARM

    (Appears on:RouteTables_Route_Spec_ARM, Route_ARM)

    Route resource.

    Field Description
    addressPrefix
    string

    AddressPrefix: The destination CIDR to which the route applies.

    hasBgpOverride
    bool

    HasBgpOverride: A value indicating whether this route overrides overlapping BGP routes regardless of LPM.

    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_ARM

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

    RoutePropertiesFormat_STATUS_ARM

    (Appears on:RouteTables_Route_STATUS_ARM)

    Route resource.

    Field Description
    addressPrefix
    string

    AddressPrefix: The destination CIDR to which the route applies.

    hasBgpOverride
    bool

    HasBgpOverride: A value indicating whether this route overrides overlapping BGP routes regardless of LPM.

    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_ARM

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

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the route resource.

    RouteTable

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    RouteTable_Spec


    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.

    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.

    status
    RouteTable_STATUS

    RouteTablePropertiesFormat_ARM

    (Appears on:RouteTable_Spec_ARM)

    Route Table resource.

    Field Description
    disableBgpRoutePropagation
    bool

    DisableBgpRoutePropagation: Whether to disable the routes learned by BGP on that route table. True means disable.

    routes
    []Route_ARM

    Routes: Collection of routes contained within a route table.

    RouteTablePropertiesFormat_STATUS_ARM

    (Appears on:RouteTable_STATUS_ARM)

    Route Table resource.

    Field Description
    disableBgpRoutePropagation
    bool

    DisableBgpRoutePropagation: Whether to disable the routes learned by BGP on that route table. True means disable.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the route table resource.

    resourceGuid
    string

    ResourceGuid: The resource GUID property of the route table.

    RouteTableSpec_VirtualNetwork_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM)

    Route table resource.

    Field Description
    id
    string

    RouteTableSpec_VirtualNetworks_Subnet_SubResourceEmbedded

    (Appears on:VirtualNetworks_Subnet_Spec)

    Route table resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    RouteTableSpec_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM)

    Route table resource.

    Field Description
    id
    string

    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_ARM

    Route table resource.

    Field Description
    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.

    properties
    RouteTablePropertiesFormat_STATUS_ARM

    Properties: Properties of the route table.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    RouteTable_STATUS_SubResourceEmbedded

    (Appears on:VirtualNetworks_Subnet_STATUS)

    Route table resource.

    Field Description
    id
    string

    Id: Resource ID.

    RouteTable_STATUS_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    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.

    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.

    RouteTable_Spec_ARM

    Field Description
    location
    string

    Location: Resource location.

    name
    string
    properties
    RouteTablePropertiesFormat_ARM

    Properties: Properties of the route table.

    tags
    map[string]string

    Tags: Resource tags.

    RouteTablesRoute

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    RouteTables_Route_Spec


    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.

    hasBgpOverride
    bool

    HasBgpOverride: A value indicating whether this route overrides overlapping BGP routes regardless of LPM.

    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.

    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

    status
    RouteTables_Route_STATUS

    RouteTables_Route_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.

    RouteTables_Route_STATUS_ARM

    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.

    properties
    RoutePropertiesFormat_STATUS_ARM

    Properties: Properties of the route.

    type
    string

    Type: The type of the resource.

    RouteTables_Route_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.

    hasBgpOverride
    bool

    HasBgpOverride: A value indicating whether this route overrides overlapping BGP routes regardless of LPM.

    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.

    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

    RouteTables_Route_Spec_ARM

    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.

    properties
    RoutePropertiesFormat_ARM

    Properties: Properties of the route.

    Route_ARM

    (Appears on:RouteTablePropertiesFormat_ARM)

    Route resource.

    Field Description
    id
    string
    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
    RoutePropertiesFormat_ARM

    Properties: Properties of the route.

    type
    string

    Type: The type of the resource.

    SecurityRuleAccess (string alias)

    (Appears on:NetworkSecurityGroups_SecurityRule_Spec)

    Whether network traffic is allowed or denied.

    Value Description

    "Allow"

    "Deny"

    SecurityRuleAccess_ARM (string alias)

    (Appears on:SecurityRulePropertiesFormat_NetworkSecurityGroup_SubResourceEmbedded_ARM, SecurityRulePropertiesFormat_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded_ARM)

    Whether network traffic is allowed or denied.

    Value Description

    "Allow"

    "Deny"

    SecurityRuleAccess_STATUS (string alias)

    (Appears on:NetworkSecurityGroups_SecurityRule_STATUS)

    Whether network traffic is allowed or denied.

    Value Description

    "Allow"

    "Deny"

    SecurityRuleAccess_STATUS_ARM (string alias)

    (Appears on:SecurityRulePropertiesFormat_STATUS_ARM)

    Whether network traffic is allowed or denied.

    Value Description

    "Allow"

    "Deny"

    SecurityRuleDirection (string alias)

    (Appears on:NetworkSecurityGroups_SecurityRule_Spec)

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

    Value Description

    "Inbound"

    "Outbound"

    SecurityRuleDirection_ARM (string alias)

    (Appears on:SecurityRulePropertiesFormat_NetworkSecurityGroup_SubResourceEmbedded_ARM, SecurityRulePropertiesFormat_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded_ARM)

    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:NetworkSecurityGroups_SecurityRule_STATUS)

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

    Value Description

    "Inbound"

    "Outbound"

    SecurityRuleDirection_STATUS_ARM (string alias)

    (Appears on:SecurityRulePropertiesFormat_STATUS_ARM)

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

    Value Description

    "Inbound"

    "Outbound"

    SecurityRulePropertiesFormat_NetworkSecurityGroup_SubResourceEmbedded_ARM

    (Appears on:SecurityRule_ARM)

    Security rule resource.

    Field Description
    access
    SecurityRuleAccess_ARM

    Access: The network traffic is allowed or denied.

    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_NetworkSecurityGroup_SubResourceEmbedded_ARM

    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_ARM

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

    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_ARM

    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_NetworkSecurityGroup_SubResourceEmbedded_ARM

    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.

    SecurityRulePropertiesFormat_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded_ARM

    (Appears on:NetworkSecurityGroups_SecurityRule_Spec_ARM)

    Security rule resource.

    Field Description
    access
    SecurityRuleAccess_ARM

    Access: The network traffic is allowed or denied.

    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_ARM

    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_ARM

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

    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_ARM

    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_ARM

    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.

    SecurityRulePropertiesFormat_Protocol (string alias)

    (Appears on:NetworkSecurityGroups_SecurityRule_Spec)

    Value Description

    "Ah"

    "Esp"

    "Icmp"

    "*"

    "Tcp"

    "Udp"

    SecurityRulePropertiesFormat_Protocol_ARM (string alias)

    (Appears on:SecurityRulePropertiesFormat_NetworkSecurityGroup_SubResourceEmbedded_ARM, SecurityRulePropertiesFormat_NetworkSecurityGroups_SecurityRule_SubResourceEmbedded_ARM)

    Value Description

    "Ah"

    "Esp"

    "Icmp"

    "*"

    "Tcp"

    "Udp"

    SecurityRulePropertiesFormat_Protocol_STATUS (string alias)

    (Appears on:NetworkSecurityGroups_SecurityRule_STATUS)

    Value Description

    "Ah"

    "Esp"

    "Icmp"

    "*"

    "Tcp"

    "Udp"

    SecurityRulePropertiesFormat_Protocol_STATUS_ARM (string alias)

    (Appears on:SecurityRulePropertiesFormat_STATUS_ARM)

    Value Description

    "Ah"

    "Esp"

    "Icmp"

    "*"

    "Tcp"

    "Udp"

    SecurityRulePropertiesFormat_STATUS_ARM

    (Appears on:NetworkSecurityGroups_SecurityRule_STATUS_ARM)

    Security rule resource.

    Field Description
    access
    SecurityRuleAccess_STATUS_ARM

    Access: The network traffic is allowed or denied.

    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_ARM

    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_ARM

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

    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_ARM

    Protocol: Network protocol this rule applies to.

    provisioningState
    ProvisioningState_STATUS_ARM

    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_ARM

    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.

    SecurityRule_ARM

    (Appears on:NetworkSecurityGroupPropertiesFormat_ARM)

    Network security rule.

    Field Description
    id
    string
    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
    SecurityRulePropertiesFormat_NetworkSecurityGroup_SubResourceEmbedded_ARM

    Properties: Properties of the security rule.

    type
    string

    Type: The type of the resource.

    SecurityRule_STATUS

    (Appears on:NetworkSecurityGroup_STATUS_NetworkSecurityGroup_SubResourceEmbedded)

    Network security rule.

    Field Description
    id
    string

    Id: Resource ID.

    SecurityRule_STATUS_ARM

    (Appears on:NetworkSecurityGroupPropertiesFormat_STATUS_ARM)

    Network security rule.

    Field Description
    id
    string

    Id: Resource ID.

    (Appears on:VirtualNetworks_Subnet_STATUS)

    ServiceAssociationLink resource.

    Field Description
    id
    string

    Id: Resource ID.

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    ServiceAssociationLink resource.

    Field Description
    id
    string

    Id: Resource ID.

    ServiceDelegationPropertiesFormat_ARM

    (Appears on:Delegation_ARM)

    Properties of a service delegation.

    Field Description
    serviceName
    string

    ServiceName: The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).

    ServiceDelegationPropertiesFormat_STATUS_ARM

    (Appears on:Delegation_STATUS_ARM)

    Properties of a service delegation.

    Field Description
    actions
    []string

    Actions: The actions permitted to the service upon delegation.

    provisioningState
    ProvisioningState_STATUS_ARM

    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).

    ServiceEndpointPolicySpec_VirtualNetwork_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM)

    Service End point policy resource.

    Field Description
    id
    string

    ServiceEndpointPolicySpec_VirtualNetworks_Subnet_SubResourceEmbedded

    (Appears on:VirtualNetworks_Subnet_Spec)

    Service End point policy resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    ServiceEndpointPolicySpec_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM)

    Service End point policy resource.

    Field Description
    id
    string

    ServiceEndpointPolicy_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded

    (Appears on:VirtualNetworks_Subnet_STATUS)

    Service End point policy resource.

    Field Description
    id
    string

    Id: Resource ID.

    ServiceEndpointPolicy_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    Service End point policy resource.

    Field Description
    id
    string

    Id: Resource ID.

    ServiceEndpointPropertiesFormat

    (Appears on:VirtualNetworks_Subnet_Spec)

    The service endpoint properties.

    Field Description
    locations
    []string

    Locations: A list of locations.

    service
    string

    Service: The type of the endpoint service.

    ServiceEndpointPropertiesFormat_ARM

    (Appears on:SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM, SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM)

    The service endpoint properties.

    Field Description
    locations
    []string

    Locations: A list of locations.

    service
    string

    Service: The type of the endpoint service.

    ServiceEndpointPropertiesFormat_STATUS

    (Appears on:VirtualNetworks_Subnet_STATUS)

    The service endpoint properties.

    Field Description
    locations
    []string

    Locations: A list of locations.

    provisioningState
    ProvisioningState_STATUS

    ProvisioningState: The provisioning state of the service endpoint resource.

    service
    string

    Service: The type of the endpoint service.

    ServiceEndpointPropertiesFormat_STATUS_ARM

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    The service endpoint properties.

    Field Description
    locations
    []string

    Locations: A list of locations.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the service endpoint resource.

    service
    string

    Service: The type of the endpoint service.

    SubResource

    (Appears on:DdosSettings, FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded, InboundNatPool, InboundNatRule_LoadBalancer_SubResourceEmbedded, LoadBalancerBackendAddress, LoadBalancers_InboundNatRule_Spec, LoadBalancingRule, OutboundRule, PublicIPAddress_Spec, VirtualNetworkGatewayIPConfiguration, VirtualNetworkGateway_Spec, VirtualNetwork_Spec, VirtualNetworks_Subnet_Spec, VirtualNetworks_VirtualNetworkPeering_Spec)

    Reference to another subresource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    SubResource_ARM

    (Appears on:DdosSettings_ARM, FrontendIPConfigurationPropertiesFormat_ARM, InboundNatPoolPropertiesFormat_ARM, InboundNatRulePropertiesFormat_ARM, LoadBalancerBackendAddressPropertiesFormat_ARM, LoadBalancingRulePropertiesFormat_ARM, OutboundRulePropertiesFormat_ARM, PublicIPAddressPropertiesFormat_ARM, SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM, SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM, VirtualNetworkGatewayIPConfigurationPropertiesFormat_ARM, VirtualNetworkGatewayPropertiesFormat_ARM, VirtualNetworkPeeringPropertiesFormat_ARM, VirtualNetworkPropertiesFormat_ARM)

    Reference to another subresource.

    Field Description
    id
    string

    SubResource_STATUS

    (Appears on:BackendAddressPool_STATUS_LoadBalancer_SubResourceEmbedded, DdosSettings_STATUS, FrontendIPConfiguration_STATUS_LoadBalancer_SubResourceEmbedded, InboundNatPool_STATUS, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, LoadBalancerBackendAddress_STATUS, LoadBalancers_InboundNatRule_STATUS, LoadBalancingRule_STATUS, NetworkInterface_STATUS_NetworkInterface_SubResourceEmbedded, OutboundRule_STATUS, Probe_STATUS, PublicIPAddress_STATUS_PublicIPAddress_SubResourceEmbedded, VirtualNetworkGatewayIPConfiguration_STATUS, VirtualNetworkGateway_STATUS, VirtualNetwork_STATUS, VirtualNetworks_Subnet_STATUS, VirtualNetworks_VirtualNetworkPeering_STATUS)

    Reference to another subresource.

    Field Description
    id
    string

    Id: Resource ID.

    SubResource_STATUS_ARM

    (Appears on:BackendAddressPoolPropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM, DdosSettings_STATUS_ARM, FrontendIPConfigurationPropertiesFormat_STATUS_ARM, InboundNatPoolPropertiesFormat_STATUS_ARM, InboundNatRulePropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM, InboundNatRulePropertiesFormat_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded_ARM, LoadBalancerBackendAddressPropertiesFormat_STATUS_ARM, LoadBalancingRulePropertiesFormat_STATUS_ARM, NetworkInterfacePropertiesFormat_STATUS_ARM, OutboundRulePropertiesFormat_STATUS_ARM, ProbePropertiesFormat_STATUS_ARM, PublicIPAddressPropertiesFormat_STATUS_ARM, SubnetPropertiesFormat_STATUS_ARM, VirtualNetworkGatewayIPConfigurationPropertiesFormat_STATUS_ARM, VirtualNetworkGatewayPropertiesFormat_STATUS_ARM, VirtualNetworkPeeringPropertiesFormat_STATUS_ARM, VirtualNetworkPropertiesFormat_STATUS_ARM)

    Reference to another subresource.

    Field Description
    id
    string

    Id: Resource ID.

    SubnetPropertiesFormat_PrivateEndpointNetworkPolicies (string alias)

    (Appears on:VirtualNetworks_Subnet_Spec)

    Value Description

    "Disabled"

    "Enabled"

    SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_ARM (string alias)

    (Appears on:SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM, SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM)

    Value Description

    "Disabled"

    "Enabled"

    SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_STATUS (string alias)

    (Appears on:VirtualNetworks_Subnet_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_STATUS_ARM (string alias)

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies (string alias)

    (Appears on:VirtualNetworks_Subnet_Spec)

    Value Description

    "Disabled"

    "Enabled"

    SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_ARM (string alias)

    (Appears on:SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM, SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM)

    Value Description

    "Disabled"

    "Enabled"

    SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_STATUS (string alias)

    (Appears on:VirtualNetworks_Subnet_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_STATUS_ARM (string alias)

    (Appears on:SubnetPropertiesFormat_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    SubnetPropertiesFormat_STATUS_ARM

    (Appears on:VirtualNetworks_Subnet_STATUS_ARM)

    Properties of the subnet.

    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_ARM

    ApplicationGatewayIpConfigurations: Application gateway IP configurations of virtual network resource.

    delegations
    []Delegation_STATUS_ARM

    Delegations: An array of references to the delegations on the subnet.

    ipAllocations
    []SubResource_STATUS_ARM

    IpAllocations: Array of IpAllocation which reference this subnet.

    ipConfigurationProfiles
    []IPConfigurationProfile_STATUS_ARM

    IpConfigurationProfiles: Array of IP configuration profiles which reference this subnet.

    ipConfigurations
    []IPConfiguration_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    IpConfigurations: An array of references to the network interface IP configurations using subnet.

    natGateway
    SubResource_STATUS_ARM

    NatGateway: Nat gateway associated with this subnet.

    networkSecurityGroup
    NetworkSecurityGroup_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    privateEndpointNetworkPolicies
    SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_STATUS_ARM

    PrivateEndpointNetworkPolicies: Enable or Disable apply network policies on private end point in the subnet.

    privateEndpoints
    []PrivateEndpoint_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    PrivateEndpoints: An array of references to private endpoints.

    privateLinkServiceNetworkPolicies
    SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_STATUS_ARM

    PrivateLinkServiceNetworkPolicies: Enable or Disable apply network policies on private link service in the subnet.

    provisioningState
    ProvisioningState_STATUS_ARM

    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_ARM

    ResourceNavigationLinks: An array of references to the external resources using subnet.

    routeTable
    RouteTable_STATUS_SubResourceEmbedded_ARM

    RouteTable: The reference to the RouteTable resource.

    serviceAssociationLinks
    []ServiceAssociationLink_STATUS_ARM

    ServiceAssociationLinks: An array of references to services injecting into this subnet.

    serviceEndpointPolicies
    []ServiceEndpointPolicy_STATUS_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    ServiceEndpointPolicies: An array of service endpoint policies.

    serviceEndpoints
    []ServiceEndpointPropertiesFormat_STATUS_ARM

    ServiceEndpoints: An array of service endpoints.

    SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM

    (Appears on:Subnet_VirtualNetwork_SubResourceEmbedded_ARM)

    Properties of the subnet.

    Field Description
    addressPrefix
    string

    AddressPrefix: The address prefix for the subnet.

    addressPrefixes
    []string

    AddressPrefixes: List of address prefixes for the subnet.

    applicationGatewayIpConfigurations
    []ApplicationGatewayIPConfiguration_VirtualNetwork_SubResourceEmbedded_ARM

    ApplicationGatewayIpConfigurations: Application gateway IP configurations of virtual network resource.

    delegations
    []Delegation_ARM

    Delegations: An array of references to the delegations on the subnet.

    ipAllocations
    []SubResource_ARM

    IpAllocations: Array of IpAllocation which reference this subnet.

    natGateway
    SubResource_ARM

    NatGateway: Nat gateway associated with this subnet.

    networkSecurityGroup
    NetworkSecurityGroupSpec_VirtualNetwork_SubResourceEmbedded_ARM

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    privateEndpointNetworkPolicies
    SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_ARM

    PrivateEndpointNetworkPolicies: Enable or Disable apply network policies on private end point in the subnet.

    privateLinkServiceNetworkPolicies
    SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_ARM

    PrivateLinkServiceNetworkPolicies: Enable or Disable apply network policies on private link service in the subnet.

    routeTable
    RouteTableSpec_VirtualNetwork_SubResourceEmbedded_ARM

    RouteTable: The reference to the RouteTable resource.

    serviceEndpointPolicies
    []ServiceEndpointPolicySpec_VirtualNetwork_SubResourceEmbedded_ARM

    ServiceEndpointPolicies: An array of service endpoint policies.

    serviceEndpoints
    []ServiceEndpointPropertiesFormat_ARM

    ServiceEndpoints: An array of service endpoints.

    SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    (Appears on:VirtualNetworks_Subnet_Spec_ARM)

    Properties of the subnet.

    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_ARM

    ApplicationGatewayIpConfigurations: Application gateway IP configurations of virtual network resource.

    delegations
    []Delegation_ARM

    Delegations: An array of references to the delegations on the subnet.

    ipAllocations
    []SubResource_ARM

    IpAllocations: Array of IpAllocation which reference this subnet.

    natGateway
    SubResource_ARM

    NatGateway: Nat gateway associated with this subnet.

    networkSecurityGroup
    NetworkSecurityGroupSpec_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    privateEndpointNetworkPolicies
    SubnetPropertiesFormat_PrivateEndpointNetworkPolicies_ARM

    PrivateEndpointNetworkPolicies: Enable or Disable apply network policies on private end point in the subnet.

    privateLinkServiceNetworkPolicies
    SubnetPropertiesFormat_PrivateLinkServiceNetworkPolicies_ARM

    PrivateLinkServiceNetworkPolicies: Enable or Disable apply network policies on private link service in the subnet.

    routeTable
    RouteTableSpec_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    RouteTable: The reference to the RouteTable resource.

    serviceEndpointPolicies
    []ServiceEndpointPolicySpec_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    ServiceEndpointPolicies: An array of service endpoint policies.

    serviceEndpoints
    []ServiceEndpointPropertiesFormat_ARM

    ServiceEndpoints: An array of service endpoints.

    Subnet_LoadBalancer_SubResourceEmbedded

    (Appears on:FrontendIPConfiguration_LoadBalancer_SubResourceEmbedded)

    Subnet in a virtual network resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    Subnet_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:FrontendIPConfigurationPropertiesFormat_ARM)

    Subnet in a virtual network resource.

    Field Description
    id
    string

    Subnet_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)

    Subnet in a virtual network resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    Subnet_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_ARM)

    Subnet in a virtual network resource.

    Field Description
    id
    string

    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_LoadBalancer_SubResourceEmbedded_ARM

    (Appears on:FrontendIPConfigurationPropertiesFormat_STATUS_ARM)

    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_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM)

    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_NetworkSecurityGroup_SubResourceEmbedded_ARM

    (Appears on:NetworkSecurityGroupPropertiesFormat_STATUS_ARM)

    Subnet in a virtual network resource.

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_VirtualNetwork_SubResourceEmbedded_ARM

    (Appears on:VirtualNetworkPropertiesFormat_ARM)

    Subnet in a virtual network resource.

    Field Description
    id
    string
    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
    SubnetPropertiesFormat_VirtualNetwork_SubResourceEmbedded_ARM

    Properties: Properties of the subnet.

    type
    string

    Type: Resource type.

    TransportProtocol (string alias)

    (Appears on:InboundNatPool, InboundNatRule_LoadBalancer_SubResourceEmbedded, LoadBalancers_InboundNatRule_Spec, LoadBalancingRule)

    The transport protocol for the endpoint.

    Value Description

    "All"

    "Tcp"

    "Udp"

    TransportProtocol_ARM (string alias)

    (Appears on:InboundNatPoolPropertiesFormat_ARM, InboundNatRulePropertiesFormat_ARM, LoadBalancingRulePropertiesFormat_ARM)

    The transport protocol for the endpoint.

    Value Description

    "All"

    "Tcp"

    "Udp"

    TransportProtocol_STATUS (string alias)

    (Appears on:InboundNatPool_STATUS, InboundNatRule_STATUS_LoadBalancer_SubResourceEmbedded, LoadBalancers_InboundNatRule_STATUS, LoadBalancingRule_STATUS)

    The transport protocol for the endpoint.

    Value Description

    "All"

    "Tcp"

    "Udp"

    TransportProtocol_STATUS_ARM (string alias)

    (Appears on:InboundNatPoolPropertiesFormat_STATUS_ARM, InboundNatRulePropertiesFormat_STATUS_LoadBalancer_SubResourceEmbedded_ARM, InboundNatRulePropertiesFormat_STATUS_LoadBalancers_InboundNatRule_SubResourceEmbedded_ARM, LoadBalancingRulePropertiesFormat_STATUS_ARM)

    The transport protocol for the endpoint.

    Value Description

    "All"

    "Tcp"

    "Udp"

    VirtualNetwork

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    VirtualNetwork_Spec


    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.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the virtual network.

    ipAllocations
    []SubResource

    IpAllocations: Array of IpAllocation which reference this VNET.

    location
    string

    Location: Resource location.

    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.

    status
    VirtualNetwork_STATUS

    VirtualNetworkBgpCommunities

    (Appears on:VirtualNetwork_Spec, VirtualNetworks_VirtualNetworkPeering_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_ARM

    (Appears on:VirtualNetworkPeeringPropertiesFormat_ARM, VirtualNetworkPropertiesFormat_ARM)

    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, VirtualNetworks_VirtualNetworkPeering_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.

    VirtualNetworkBgpCommunities_STATUS_ARM

    (Appears on:VirtualNetworkPeeringPropertiesFormat_STATUS_ARM, VirtualNetworkPropertiesFormat_STATUS_ARM)

    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.

    VirtualNetworkGateway

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    VirtualNetworkGateway_Spec


    activeActive
    bool

    ActiveActive: ActiveActive flag.

    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.

    enableBgp
    bool

    EnableBgp: Whether BGP is enabled for this virtual network gateway or not.

    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.

    ipConfigurations
    []VirtualNetworkGatewayIPConfiguration

    IpConfigurations: IP configurations for virtual network gateway.

    location
    string

    Location: Resource location.

    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

    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.

    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.

    status
    VirtualNetworkGateway_STATUS

    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.

    VirtualNetworkGatewayIPConfigurationPropertiesFormat_ARM

    (Appears on:VirtualNetworkGatewayIPConfiguration_ARM)

    Properties of VirtualNetworkGatewayIPConfiguration.

    Field Description
    privateIPAllocationMethod
    IPAllocationMethod_ARM

    PrivateIPAllocationMethod: The private IP address allocation method.

    publicIPAddress
    SubResource_ARM

    PublicIPAddress: The reference to the public IP resource.

    subnet
    SubResource_ARM

    Subnet: The reference to the subnet resource.

    VirtualNetworkGatewayIPConfigurationPropertiesFormat_STATUS_ARM

    (Appears on:VirtualNetworkGatewayIPConfiguration_STATUS_ARM)

    Properties of VirtualNetworkGatewayIPConfiguration.

    Field Description
    privateIPAddress
    string

    PrivateIPAddress: Private IP Address for this gateway.

    privateIPAllocationMethod
    IPAllocationMethod_STATUS_ARM

    PrivateIPAllocationMethod: The private IP address allocation method.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the virtual network gateway IP configuration resource.

    publicIPAddress
    SubResource_STATUS_ARM

    PublicIPAddress: The reference to the public IP resource.

    subnet
    SubResource_STATUS_ARM

    Subnet: The reference to the subnet resource.

    VirtualNetworkGatewayIPConfiguration_ARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_ARM)

    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.

    properties
    VirtualNetworkGatewayIPConfigurationPropertiesFormat_ARM

    Properties: Properties of the virtual network gateway ip configuration.

    VirtualNetworkGatewayIPConfiguration_STATUS

    (Appears on:VirtualNetworkGateway_STATUS)

    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.

    VirtualNetworkGatewayIPConfiguration_STATUS_ARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_STATUS_ARM)

    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.

    properties
    VirtualNetworkGatewayIPConfigurationPropertiesFormat_STATUS_ARM

    Properties: Properties of the virtual network gateway ip configuration.

    VirtualNetworkGatewayPropertiesFormat_ARM

    (Appears on:VirtualNetworkGateway_Spec_ARM)

    VirtualNetworkGateway properties.

    Field Description
    activeActive
    bool

    ActiveActive: ActiveActive flag.

    bgpSettings
    BgpSettings_ARM

    BgpSettings: Virtual network gateway’s BGP speaker settings.

    customRoutes
    AddressSpace_ARM

    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.

    enableBgp
    bool

    EnableBgp: Whether BGP is enabled for this virtual network gateway or not.

    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.

    gatewayDefaultSite
    SubResource_ARM

    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_ARM

    GatewayType: The type of this virtual network gateway.

    ipConfigurations
    []VirtualNetworkGatewayIPConfiguration_ARM

    IpConfigurations: IP configurations for virtual network gateway.

    sku
    VirtualNetworkGatewaySku_ARM

    Sku: The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

    vNetExtendedLocationResourceId
    string
    vpnClientConfiguration
    VpnClientConfiguration_ARM

    VpnClientConfiguration: The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

    vpnGatewayGeneration
    VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_ARM

    VpnGatewayGeneration: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.

    vpnType
    VirtualNetworkGatewayPropertiesFormat_VpnType_ARM

    VpnType: The type of this virtual network gateway.

    VirtualNetworkGatewayPropertiesFormat_GatewayType (string alias)

    (Appears on:VirtualNetworkGateway_Spec)

    Value Description

    "ExpressRoute"

    "LocalGateway"

    "Vpn"

    VirtualNetworkGatewayPropertiesFormat_GatewayType_ARM (string alias)

    (Appears on:VirtualNetworkGatewayPropertiesFormat_ARM)

    Value Description

    "ExpressRoute"

    "LocalGateway"

    "Vpn"

    VirtualNetworkGatewayPropertiesFormat_GatewayType_STATUS (string alias)

    (Appears on:VirtualNetworkGateway_STATUS)

    Value Description

    "ExpressRoute"

    "LocalGateway"

    "Vpn"

    VirtualNetworkGatewayPropertiesFormat_GatewayType_STATUS_ARM (string alias)

    (Appears on:VirtualNetworkGatewayPropertiesFormat_STATUS_ARM)

    Value Description

    "ExpressRoute"

    "LocalGateway"

    "Vpn"

    VirtualNetworkGatewayPropertiesFormat_STATUS_ARM

    (Appears on:VirtualNetworkGateway_STATUS_ARM)

    VirtualNetworkGateway properties.

    Field Description
    activeActive
    bool

    ActiveActive: ActiveActive flag.

    bgpSettings
    BgpSettings_STATUS_ARM

    BgpSettings: Virtual network gateway’s BGP speaker settings.

    customRoutes
    AddressSpace_STATUS_ARM

    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.

    enableBgp
    bool

    EnableBgp: Whether BGP is enabled for this virtual network gateway or not.

    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.

    gatewayDefaultSite
    SubResource_STATUS_ARM

    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_ARM

    GatewayType: The type of this virtual network gateway.

    inboundDnsForwardingEndpoint
    string

    InboundDnsForwardingEndpoint: The IP address allocated by the gateway to which dns requests can be sent.

    ipConfigurations
    []VirtualNetworkGatewayIPConfiguration_STATUS_ARM

    IpConfigurations: IP configurations for virtual network gateway.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the virtual network gateway resource.

    resourceGuid
    string

    ResourceGuid: The resource GUID property of the virtual network gateway resource.

    sku
    VirtualNetworkGatewaySku_STATUS_ARM

    Sku: The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

    vNetExtendedLocationResourceId
    string

    VNetExtendedLocationResourceId: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.

    vpnClientConfiguration
    VpnClientConfiguration_STATUS_ARM

    VpnClientConfiguration: The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

    vpnGatewayGeneration
    VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_STATUS_ARM

    VpnGatewayGeneration: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.

    vpnType
    VirtualNetworkGatewayPropertiesFormat_VpnType_STATUS_ARM

    VpnType: The type of this virtual network gateway.

    VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration (string alias)

    (Appears on:VirtualNetworkGateway_Spec)

    Value Description

    "Generation1"

    "Generation2"

    "None"

    VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_ARM (string alias)

    (Appears on:VirtualNetworkGatewayPropertiesFormat_ARM)

    Value Description

    "Generation1"

    "Generation2"

    "None"

    VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_STATUS (string alias)

    (Appears on:VirtualNetworkGateway_STATUS)

    Value Description

    "Generation1"

    "Generation2"

    "None"

    VirtualNetworkGatewayPropertiesFormat_VpnGatewayGeneration_STATUS_ARM (string alias)

    (Appears on:VirtualNetworkGatewayPropertiesFormat_STATUS_ARM)

    Value Description

    "Generation1"

    "Generation2"

    "None"

    VirtualNetworkGatewayPropertiesFormat_VpnType (string alias)

    (Appears on:VirtualNetworkGateway_Spec)

    Value Description

    "PolicyBased"

    "RouteBased"

    VirtualNetworkGatewayPropertiesFormat_VpnType_ARM (string alias)

    (Appears on:VirtualNetworkGatewayPropertiesFormat_ARM)

    Value Description

    "PolicyBased"

    "RouteBased"

    VirtualNetworkGatewayPropertiesFormat_VpnType_STATUS (string alias)

    (Appears on:VirtualNetworkGateway_STATUS)

    Value Description

    "PolicyBased"

    "RouteBased"

    VirtualNetworkGatewayPropertiesFormat_VpnType_STATUS_ARM (string alias)

    (Appears on:VirtualNetworkGatewayPropertiesFormat_STATUS_ARM)

    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_ARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_ARM)

    VirtualNetworkGatewaySku details.

    Field Description
    name
    VirtualNetworkGatewaySku_Name_ARM

    Name: Gateway SKU name.

    tier
    VirtualNetworkGatewaySku_Tier_ARM

    Tier: Gateway SKU tier.

    VirtualNetworkGatewaySku_Name (string alias)

    (Appears on:VirtualNetworkGatewaySku)

    Value Description

    "Basic"

    "ErGw1AZ"

    "ErGw2AZ"

    "ErGw3AZ"

    "HighPerformance"

    "Standard"

    "UltraPerformance"

    "VpnGw1"

    "VpnGw1AZ"

    "VpnGw2"

    "VpnGw2AZ"

    "VpnGw3"

    "VpnGw3AZ"

    "VpnGw4"

    "VpnGw4AZ"

    "VpnGw5"

    "VpnGw5AZ"

    VirtualNetworkGatewaySku_Name_ARM (string alias)

    (Appears on:VirtualNetworkGatewaySku_ARM)

    Value Description

    "Basic"

    "ErGw1AZ"

    "ErGw2AZ"

    "ErGw3AZ"

    "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"

    "HighPerformance"

    "Standard"

    "UltraPerformance"

    "VpnGw1"

    "VpnGw1AZ"

    "VpnGw2"

    "VpnGw2AZ"

    "VpnGw3"

    "VpnGw3AZ"

    "VpnGw4"

    "VpnGw4AZ"

    "VpnGw5"

    "VpnGw5AZ"

    VirtualNetworkGatewaySku_Name_STATUS_ARM (string alias)

    (Appears on:VirtualNetworkGatewaySku_STATUS_ARM)

    Value Description

    "Basic"

    "ErGw1AZ"

    "ErGw2AZ"

    "ErGw3AZ"

    "HighPerformance"

    "Standard"

    "UltraPerformance"

    "VpnGw1"

    "VpnGw1AZ"

    "VpnGw2"

    "VpnGw2AZ"

    "VpnGw3"

    "VpnGw3AZ"

    "VpnGw4"

    "VpnGw4AZ"

    "VpnGw5"

    "VpnGw5AZ"

    VirtualNetworkGatewaySku_STATUS

    (Appears on:VirtualNetworkGateway_STATUS)

    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_STATUS_ARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_STATUS_ARM)

    VirtualNetworkGatewaySku details.

    Field Description
    capacity
    int

    Capacity: The capacity.

    name
    VirtualNetworkGatewaySku_Name_STATUS_ARM

    Name: Gateway SKU name.

    tier
    VirtualNetworkGatewaySku_Tier_STATUS_ARM

    Tier: Gateway SKU tier.

    VirtualNetworkGatewaySku_Tier (string alias)

    (Appears on:VirtualNetworkGatewaySku)

    Value Description

    "Basic"

    "ErGw1AZ"

    "ErGw2AZ"

    "ErGw3AZ"

    "HighPerformance"

    "Standard"

    "UltraPerformance"

    "VpnGw1"

    "VpnGw1AZ"

    "VpnGw2"

    "VpnGw2AZ"

    "VpnGw3"

    "VpnGw3AZ"

    "VpnGw4"

    "VpnGw4AZ"

    "VpnGw5"

    "VpnGw5AZ"

    VirtualNetworkGatewaySku_Tier_ARM (string alias)

    (Appears on:VirtualNetworkGatewaySku_ARM)

    Value Description

    "Basic"

    "ErGw1AZ"

    "ErGw2AZ"

    "ErGw3AZ"

    "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"

    "HighPerformance"

    "Standard"

    "UltraPerformance"

    "VpnGw1"

    "VpnGw1AZ"

    "VpnGw2"

    "VpnGw2AZ"

    "VpnGw3"

    "VpnGw3AZ"

    "VpnGw4"

    "VpnGw4AZ"

    "VpnGw5"

    "VpnGw5AZ"

    VirtualNetworkGatewaySku_Tier_STATUS_ARM (string alias)

    (Appears on:VirtualNetworkGatewaySku_STATUS_ARM)

    Value Description

    "Basic"

    "ErGw1AZ"

    "ErGw2AZ"

    "ErGw3AZ"

    "HighPerformance"

    "Standard"

    "UltraPerformance"

    "VpnGw1"

    "VpnGw1AZ"

    "VpnGw2"

    "VpnGw2AZ"

    "VpnGw3"

    "VpnGw3AZ"

    "VpnGw4"

    "VpnGw4AZ"

    "VpnGw5"

    "VpnGw5AZ"

    VirtualNetworkGateway_STATUS

    (Appears on:VirtualNetworkGateway)

    A common class for general resource information.

    Field Description
    activeActive
    bool

    ActiveActive: ActiveActive flag.

    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.

    enableBgp
    bool

    EnableBgp: Whether BGP is enabled for this virtual network gateway or not.

    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.

    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.

    provisioningState
    ProvisioningState_STATUS

    ProvisioningState: The provisioning state of the virtual network gateway resource.

    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.

    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_STATUS_ARM

    A common class for general resource information.

    Field Description
    etag
    string

    Etag: A unique read-only string that changes whenever the resource is updated.

    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of type local virtual network gateway.

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    VirtualNetworkGatewayPropertiesFormat_STATUS_ARM

    Properties: Properties of the virtual network gateway.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    VirtualNetworkGateway_Spec

    (Appears on:VirtualNetworkGateway)

    Field Description
    activeActive
    bool

    ActiveActive: ActiveActive flag.

    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.

    enableBgp
    bool

    EnableBgp: Whether BGP is enabled for this virtual network gateway or not.

    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.

    ipConfigurations
    []VirtualNetworkGatewayIPConfiguration

    IpConfigurations: IP configurations for virtual network gateway.

    location
    string

    Location: Resource location.

    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

    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.

    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.

    VirtualNetworkGateway_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of type local virtual network gateway.

    location
    string

    Location: Resource location.

    name
    string
    properties
    VirtualNetworkGatewayPropertiesFormat_ARM

    Properties: Properties of the virtual network gateway.

    tags
    map[string]string

    Tags: Resource tags.

    VirtualNetworkPeeringPropertiesFormat_ARM

    (Appears on:VirtualNetworkPeering_ARM, VirtualNetworks_VirtualNetworkPeering_Spec_ARM)

    Properties of the virtual network peering.

    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.

    doNotVerifyRemoteGateways
    bool

    DoNotVerifyRemoteGateways: If we need to verify the provisioning state of the remote gateway.

    peeringState
    VirtualNetworkPeeringPropertiesFormat_PeeringState_ARM

    PeeringState: The status of the virtual network peering.

    remoteAddressSpace
    AddressSpace_ARM

    RemoteAddressSpace: The reference to the remote virtual network address space.

    remoteBgpCommunities
    VirtualNetworkBgpCommunities_ARM

    RemoteBgpCommunities: The reference to the remote virtual network’s Bgp Communities.

    remoteVirtualNetwork
    SubResource_ARM

    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).

    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.

    VirtualNetworkPeeringPropertiesFormat_PeeringState (string alias)

    (Appears on:VirtualNetworks_VirtualNetworkPeering_Spec)

    Value Description

    "Connected"

    "Disconnected"

    "Initiated"

    VirtualNetworkPeeringPropertiesFormat_PeeringState_ARM (string alias)

    (Appears on:VirtualNetworkPeeringPropertiesFormat_ARM)

    Value Description

    "Connected"

    "Disconnected"

    "Initiated"

    VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS (string alias)

    (Appears on:VirtualNetworks_VirtualNetworkPeering_STATUS)

    Value Description

    "Connected"

    "Disconnected"

    "Initiated"

    VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS_ARM (string alias)

    (Appears on:VirtualNetworkPeeringPropertiesFormat_STATUS_ARM)

    Value Description

    "Connected"

    "Disconnected"

    "Initiated"

    VirtualNetworkPeeringPropertiesFormat_STATUS_ARM

    (Appears on:VirtualNetworks_VirtualNetworkPeering_STATUS_ARM)

    Properties of the virtual network peering.

    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.

    doNotVerifyRemoteGateways
    bool

    DoNotVerifyRemoteGateways: If we need to verify the provisioning state of the remote gateway.

    peeringState
    VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS_ARM

    PeeringState: The status of the virtual network peering.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the virtual network peering resource.

    remoteAddressSpace
    AddressSpace_STATUS_ARM

    RemoteAddressSpace: The reference to the remote virtual network address space.

    remoteBgpCommunities
    VirtualNetworkBgpCommunities_STATUS_ARM

    RemoteBgpCommunities: The reference to the remote virtual network’s Bgp Communities.

    remoteVirtualNetwork
    SubResource_STATUS_ARM

    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).

    resourceGuid
    string

    ResourceGuid: The resourceGuid property of the Virtual Network peering resource.

    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.

    VirtualNetworkPeering_ARM

    (Appears on:VirtualNetworkPropertiesFormat_ARM)

    Peerings in a virtual network resource.

    Field Description
    id
    string
    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
    VirtualNetworkPeeringPropertiesFormat_ARM

    Properties: Properties of the virtual network peering.

    type
    string

    Type: Resource type.

    VirtualNetworkPropertiesFormat_ARM

    (Appears on:VirtualNetwork_Spec_ARM)

    Properties of the virtual network.

    Field Description
    addressSpace
    AddressSpace_ARM

    AddressSpace: The AddressSpace that contains an array of IP address ranges that can be used by subnets.

    bgpCommunities
    VirtualNetworkBgpCommunities_ARM

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

    ddosProtectionPlan
    SubResource_ARM

    DdosProtectionPlan: The DDoS protection plan associated with the virtual network.

    dhcpOptions
    DhcpOptions_ARM

    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.

    ipAllocations
    []SubResource_ARM

    IpAllocations: Array of IpAllocation which reference this VNET.

    subnets
    []Subnet_VirtualNetwork_SubResourceEmbedded_ARM

    Subnets: A list of subnets in a Virtual Network.

    virtualNetworkPeerings
    []VirtualNetworkPeering_ARM

    VirtualNetworkPeerings: A list of peerings in a Virtual Network.

    VirtualNetworkPropertiesFormat_STATUS_ARM

    (Appears on:VirtualNetwork_STATUS_ARM)

    Properties of the virtual network.

    Field Description
    addressSpace
    AddressSpace_STATUS_ARM

    AddressSpace: The AddressSpace that contains an array of IP address ranges that can be used by subnets.

    bgpCommunities
    VirtualNetworkBgpCommunities_STATUS_ARM

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

    ddosProtectionPlan
    SubResource_STATUS_ARM

    DdosProtectionPlan: The DDoS protection plan associated with the virtual network.

    dhcpOptions
    DhcpOptions_STATUS_ARM

    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.

    ipAllocations
    []SubResource_STATUS_ARM

    IpAllocations: Array of IpAllocation which reference this VNET.

    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the virtual network resource.

    resourceGuid
    string

    ResourceGuid: The resourceGuid property of the Virtual Network resource.

    VirtualNetworkTapSpec_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_NetworkInterface_SubResourceEmbedded)

    Virtual Network Tap resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    VirtualNetworkTapSpec_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_ARM)

    Virtual Network Tap resource.

    Field Description
    id
    string

    VirtualNetworkTap_STATUS_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_STATUS_NetworkInterface_SubResourceEmbedded)

    Virtual Network Tap resource.

    Field Description
    id
    string

    Id: Resource ID.

    VirtualNetworkTap_STATUS_NetworkInterface_SubResourceEmbedded_ARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_STATUS_ARM)

    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.

    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.

    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.

    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_STATUS_ARM

    Virtual Network resource.

    Field Description
    etag
    string

    Etag: A unique read-only string that changes whenever the resource is updated.

    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of the virtual network.

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    VirtualNetworkPropertiesFormat_STATUS_ARM

    Properties: Properties of the virtual network.

    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.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the virtual network.

    ipAllocations
    []SubResource

    IpAllocations: Array of IpAllocation which reference this VNET.

    location
    string

    Location: Resource location.

    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.

    VirtualNetwork_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of the virtual network.

    location
    string

    Location: Resource location.

    name
    string
    properties
    VirtualNetworkPropertiesFormat_ARM

    Properties: Properties of the virtual network.

    tags
    map[string]string

    Tags: Resource tags.

    VirtualNetworksSubnet

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    VirtualNetworks_Subnet_Spec


    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.

    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.

    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.

    status
    VirtualNetworks_Subnet_STATUS

    VirtualNetworksVirtualNetworkPeering

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    VirtualNetworks_VirtualNetworkPeering_Spec


    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.

    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

    peeringState
    VirtualNetworkPeeringPropertiesFormat_PeeringState

    PeeringState: The status of the virtual network peering.

    remoteAddressSpace
    AddressSpace

    RemoteAddressSpace: The reference to the remote virtual network address space.

    remoteBgpCommunities
    VirtualNetworkBgpCommunities

    RemoteBgpCommunities: The reference to the remote virtual network’s Bgp Communities.

    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).

    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.

    status
    VirtualNetworks_VirtualNetworkPeering_STATUS

    VirtualNetworks_Subnet_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

    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.

    type
    string

    Type: Resource type.

    VirtualNetworks_Subnet_STATUS_ARM

    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.

    properties
    SubnetPropertiesFormat_STATUS_ARM

    Properties: Properties of the subnet.

    type
    string

    Type: Resource type.

    VirtualNetworks_Subnet_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.

    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.

    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.

    VirtualNetworks_Subnet_Spec_ARM

    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.

    properties
    SubnetPropertiesFormat_VirtualNetworks_Subnet_SubResourceEmbedded_ARM

    Properties: Properties of the subnet.

    VirtualNetworks_VirtualNetworkPeering_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.

    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.

    peeringState
    VirtualNetworkPeeringPropertiesFormat_PeeringState_STATUS

    PeeringState: The 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 remote virtual network address space.

    remoteBgpCommunities
    VirtualNetworkBgpCommunities_STATUS

    RemoteBgpCommunities: The reference to the remote virtual network’s Bgp Communities.

    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).

    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.

    VirtualNetworks_VirtualNetworkPeering_STATUS_ARM

    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.

    properties
    VirtualNetworkPeeringPropertiesFormat_STATUS_ARM

    Properties: Properties of the virtual network peering.

    type
    string

    Type: Resource type.

    VirtualNetworks_VirtualNetworkPeering_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.

    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

    peeringState
    VirtualNetworkPeeringPropertiesFormat_PeeringState

    PeeringState: The status of the virtual network peering.

    remoteAddressSpace
    AddressSpace

    RemoteAddressSpace: The reference to the remote virtual network address space.

    remoteBgpCommunities
    VirtualNetworkBgpCommunities

    RemoteBgpCommunities: The reference to the remote virtual network’s Bgp Communities.

    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).

    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.

    VirtualNetworks_VirtualNetworkPeering_Spec_ARM

    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.

    properties
    VirtualNetworkPeeringPropertiesFormat_ARM

    Properties: Properties of the virtual network peering.

    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.

    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_ARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_ARM)

    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_ARM

    RadiusServers: The radiusServers property for multiple radius server configuration.

    vpnAuthenticationTypes
    []VpnClientConfiguration_VpnAuthenticationTypes_ARM

    VpnAuthenticationTypes: VPN authentication types for the virtual network gateway..

    vpnClientAddressPool
    AddressSpace_ARM

    VpnClientAddressPool: The reference to the address space resource which represents Address space for P2S VpnClient.

    vpnClientIpsecPolicies
    []IpsecPolicy_ARM

    VpnClientIpsecPolicies: VpnClientIpsecPolicies for virtual network gateway P2S client.

    vpnClientProtocols
    []VpnClientConfiguration_VpnClientProtocols_ARM

    VpnClientProtocols: VpnClientProtocols for Virtual network gateway.

    vpnClientRevokedCertificates
    []VpnClientRevokedCertificate_ARM

    VpnClientRevokedCertificates: VpnClientRevokedCertificate for Virtual network gateway.

    vpnClientRootCertificates
    []VpnClientRootCertificate_ARM

    VpnClientRootCertificates: VpnClientRootCertificate for virtual network gateway.

    VpnClientConfiguration_STATUS

    (Appears on:VirtualNetworkGateway_STATUS)

    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.

    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_STATUS_ARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_STATUS_ARM)

    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_ARM

    RadiusServers: The radiusServers property for multiple radius server configuration.

    vpnAuthenticationTypes
    []VpnClientConfiguration_VpnAuthenticationTypes_STATUS_ARM

    VpnAuthenticationTypes: VPN authentication types for the virtual network gateway..

    vpnClientAddressPool
    AddressSpace_STATUS_ARM

    VpnClientAddressPool: The reference to the address space resource which represents Address space for P2S VpnClient.

    vpnClientIpsecPolicies
    []IpsecPolicy_STATUS_ARM

    VpnClientIpsecPolicies: VpnClientIpsecPolicies for virtual network gateway P2S client.

    vpnClientProtocols
    []VpnClientConfiguration_VpnClientProtocols_STATUS_ARM

    VpnClientProtocols: VpnClientProtocols for Virtual network gateway.

    vpnClientRevokedCertificates
    []VpnClientRevokedCertificate_STATUS_ARM

    VpnClientRevokedCertificates: VpnClientRevokedCertificate for Virtual network gateway.

    vpnClientRootCertificates
    []VpnClientRootCertificate_STATUS_ARM

    VpnClientRootCertificates: VpnClientRootCertificate for virtual network gateway.

    VpnClientConfiguration_VpnAuthenticationTypes (string alias)

    (Appears on:VpnClientConfiguration)

    Value Description

    "AAD"

    "Certificate"

    "Radius"

    VpnClientConfiguration_VpnAuthenticationTypes_ARM (string alias)

    (Appears on:VpnClientConfiguration_ARM)

    Value Description

    "AAD"

    "Certificate"

    "Radius"

    VpnClientConfiguration_VpnAuthenticationTypes_STATUS (string alias)

    (Appears on:VpnClientConfiguration_STATUS)

    Value Description

    "AAD"

    "Certificate"

    "Radius"

    VpnClientConfiguration_VpnAuthenticationTypes_STATUS_ARM (string alias)

    (Appears on:VpnClientConfiguration_STATUS_ARM)

    Value Description

    "AAD"

    "Certificate"

    "Radius"

    VpnClientConfiguration_VpnClientProtocols (string alias)

    (Appears on:VpnClientConfiguration)

    Value Description

    "IkeV2"

    "OpenVPN"

    "SSTP"

    VpnClientConfiguration_VpnClientProtocols_ARM (string alias)

    (Appears on:VpnClientConfiguration_ARM)

    Value Description

    "IkeV2"

    "OpenVPN"

    "SSTP"

    VpnClientConfiguration_VpnClientProtocols_STATUS (string alias)

    (Appears on:VpnClientConfiguration_STATUS)

    Value Description

    "IkeV2"

    "OpenVPN"

    "SSTP"

    VpnClientConfiguration_VpnClientProtocols_STATUS_ARM (string alias)

    (Appears on:VpnClientConfiguration_STATUS_ARM)

    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.

    VpnClientRevokedCertificatePropertiesFormat_ARM

    (Appears on:VpnClientRevokedCertificate_ARM)

    Properties of the revoked VPN client certificate of virtual network gateway.

    Field Description
    thumbprint
    string

    Thumbprint: The revoked VPN client certificate thumbprint.

    VpnClientRevokedCertificatePropertiesFormat_STATUS_ARM

    (Appears on:VpnClientRevokedCertificate_STATUS_ARM)

    Properties of the revoked VPN client certificate of virtual network gateway.

    Field Description
    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the VPN client revoked certificate resource.

    thumbprint
    string

    Thumbprint: The revoked VPN client certificate thumbprint.

    VpnClientRevokedCertificate_ARM

    (Appears on:VpnClientConfiguration_ARM)

    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.

    properties
    VpnClientRevokedCertificatePropertiesFormat_ARM

    Properties: Properties of the vpn client revoked certificate.

    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.

    VpnClientRevokedCertificate_STATUS_ARM

    (Appears on:VpnClientConfiguration_STATUS_ARM)

    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.

    properties
    VpnClientRevokedCertificatePropertiesFormat_STATUS_ARM

    Properties: Properties of the vpn client revoked certificate.

    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.

    VpnClientRootCertificatePropertiesFormat_ARM

    (Appears on:VpnClientRootCertificate_ARM)

    Properties of SSL certificates of application gateway.

    Field Description
    publicCertData
    string

    PublicCertData: The certificate public data.

    VpnClientRootCertificatePropertiesFormat_STATUS_ARM

    (Appears on:VpnClientRootCertificate_STATUS_ARM)

    Properties of SSL certificates of application gateway.

    Field Description
    provisioningState
    ProvisioningState_STATUS_ARM

    ProvisioningState: The provisioning state of the VPN client root certificate resource.

    publicCertData
    string

    PublicCertData: The certificate public data.

    VpnClientRootCertificate_ARM

    (Appears on:VpnClientConfiguration_ARM)

    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.

    properties
    VpnClientRootCertificatePropertiesFormat_ARM

    Properties: Properties of the vpn client root certificate.

    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.

    VpnClientRootCertificate_STATUS_ARM

    (Appears on:VpnClientConfiguration_STATUS_ARM)

    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.

    properties
    VpnClientRootCertificatePropertiesFormat_STATUS_ARM

    Properties: Properties of the vpn client root certificate.