network.azure.com/v1beta20201101

network.azure.com/v1beta20201101

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

Resource Types:

    AddressSpace

    (Appears on:VirtualNetworkGateways_Spec, VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration, VirtualNetworksVirtualNetworkPeerings_Spec, VirtualNetworks_Spec)

    Field Description
    addressPrefixes
    []string

    AddressPrefixes: A list of address blocks reserved for this virtual network in CIDR notation.

    AddressSpaceARM

    (Appears on:VirtualNetworkGateways_Spec_PropertiesARM, VirtualNetworkGateways_Spec_Properties_VpnClientConfigurationARM, VirtualNetworkPeeringPropertiesFormatARM, VirtualNetworks_Spec_PropertiesARM)

    Field Description
    addressPrefixes
    []string

    AddressPrefixes: A list of address blocks reserved for this virtual network in CIDR notation.

    AddressSpace_Status

    (Appears on:VirtualNetworkGateway_Status, VirtualNetworkPeering_Status, VirtualNetwork_Status, VpnClientConfiguration_Status)

    Field Description
    addressPrefixes
    []string

    AddressPrefixes: A list of address blocks reserved for this virtual network in CIDR notation.

    AddressSpace_StatusARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_StatusARM, VirtualNetworkPeeringPropertiesFormat_StatusARM, VirtualNetworkPropertiesFormat_StatusARM, VpnClientConfiguration_StatusARM)

    Field Description
    addressPrefixes
    []string

    AddressPrefixes: A list of address blocks reserved for this virtual network in CIDR notation.

    ApplicationGatewayBackendAddressPoolPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:ApplicationGatewayBackendAddressPool_Status_NetworkInterface_SubResourceEmbeddedARM)

    Field Description
    backendAddresses
    []ApplicationGatewayBackendAddress_StatusARM

    BackendAddresses: Backend addresses.

    provisioningState
    ProvisioningState_Status

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

    ApplicationGatewayBackendAddressPool_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    backendAddresses
    []ApplicationGatewayBackendAddress_Status

    BackendAddresses: Backend addresses.

    etag
    string

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

    id
    string

    Id: Resource ID.

    name
    string

    Name: Name of the backend address pool that is unique within an Application Gateway.

    provisioningState
    ProvisioningState_Status

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

    type
    string

    Type: Type of the resource.

    ApplicationGatewayBackendAddressPool_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM)

    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: Name of the backend address pool that is unique within an Application Gateway.

    properties
    ApplicationGatewayBackendAddressPoolPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM

    Properties: Properties of the application gateway backend address pool.

    type
    string

    Type: Type of the resource.

    ApplicationGatewayBackendAddress_Status

    (Appears on:ApplicationGatewayBackendAddressPool_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    fqdn
    string

    Fqdn: Fully qualified domain name (FQDN).

    ipAddress
    string

    IpAddress: IP address.

    ApplicationGatewayBackendAddress_StatusARM

    (Appears on:ApplicationGatewayBackendAddressPoolPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM)

    Field Description
    fqdn
    string

    Fqdn: Fully qualified domain name (FQDN).

    ipAddress
    string

    IpAddress: IP address.

    ApplicationGatewayIPConfigurationPropertiesFormat_StatusARM

    (Appears on:ApplicationGatewayIPConfiguration_StatusARM)

    Field Description
    provisioningState
    ProvisioningState_Status

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

    subnet
    SubResource_StatusARM

    Subnet: Reference to the subnet resource. A subnet from where application gateway gets its private address.

    ApplicationGatewayIPConfiguration_Status

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    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: Name of the IP configuration that is unique within an Application Gateway.

    provisioningState
    ProvisioningState_Status

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

    subnet
    SubResource_Status

    Subnet: Reference to the subnet resource. A subnet from where application gateway gets its private address.

    type
    string

    Type: Type of the resource.

    ApplicationGatewayIPConfiguration_StatusARM

    (Appears on:SubnetPropertiesFormat_StatusARM)

    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: Name of the IP configuration that is unique within an Application Gateway.

    properties
    ApplicationGatewayIPConfigurationPropertiesFormat_StatusARM

    Properties: Properties of the application gateway IP configuration.

    type
    string

    Type: Type of the resource.

    ApplicationSecurityGroup_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationSecurityGroup_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM)

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationSecurityGroup_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbedded

    (Appears on:SecurityRule_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationSecurityGroup_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbeddedARM

    (Appears on:SecurityRulePropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    BackendAddressPool_Status_LoadBalancer_SubResourceEmbedded

    (Appears on:LoadBalancer_Status)

    Field Description
    id
    string

    Id: Resource ID.

    BackendAddressPool_Status_LoadBalancer_SubResourceEmbeddedARM

    (Appears on:LoadBalancerPropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    BackendAddressPool_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    BackendAddressPool_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM)

    Field Description
    id
    string

    Id: Resource ID.

    BgpSettings

    (Appears on:VirtualNetworkGateways_Spec)

    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.

    BgpSettingsARM

    (Appears on:VirtualNetworkGateways_Spec_PropertiesARM)

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

    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)

    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_StatusARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_StatusARM)

    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_StatusARM

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

    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
    DdosSettingsProtectionCoverage

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

    DdosSettingsARM

    (Appears on:PublicIPAddressPropertiesFormatARM)

    Field Description
    ddosCustomPolicy
    SubResourceARM

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

    protectedIP
    bool

    ProtectedIP: Enables DDoS protection on the public IP.

    protectionCoverage
    DdosSettingsProtectionCoverage

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

    DdosSettingsProtectionCoverage (string alias)

    (Appears on:DdosSettings, DdosSettingsARM)

    Value Description

    "Basic"

    "Standard"

    DdosSettingsStatusProtectionCoverage (string alias)

    (Appears on:DdosSettings_Status, DdosSettings_StatusARM)

    Value Description

    "Basic"

    "Standard"

    DdosSettings_Status

    (Appears on:PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded)

    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
    DdosSettingsStatusProtectionCoverage

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

    DdosSettings_StatusARM

    (Appears on:PublicIPAddressPropertiesFormat_StatusARM)

    Field Description
    ddosCustomPolicy
    SubResource_StatusARM

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

    protectedIP
    bool

    ProtectedIP: Enables DDoS protection on the public IP.

    protectionCoverage
    DdosSettingsStatusProtectionCoverage

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

    Delegation_Status

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    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_StatusARM

    (Appears on:SubnetPropertiesFormat_StatusARM)

    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_StatusARM

    Properties: Properties of the subnet.

    type
    string

    Type: Resource type.

    DhGroup_Status (string alias)

    (Appears on:IpsecPolicy_Status, IpsecPolicy_StatusARM)

    Value Description

    "DHGroup1"

    "DHGroup14"

    "DHGroup2"

    "DHGroup2048"

    "DHGroup24"

    "ECP256"

    "ECP384"

    "None"

    DhcpOptions

    (Appears on:VirtualNetworks_Spec)

    Field Description
    dnsServers
    []string

    DnsServers: The list of DNS servers IP addresses.

    DhcpOptionsARM

    (Appears on:VirtualNetworks_Spec_PropertiesARM)

    Field Description
    dnsServers
    []string

    DnsServers: The list of DNS servers IP addresses.

    DhcpOptions_Status

    (Appears on:VirtualNetwork_Status)

    Field Description
    dnsServers
    []string

    DnsServers: The list of DNS servers IP addresses.

    DhcpOptions_StatusARM

    (Appears on:VirtualNetworkPropertiesFormat_StatusARM)

    Field Description
    dnsServers
    []string

    DnsServers: The list of DNS servers IP addresses.

    ExtendedLocation

    (Appears on:LoadBalancers_Spec, NetworkInterfaces_Spec, PublicIPAddresses_Spec, VirtualNetworkGateways_Spec, VirtualNetworks_Spec)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocationARM

    (Appears on:LoadBalancers_SpecARM, NetworkInterfaces_SpecARM, PublicIPAddresses_SpecARM, VirtualNetworkGateways_Spec_PropertiesARM, VirtualNetworks_SpecARM)

    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, ExtendedLocationARM)

    Value Description

    "EdgeZone"

    ExtendedLocationType_Status (string alias)

    (Appears on:ExtendedLocation_Status, ExtendedLocation_StatusARM)

    Value Description

    "EdgeZone"

    ExtendedLocation_Status

    (Appears on:LoadBalancer_Status, NetworkInterface_Status_NetworkInterface_SubResourceEmbedded, NetworkInterface_Status_NetworkSecurityGroup_SubResourceEmbedded, PrivateEndpoint_Status_NetworkInterface_SubResourceEmbedded, PrivateEndpoint_Status_VirtualNetworksSubnet_SubResourceEmbedded, PrivateLinkService_Status_NetworkInterface_SubResourceEmbedded, PublicIPAddress_Status_LoadBalancer_SubResourceEmbedded, PublicIPAddress_Status_NetworkInterface_SubResourceEmbedded, PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded, PublicIPAddress_Status_VirtualNetworksSubnet_SubResourceEmbedded, VirtualNetworkGateway_Status, VirtualNetwork_Status)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_Status

    Type: The type of the extended location.

    ExtendedLocation_StatusARM

    (Appears on:LoadBalancer_StatusARM, NetworkInterface_Status_NetworkInterface_SubResourceEmbeddedARM, NetworkInterface_Status_NetworkSecurityGroup_SubResourceEmbeddedARM, PrivateEndpoint_Status_NetworkInterface_SubResourceEmbeddedARM, PrivateEndpoint_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM, PrivateLinkService_Status_NetworkInterface_SubResourceEmbeddedARM, PublicIPAddress_Status_LoadBalancer_SubResourceEmbeddedARM, PublicIPAddress_Status_NetworkInterface_SubResourceEmbeddedARM, PublicIPAddress_Status_PublicIPAddress_SubResourceEmbeddedARM, PublicIPAddress_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM, VirtualNetworkGateway_StatusARM, VirtualNetwork_StatusARM)

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_Status

    Type: The type of the extended location.

    FlowLog_Status_SubResourceEmbedded

    (Appears on:NetworkSecurityGroup_Status_NetworkSecurityGroup_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    FlowLog_Status_SubResourceEmbeddedARM

    (Appears on:NetworkSecurityGroupPropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    FrontendIPConfigurationPropertiesFormatARM

    (Appears on:LoadBalancers_Spec_Properties_FrontendIPConfigurationsARM)

    Field Description
    privateIPAddress
    string

    PrivateIPAddress: The private IP address of the IP configuration.

    privateIPAddressVersion
    FrontendIPConfigurationPropertiesFormatPrivateIPAddressVersion

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

    privateIPAllocationMethod
    FrontendIPConfigurationPropertiesFormatPrivateIPAllocationMethod

    PrivateIPAllocationMethod: The Private IP allocation method.

    publicIPAddress
    SubResourceARM

    PublicIPAddress: The reference to the Public IP resource.

    publicIPPrefix
    SubResourceARM

    PublicIPPrefix: The reference to the Public IP Prefix resource.

    subnet
    SubResourceARM

    Subnet: The reference to the subnet resource.

    FrontendIPConfigurationPropertiesFormatPrivateIPAddressVersion (string alias)

    (Appears on:FrontendIPConfigurationPropertiesFormatARM, LoadBalancers_Spec_Properties_FrontendIPConfigurations)

    Value Description

    "IPv4"

    "IPv6"

    FrontendIPConfigurationPropertiesFormatPrivateIPAllocationMethod (string alias)

    (Appears on:FrontendIPConfigurationPropertiesFormatARM, LoadBalancers_Spec_Properties_FrontendIPConfigurations)

    Value Description

    "Dynamic"

    "Static"

    FrontendIPConfigurationPropertiesFormat_Status_LoadBalancer_SubResourceEmbeddedARM

    (Appears on:FrontendIPConfiguration_Status_LoadBalancer_SubResourceEmbeddedARM)

    Field Description
    inboundNatPools
    []SubResource_StatusARM

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

    inboundNatRules
    []SubResource_StatusARM

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

    loadBalancingRules
    []SubResource_StatusARM

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

    outboundRules
    []SubResource_StatusARM

    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_SubResourceEmbeddedARM

    PublicIPAddress: The reference to the Public IP resource.

    publicIPPrefix
    SubResource_StatusARM

    PublicIPPrefix: The reference to the Public IP Prefix resource.

    subnet
    Subnet_Status_LoadBalancer_SubResourceEmbeddedARM

    Subnet: The reference to the subnet resource.

    FrontendIPConfiguration_Status_LoadBalancer_SubResourceEmbedded

    (Appears on:LoadBalancer_Status)

    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_SubResourceEmbeddedARM

    (Appears on:LoadBalancerPropertiesFormat_StatusARM)

    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_LoadBalancer_SubResourceEmbeddedARM

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

    (Appears on:FrontendIPConfigurationPropertiesFormat_Status_LoadBalancer_SubResourceEmbeddedARM, FrontendIPConfiguration_Status_LoadBalancer_SubResourceEmbedded, IPConfigurationPropertiesFormat_Status_PublicIPAddress_SubResourceEmbeddedARM, IPConfigurationPropertiesFormat_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM, IPConfiguration_Status_PublicIPAddress_SubResourceEmbedded, IPConfiguration_Status_VirtualNetworksSubnet_SubResourceEmbedded, NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM, NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded, PublicIPAddressPropertiesFormat_StatusARM, PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded, VirtualNetworkGatewayIPConfigurationPropertiesFormat_StatusARM, VirtualNetworkGatewayIPConfiguration_Status)

    Value Description

    "Dynamic"

    "Static"

    IPConfigurationBgpPeeringAddress

    (Appears on:BgpSettings)

    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.

    IPConfigurationBgpPeeringAddressARM

    (Appears on:BgpSettingsARM)

    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)

    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_StatusARM

    (Appears on:BgpSettings_StatusARM)

    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.

    IPConfigurationProfilePropertiesFormat_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    (Appears on:IPConfigurationProfile_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM)

    Field Description
    provisioningState
    ProvisioningState_Status

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

    IPConfigurationProfile_Status_VirtualNetworksSubnet_SubResourceEmbedded

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

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

    provisioningState
    ProvisioningState_Status

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

    type
    string

    Type: Sub Resource type.

    IPConfigurationProfile_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    (Appears on:SubnetPropertiesFormat_StatusARM)

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

    properties
    IPConfigurationProfilePropertiesFormat_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    Properties: Properties of the IP configuration profile.

    type
    string

    Type: Sub Resource type.

    IPConfigurationPropertiesFormat_Status_PublicIPAddress_SubResourceEmbeddedARM

    (Appears on:IPConfiguration_Status_PublicIPAddress_SubResourceEmbeddedARM)

    Field Description
    privateIPAddress
    string

    PrivateIPAddress: The private IP address of the IP configuration.

    privateIPAllocationMethod
    IPAllocationMethod_Status

    PrivateIPAllocationMethod: The private IP address allocation method.

    provisioningState
    ProvisioningState_Status

    ProvisioningState: The provisioning state of the IP configuration resource.

    subnet
    Subnet_Status_PublicIPAddress_SubResourceEmbeddedARM

    Subnet: The reference to the subnet resource.

    IPConfigurationPropertiesFormat_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    (Appears on:IPConfiguration_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM)

    Field Description
    privateIPAddress
    string

    PrivateIPAddress: The private IP address of the IP configuration.

    privateIPAllocationMethod
    IPAllocationMethod_Status

    PrivateIPAllocationMethod: The private IP address allocation method.

    provisioningState
    ProvisioningState_Status

    ProvisioningState: The provisioning state of the IP configuration resource.

    publicIPAddress
    PublicIPAddress_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    PublicIPAddress: The reference to the public IP resource.

    IPConfiguration_Status_PublicIPAddress_SubResourceEmbedded

    (Appears on:PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded)

    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: The private IP address of the IP configuration.

    privateIPAllocationMethod
    IPAllocationMethod_Status

    PrivateIPAllocationMethod: The private IP address allocation method.

    provisioningState
    ProvisioningState_Status

    ProvisioningState: The provisioning state of the IP configuration resource.

    subnet
    Subnet_Status_PublicIPAddress_SubResourceEmbedded

    Subnet: The reference to the subnet resource.

    IPConfiguration_Status_PublicIPAddress_SubResourceEmbeddedARM

    (Appears on:PublicIPAddressPropertiesFormat_StatusARM)

    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
    IPConfigurationPropertiesFormat_Status_PublicIPAddress_SubResourceEmbeddedARM

    Properties: Properties of the IP configuration.

    IPConfiguration_Status_VirtualNetworksSubnet_SubResourceEmbedded

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    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: The private IP address of the IP configuration.

    privateIPAllocationMethod
    IPAllocationMethod_Status

    PrivateIPAllocationMethod: The private IP address allocation method.

    provisioningState
    ProvisioningState_Status

    ProvisioningState: The provisioning state of the IP configuration resource.

    publicIPAddress
    PublicIPAddress_Status_VirtualNetworksSubnet_SubResourceEmbedded

    PublicIPAddress: The reference to the public IP resource.

    IPConfiguration_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    (Appears on:SubnetPropertiesFormat_StatusARM)

    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
    IPConfigurationPropertiesFormat_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    Properties: Properties of the IP configuration.

    IPVersion_Status (string alias)

    (Appears on:FrontendIPConfigurationPropertiesFormat_Status_LoadBalancer_SubResourceEmbeddedARM, FrontendIPConfiguration_Status_LoadBalancer_SubResourceEmbedded, NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM, NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded, PublicIPAddressPropertiesFormat_StatusARM, PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded)

    Value Description

    "IPv4"

    "IPv6"

    IkeEncryption_Status (string alias)

    (Appears on:IpsecPolicy_Status, IpsecPolicy_StatusARM)

    Value Description

    "AES128"

    "AES192"

    "AES256"

    "DES"

    "DES3"

    "GCMAES128"

    "GCMAES256"

    IkeIntegrity_Status (string alias)

    (Appears on:IpsecPolicy_Status, IpsecPolicy_StatusARM)

    Value Description

    "GCMAES128"

    "GCMAES256"

    "MD5"

    "SHA1"

    "SHA256"

    "SHA384"

    InboundNatPoolPropertiesFormatARM

    (Appears on:LoadBalancers_Spec_Properties_InboundNatPoolsARM)

    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
    SubResourceARM

    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
    InboundNatPoolPropertiesFormatProtocol

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

    InboundNatPoolPropertiesFormatProtocol (string alias)

    (Appears on:InboundNatPoolPropertiesFormatARM, LoadBalancers_Spec_Properties_InboundNatPools)

    Value Description

    "All"

    "Tcp"

    "Udp"

    InboundNatPoolPropertiesFormat_StatusARM

    (Appears on:InboundNatPool_StatusARM)

    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_StatusARM

    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

    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.

    InboundNatPool_Status

    (Appears on:LoadBalancer_Status)

    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_StatusARM

    (Appears on:LoadBalancerPropertiesFormat_StatusARM)

    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_StatusARM

    Properties: Properties of load balancer inbound nat pool.

    type
    string

    Type: Type of the resource.

    InboundNatRule_Status_LoadBalancer_SubResourceEmbedded

    (Appears on:LoadBalancer_Status)

    Field Description
    id
    string

    Id: Resource ID.

    InboundNatRule_Status_LoadBalancer_SubResourceEmbeddedARM

    (Appears on:LoadBalancerPropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    InboundNatRule_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    InboundNatRule_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM)

    Field Description
    id
    string

    Id: Resource ID.

    IpTag

    (Appears on:PublicIPAddresses_Spec)

    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.

    IpTagARM

    (Appears on:PublicIPAddressPropertiesFormatARM)

    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)

    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_StatusARM

    (Appears on:PublicIPAddressPropertiesFormat_StatusARM)

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

    (Appears on:IpsecPolicy_Status, IpsecPolicy_StatusARM)

    Value Description

    "AES128"

    "AES192"

    "AES256"

    "DES"

    "DES3"

    "GCMAES128"

    "GCMAES192"

    "GCMAES256"

    "None"

    IpsecIntegrity_Status (string alias)

    (Appears on:IpsecPolicy_Status, IpsecPolicy_StatusARM)

    Value Description

    "GCMAES128"

    "GCMAES192"

    "GCMAES256"

    "MD5"

    "SHA1"

    "SHA256"

    IpsecPolicy

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration)

    Field Description
    dhGroup
    IpsecPolicyDhGroup

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

    ikeEncryption
    IpsecPolicyIkeEncryption

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

    ikeIntegrity
    IpsecPolicyIkeIntegrity

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

    ipsecEncryption
    IpsecPolicyIpsecEncryption

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

    ipsecIntegrity
    IpsecPolicyIpsecIntegrity

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

    pfsGroup
    IpsecPolicyPfsGroup

    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.

    IpsecPolicyARM

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfigurationARM)

    Field Description
    dhGroup
    IpsecPolicyDhGroup

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

    ikeEncryption
    IpsecPolicyIkeEncryption

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

    ikeIntegrity
    IpsecPolicyIkeIntegrity

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

    ipsecEncryption
    IpsecPolicyIpsecEncryption

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

    ipsecIntegrity
    IpsecPolicyIpsecIntegrity

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

    pfsGroup
    IpsecPolicyPfsGroup

    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.

    IpsecPolicyDhGroup (string alias)

    (Appears on:IpsecPolicy, IpsecPolicyARM)

    Value Description

    "DHGroup1"

    "DHGroup14"

    "DHGroup2"

    "DHGroup2048"

    "DHGroup24"

    "ECP256"

    "ECP384"

    "None"

    IpsecPolicyIkeEncryption (string alias)

    (Appears on:IpsecPolicy, IpsecPolicyARM)

    Value Description

    "AES128"

    "AES192"

    "AES256"

    "DES"

    "DES3"

    "GCMAES128"

    "GCMAES256"

    IpsecPolicyIkeIntegrity (string alias)

    (Appears on:IpsecPolicy, IpsecPolicyARM)

    Value Description

    "GCMAES128"

    "GCMAES256"

    "MD5"

    "SHA1"

    "SHA256"

    "SHA384"

    IpsecPolicyIpsecEncryption (string alias)

    (Appears on:IpsecPolicy, IpsecPolicyARM)

    Value Description

    "AES128"

    "AES192"

    "AES256"

    "DES"

    "DES3"

    "GCMAES128"

    "GCMAES192"

    "GCMAES256"

    "None"

    IpsecPolicyIpsecIntegrity (string alias)

    (Appears on:IpsecPolicy, IpsecPolicyARM)

    Value Description

    "GCMAES128"

    "GCMAES192"

    "GCMAES256"

    "MD5"

    "SHA1"

    "SHA256"

    IpsecPolicyPfsGroup (string alias)

    (Appears on:IpsecPolicy, IpsecPolicyARM)

    Value Description

    "ECP256"

    "ECP384"

    "None"

    "PFS1"

    "PFS14"

    "PFS2"

    "PFS2048"

    "PFS24"

    "PFSMM"

    IpsecPolicy_Status

    (Appears on:VpnClientConfiguration_Status)

    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_StatusARM

    (Appears on:VpnClientConfiguration_StatusARM)

    Field Description
    dhGroup
    DhGroup_Status

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

    ikeEncryption
    IkeEncryption_Status

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

    ikeIntegrity
    IkeIntegrity_Status

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

    ipsecEncryption
    IpsecEncryption_Status

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

    ipsecIntegrity
    IpsecIntegrity_Status

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

    pfsGroup
    PfsGroup_Status

    PfsGroup: The Pfs Group used in IKE Phase 2 for new child SA.

    saDataSizeKilobytes
    int

    SaDataSizeKilobytes: The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.

    saLifeTimeSeconds
    int

    SaLifeTimeSeconds: The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

    LoadBalancer

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    LoadBalancers_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
    []LoadBalancers_Spec_Properties_BackendAddressPools

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

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the load balancer.

    frontendIPConfigurations
    []LoadBalancers_Spec_Properties_FrontendIPConfigurations

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

    inboundNatPools
    []LoadBalancers_Spec_Properties_InboundNatPools

    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.

    loadBalancingRules
    []LoadBalancers_Spec_Properties_LoadBalancingRules

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

    location
    string

    Location: Location to deploy resource to

    outboundRules
    []LoadBalancers_Spec_Properties_OutboundRules

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

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

    sku
    LoadBalancerSku

    Sku: The load balancer SKU.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    status
    LoadBalancer_Status

    LoadBalancerBackendAddressPropertiesFormatARM

    (Appears on:LoadBalancers_Spec_Properties_BackendAddressPools_Properties_LoadBalancerBackendAddressesARM)

    Field Description
    ipAddress
    string

    IpAddress: IP Address belonging to the referenced virtual network.

    loadBalancerFrontendIPConfiguration
    SubResourceARM

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

    subnet
    SubResourceARM

    Subnet: Reference to an existing subnet.

    virtualNetwork
    SubResourceARM

    VirtualNetwork: Reference to an existing virtual network.

    LoadBalancerPropertiesFormat_StatusARM

    (Appears on:LoadBalancer_StatusARM)

    Field Description
    backendAddressPools
    []BackendAddressPool_Status_LoadBalancer_SubResourceEmbeddedARM

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

    frontendIPConfigurations
    []FrontendIPConfiguration_Status_LoadBalancer_SubResourceEmbeddedARM

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

    inboundNatPools
    []InboundNatPool_StatusARM

    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_SubResourceEmbeddedARM

    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_StatusARM

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

    outboundRules
    []OutboundRule_StatusARM

    OutboundRules: The outbound rules.

    probes
    []Probe_StatusARM

    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.

    LoadBalancerSku

    (Appears on:LoadBalancers_Spec)

    Field Description
    name
    LoadBalancerSkuName

    Name: Name of a load balancer SKU.

    tier
    LoadBalancerSkuTier

    Tier: Tier of a load balancer SKU.

    LoadBalancerSkuARM

    (Appears on:LoadBalancers_SpecARM)

    Field Description
    name
    LoadBalancerSkuName

    Name: Name of a load balancer SKU.

    tier
    LoadBalancerSkuTier

    Tier: Tier of a load balancer SKU.

    LoadBalancerSkuName (string alias)

    (Appears on:LoadBalancerSku, LoadBalancerSkuARM)

    Value Description

    "Basic"

    "Standard"

    LoadBalancerSkuStatusName (string alias)

    (Appears on:LoadBalancerSku_Status, LoadBalancerSku_StatusARM)

    Value Description

    "Basic"

    "Standard"

    LoadBalancerSkuStatusTier (string alias)

    (Appears on:LoadBalancerSku_Status, LoadBalancerSku_StatusARM)

    Value Description

    "Global"

    "Regional"

    LoadBalancerSkuTier (string alias)

    (Appears on:LoadBalancerSku, LoadBalancerSkuARM)

    Value Description

    "Global"

    "Regional"

    LoadBalancerSku_Status

    (Appears on:LoadBalancer_Status)

    Field Description
    name
    LoadBalancerSkuStatusName

    Name: Name of a load balancer SKU.

    tier
    LoadBalancerSkuStatusTier

    Tier: Tier of a load balancer SKU.

    LoadBalancerSku_StatusARM

    (Appears on:LoadBalancer_StatusARM)

    Field Description
    name
    LoadBalancerSkuStatusName

    Name: Name of a load balancer SKU.

    tier
    LoadBalancerSkuStatusTier

    Tier: Tier of a load balancer SKU.

    LoadBalancer_Status

    (Appears on:LoadBalancer)

    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_StatusARM

    Field Description
    etag
    string

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

    extendedLocation
    ExtendedLocation_StatusARM

    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_StatusARM

    Properties: Properties of load balancer.

    sku
    LoadBalancerSku_StatusARM

    Sku: The load balancer SKU.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    LoadBalancersSpecAPIVersion (string alias)

    Value Description

    "2020-11-01"

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

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

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the load balancer.

    frontendIPConfigurations
    []LoadBalancers_Spec_Properties_FrontendIPConfigurations

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

    inboundNatPools
    []LoadBalancers_Spec_Properties_InboundNatPools

    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.

    loadBalancingRules
    []LoadBalancers_Spec_Properties_LoadBalancingRules

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

    location
    string

    Location: Location to deploy resource to

    outboundRules
    []LoadBalancers_Spec_Properties_OutboundRules

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

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

    sku
    LoadBalancerSku

    Sku: The load balancer SKU.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    LoadBalancers_SpecARM

    Field Description
    extendedLocation
    ExtendedLocationARM

    ExtendedLocation: The extended location of the load balancer.

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: Name of the resource

    properties
    LoadBalancers_Spec_PropertiesARM

    Properties: Properties of load balancer.

    sku
    LoadBalancerSkuARM

    Sku: The load balancer SKU.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    LoadBalancers_Spec_PropertiesARM

    (Appears on:LoadBalancers_SpecARM)

    Field Description
    backendAddressPools
    []LoadBalancers_Spec_Properties_BackendAddressPoolsARM

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

    frontendIPConfigurations
    []LoadBalancers_Spec_Properties_FrontendIPConfigurationsARM

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

    inboundNatPools
    []LoadBalancers_Spec_Properties_InboundNatPoolsARM

    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.

    loadBalancingRules
    []LoadBalancers_Spec_Properties_LoadBalancingRulesARM

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

    outboundRules
    []LoadBalancers_Spec_Properties_OutboundRulesARM

    OutboundRules: The outbound rules.

    probes
    []LoadBalancers_Spec_Properties_ProbesARM

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

    LoadBalancers_Spec_Properties_BackendAddressPools

    (Appears on:LoadBalancers_Spec)

    Field Description
    loadBalancerBackendAddresses
    []LoadBalancers_Spec_Properties_BackendAddressPools_Properties_LoadBalancerBackendAddresses

    LoadBalancerBackendAddresses: An array of backend addresses.

    location
    string

    Location: The location of the backend address pool.

    name
    string

    Name: The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.

    LoadBalancers_Spec_Properties_BackendAddressPoolsARM

    (Appears on:LoadBalancers_Spec_PropertiesARM)

    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
    LoadBalancers_Spec_Properties_BackendAddressPools_PropertiesARM

    Properties: Properties of load balancer backend address pool.

    LoadBalancers_Spec_Properties_BackendAddressPools_PropertiesARM

    (Appears on:LoadBalancers_Spec_Properties_BackendAddressPoolsARM)

    Field Description
    loadBalancerBackendAddresses
    []LoadBalancers_Spec_Properties_BackendAddressPools_Properties_LoadBalancerBackendAddressesARM

    LoadBalancerBackendAddresses: An array of backend addresses.

    location
    string

    Location: The location of the backend address pool.

    LoadBalancers_Spec_Properties_BackendAddressPools_Properties_LoadBalancerBackendAddresses

    (Appears on:LoadBalancers_Spec_Properties_BackendAddressPools)

    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.

    LoadBalancers_Spec_Properties_BackendAddressPools_Properties_LoadBalancerBackendAddressesARM

    (Appears on:LoadBalancers_Spec_Properties_BackendAddressPools_PropertiesARM)

    Field Description
    name
    string

    Name: Name of the backend address.

    properties
    LoadBalancerBackendAddressPropertiesFormatARM

    Properties: Properties of load balancer backend address pool.

    LoadBalancers_Spec_Properties_FrontendIPConfigurations

    (Appears on:LoadBalancers_Spec)

    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
    FrontendIPConfigurationPropertiesFormatPrivateIPAddressVersion

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

    privateIPAllocationMethod
    FrontendIPConfigurationPropertiesFormatPrivateIPAllocationMethod

    PrivateIPAllocationMethod: The Private IP allocation method.

    publicIPAddress
    SubResource

    PublicIPAddress: The reference to the Public IP resource.

    publicIPPrefix
    SubResource

    PublicIPPrefix: The reference to the Public IP Prefix resource.

    subnet
    SubResource

    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.

    LoadBalancers_Spec_Properties_FrontendIPConfigurationsARM

    (Appears on:LoadBalancers_Spec_PropertiesARM)

    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
    FrontendIPConfigurationPropertiesFormatARM

    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.

    LoadBalancers_Spec_Properties_InboundNatPools

    (Appears on:LoadBalancers_Spec)

    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
    InboundNatPoolPropertiesFormatProtocol

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

    LoadBalancers_Spec_Properties_InboundNatPoolsARM

    (Appears on:LoadBalancers_Spec_PropertiesARM)

    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
    InboundNatPoolPropertiesFormatARM

    Properties: Properties of load balancer inbound nat pool.

    LoadBalancers_Spec_Properties_LoadBalancingRules

    (Appears on:LoadBalancers_Spec)

    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
    LoadBalancingRulePropertiesFormatLoadDistribution

    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
    LoadBalancingRulePropertiesFormatProtocol

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

    LoadBalancers_Spec_Properties_LoadBalancingRulesARM

    (Appears on:LoadBalancers_Spec_PropertiesARM)

    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
    LoadBalancingRulePropertiesFormatARM

    Properties: Properties of load balancer load balancing rule.

    LoadBalancers_Spec_Properties_OutboundRules

    (Appears on:LoadBalancers_Spec)

    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
    OutboundRulePropertiesFormatProtocol

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

    LoadBalancers_Spec_Properties_OutboundRulesARM

    (Appears on:LoadBalancers_Spec_PropertiesARM)

    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
    OutboundRulePropertiesFormatARM

    Properties: Properties of load balancer outbound rule.

    LoadBalancers_Spec_Properties_Probes

    (Appears on:LoadBalancers_Spec)

    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
    ProbePropertiesFormatProtocol

    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.

    LoadBalancers_Spec_Properties_ProbesARM

    (Appears on:LoadBalancers_Spec_PropertiesARM)

    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
    ProbePropertiesFormatARM

    Properties: Properties of load balancer probe.

    LoadBalancingRulePropertiesFormatARM

    (Appears on:LoadBalancers_Spec_Properties_LoadBalancingRulesARM)

    Field Description
    backendAddressPool
    SubResourceARM

    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
    SubResourceARM

    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
    LoadBalancingRulePropertiesFormatLoadDistribution

    LoadDistribution: The load distribution policy for this rule.

    probe
    SubResourceARM

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

    protocol
    LoadBalancingRulePropertiesFormatProtocol

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

    LoadBalancingRulePropertiesFormatLoadDistribution (string alias)

    (Appears on:LoadBalancers_Spec_Properties_LoadBalancingRules, LoadBalancingRulePropertiesFormatARM)

    Value Description

    "Default"

    "SourceIP"

    "SourceIPProtocol"

    LoadBalancingRulePropertiesFormatProtocol (string alias)

    (Appears on:LoadBalancers_Spec_Properties_LoadBalancingRules, LoadBalancingRulePropertiesFormatARM)

    Value Description

    "All"

    "Tcp"

    "Udp"

    LoadBalancingRulePropertiesFormatStatusLoadDistribution (string alias)

    (Appears on:LoadBalancingRulePropertiesFormat_StatusARM, LoadBalancingRule_Status)

    Value Description

    "Default"

    "SourceIP"

    "SourceIPProtocol"

    LoadBalancingRulePropertiesFormat_StatusARM

    (Appears on:LoadBalancingRule_StatusARM)

    Field Description
    backendAddressPool
    SubResource_StatusARM

    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_StatusARM

    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
    LoadBalancingRulePropertiesFormatStatusLoadDistribution

    LoadDistribution: The load distribution policy for this rule.

    probe
    SubResource_StatusARM

    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.

    LoadBalancingRule_Status

    (Appears on:LoadBalancer_Status)

    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
    LoadBalancingRulePropertiesFormatStatusLoadDistribution

    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_StatusARM

    (Appears on:LoadBalancerPropertiesFormat_StatusARM)

    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_StatusARM

    Properties: Properties of load balancer load balancing rule.

    type
    string

    Type: Type of the resource.

    NatGatewaySkuStatusName (string alias)

    (Appears on:NatGatewaySku_Status, NatGatewaySku_StatusARM)

    Value Description

    "Standard"

    NatGatewaySku_Status

    (Appears on:NatGateway_Status_PublicIPAddress_SubResourceEmbedded)

    Field Description
    name
    NatGatewaySkuStatusName

    Name: Name of Nat Gateway SKU.

    NatGatewaySku_StatusARM

    (Appears on:NatGateway_Status_PublicIPAddress_SubResourceEmbeddedARM)

    Field Description
    name
    NatGatewaySkuStatusName

    Name: Name of Nat Gateway SKU.

    NatGateway_Status_PublicIPAddress_SubResourceEmbedded

    (Appears on:PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    sku
    NatGatewaySku_Status

    Sku: The nat gateway SKU.

    zones
    []string

    Zones: A list of availability zones denoting the zone in which Nat Gateway should be deployed.

    NatGateway_Status_PublicIPAddress_SubResourceEmbeddedARM

    (Appears on:PublicIPAddressPropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    sku
    NatGatewaySku_StatusARM

    Sku: The nat gateway SKU.

    zones
    []string

    Zones: A list of availability zones denoting the zone in which Nat Gateway should be deployed.

    NetworkInterface

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NetworkInterfaces_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
    []NetworkInterfaces_Spec_Properties_IpConfigurations

    IpConfigurations: A list of IPConfigurations of the network interface.

    location
    string

    Location: Location to deploy resource to

    networkSecurityGroup
    SubResource

    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 resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    status
    NetworkInterface_Status_NetworkInterface_SubResourceEmbedded

    NetworkInterfaceDnsSettings

    (Appears on:NetworkInterfaces_Spec)

    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.

    NetworkInterfaceDnsSettingsARM

    (Appears on:NetworkInterfaces_Spec_PropertiesARM)

    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)

    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_StatusARM

    (Appears on:NetworkInterfacePropertiesFormat_StatusARM)

    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)

    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_StatusARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM)

    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.

    NetworkInterfaceIPConfigurationPropertiesFormatARM

    (Appears on:NetworkInterfaces_Spec_Properties_IpConfigurationsARM)

    Field Description
    applicationGatewayBackendAddressPools
    []SubResourceARM

    ApplicationGatewayBackendAddressPools: The reference to ApplicationGatewayBackendAddressPool resource.

    applicationSecurityGroups
    []SubResourceARM

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

    loadBalancerBackendAddressPools
    []SubResourceARM

    LoadBalancerBackendAddressPools: The reference to LoadBalancerBackendAddressPool resource.

    loadBalancerInboundNatRules
    []SubResourceARM

    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
    NetworkInterfaceIPConfigurationPropertiesFormatPrivateIPAddressVersion

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

    privateIPAllocationMethod
    NetworkInterfaceIPConfigurationPropertiesFormatPrivateIPAllocationMethod

    PrivateIPAllocationMethod: The private IP address allocation method.

    publicIPAddress
    SubResourceARM

    PublicIPAddress: Public IP address bound to the IP configuration.

    subnet
    SubResourceARM

    Subnet: Subnet bound to the IP configuration.

    virtualNetworkTaps
    []SubResourceARM

    VirtualNetworkTaps: The reference to Virtual Network Taps.

    NetworkInterfaceIPConfigurationPropertiesFormatPrivateIPAddressVersion (string alias)

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormatARM, NetworkInterfaces_Spec_Properties_IpConfigurations)

    Value Description

    "IPv4"

    "IPv6"

    NetworkInterfaceIPConfigurationPropertiesFormatPrivateIPAllocationMethod (string alias)

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormatARM, NetworkInterfaces_Spec_Properties_IpConfigurations)

    Value Description

    "Dynamic"

    "Static"

    NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbeddedARM)

    Field Description
    applicationGatewayBackendAddressPools
    []ApplicationGatewayBackendAddressPool_Status_NetworkInterface_SubResourceEmbeddedARM

    ApplicationGatewayBackendAddressPools: The reference to ApplicationGatewayBackendAddressPool resource.

    applicationSecurityGroups
    []ApplicationSecurityGroup_Status_NetworkInterface_SubResourceEmbeddedARM

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

    loadBalancerBackendAddressPools
    []BackendAddressPool_Status_NetworkInterface_SubResourceEmbeddedARM

    LoadBalancerBackendAddressPools: The reference to LoadBalancerBackendAddressPool resource.

    loadBalancerInboundNatRules
    []InboundNatRule_Status_NetworkInterface_SubResourceEmbeddedARM

    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

    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_StatusARM

    PrivateLinkConnectionProperties: PrivateLinkConnection properties for the network interface.

    provisioningState
    ProvisioningState_Status

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

    publicIPAddress
    PublicIPAddress_Status_NetworkInterface_SubResourceEmbeddedARM

    PublicIPAddress: Public IP address bound to the IP configuration.

    subnet
    Subnet_Status_NetworkInterface_SubResourceEmbeddedARM

    Subnet: Subnet bound to the IP configuration.

    virtualNetworkTaps
    []VirtualNetworkTap_Status_NetworkInterface_SubResourceEmbeddedARM

    VirtualNetworkTaps: The reference to Virtual Network Taps.

    NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface_Status_NetworkInterface_SubResourceEmbedded)

    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_SubResourceEmbeddedARM

    (Appears on:NetworkInterfacePropertiesFormat_StatusARM)

    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_NetworkInterface_SubResourceEmbeddedARM

    Properties: Network interface IP configuration properties.

    type
    string

    Type: Resource type.

    NetworkInterfacePropertiesFormatStatusMigrationPhase (string alias)

    (Appears on:NetworkInterfacePropertiesFormat_StatusARM, NetworkInterface_Status_NetworkInterface_SubResourceEmbedded)

    Value Description

    "Abort"

    "Commit"

    "Committed"

    "None"

    "Prepare"

    NetworkInterfacePropertiesFormatStatusNicType (string alias)

    (Appears on:NetworkInterfacePropertiesFormat_StatusARM, NetworkInterface_Status_NetworkInterface_SubResourceEmbedded)

    Value Description

    "Elastic"

    "Standard"

    NetworkInterfacePropertiesFormat_StatusARM

    (Appears on:NetworkInterface_Status_NetworkInterface_SubResourceEmbeddedARM)

    Field Description
    dnsSettings
    NetworkInterfaceDnsSettings_StatusARM

    DnsSettings: The DNS settings in network interface.

    dscpConfiguration
    SubResource_StatusARM

    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_SubResourceEmbeddedARM

    IpConfigurations: A list of IPConfigurations of the network interface.

    macAddress
    string

    MacAddress: The MAC address of the network interface.

    migrationPhase
    NetworkInterfacePropertiesFormatStatusMigrationPhase

    MigrationPhase: Migration phase of Network Interface resource.

    networkSecurityGroup
    NetworkSecurityGroup_Status_NetworkInterface_SubResourceEmbeddedARM

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    nicType
    NetworkInterfacePropertiesFormatStatusNicType

    NicType: Type of Network Interface resource.

    primary
    bool

    Primary: Whether this is a primary network interface on a virtual machine.

    privateEndpoint
    PrivateEndpoint_Status_NetworkInterface_SubResourceEmbeddedARM

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

    privateLinkService
    PrivateLinkService_Status_NetworkInterface_SubResourceEmbeddedARM

    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.

    tapConfigurations
    []NetworkInterfaceTapConfiguration_Status_NetworkInterface_SubResourceEmbeddedARM

    TapConfigurations: A list of TapConfigurations of the network interface.

    virtualMachine
    SubResource_StatusARM

    VirtualMachine: The reference to a virtual machine.

    NetworkInterfaceTapConfiguration_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    NetworkInterfaceTapConfiguration_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfacePropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    NetworkInterface_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface)

    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
    NetworkInterfacePropertiesFormatStatusMigrationPhase

    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
    NetworkInterfacePropertiesFormatStatusNicType

    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_SubResourceEmbeddedARM

    Field Description
    etag
    string

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

    extendedLocation
    ExtendedLocation_StatusARM

    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_StatusARM

    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)

    Field Description
    extendedLocation
    ExtendedLocation_Status

    ExtendedLocation: The extended location of the network interface.

    id
    string

    Id: Resource ID.

    NetworkInterface_Status_NetworkSecurityGroup_SubResourceEmbeddedARM

    (Appears on:NetworkSecurityGroupPropertiesFormat_StatusARM)

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location of the network interface.

    id
    string

    Id: Resource ID.

    NetworkInterfacesSpecAPIVersion (string alias)

    Value Description

    "2020-11-01"

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

    IpConfigurations: A list of IPConfigurations of the network interface.

    location
    string

    Location: Location to deploy resource to

    networkSecurityGroup
    SubResource

    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 resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NetworkInterfaces_SpecARM

    Field Description
    extendedLocation
    ExtendedLocationARM

    ExtendedLocation: The extended location of the network interface.

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: Name of the resource

    properties
    NetworkInterfaces_Spec_PropertiesARM

    Properties: Properties of the network interface.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NetworkInterfaces_Spec_PropertiesARM

    (Appears on:NetworkInterfaces_SpecARM)

    Field Description
    dnsSettings
    NetworkInterfaceDnsSettingsARM

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

    IpConfigurations: A list of IPConfigurations of the network interface.

    networkSecurityGroup
    SubResourceARM

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    NetworkInterfaces_Spec_Properties_IpConfigurations

    (Appears on:NetworkInterfaces_Spec)

    Field Description
    applicationGatewayBackendAddressPools
    []SubResource

    ApplicationGatewayBackendAddressPools: The reference to ApplicationGatewayBackendAddressPool resource.

    applicationSecurityGroups
    []SubResource

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

    loadBalancerBackendAddressPools
    []SubResource

    LoadBalancerBackendAddressPools: The reference to LoadBalancerBackendAddressPool resource.

    loadBalancerInboundNatRules
    []SubResource

    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
    NetworkInterfaceIPConfigurationPropertiesFormatPrivateIPAddressVersion

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

    privateIPAllocationMethod
    NetworkInterfaceIPConfigurationPropertiesFormatPrivateIPAllocationMethod

    PrivateIPAllocationMethod: The private IP address allocation method.

    publicIPAddress
    SubResource

    PublicIPAddress: Public IP address bound to the IP configuration.

    subnet
    SubResource

    Subnet: Subnet bound to the IP configuration.

    virtualNetworkTaps
    []SubResource

    VirtualNetworkTaps: The reference to Virtual Network Taps.

    NetworkInterfaces_Spec_Properties_IpConfigurationsARM

    (Appears on:NetworkInterfaces_Spec_PropertiesARM)

    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
    NetworkInterfaceIPConfigurationPropertiesFormatARM

    Properties: Network interface IP configuration properties.

    NetworkSecurityGroup

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    NetworkSecurityGroups_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: Location to deploy resource 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 resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    status
    NetworkSecurityGroup_Status_NetworkSecurityGroup_SubResourceEmbedded

    NetworkSecurityGroupPropertiesFormat_StatusARM

    (Appears on:NetworkSecurityGroup_Status_NetworkSecurityGroup_SubResourceEmbeddedARM)

    Field Description
    defaultSecurityRules
    []SecurityRule_Status_NetworkSecurityGroup_SubResourceEmbeddedARM

    DefaultSecurityRules: The default security rules of network security group.

    flowLogs
    []FlowLog_Status_SubResourceEmbeddedARM

    FlowLogs: A collection of references to flow log resources.

    networkInterfaces
    []NetworkInterface_Status_NetworkSecurityGroup_SubResourceEmbeddedARM

    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.

    securityRules
    []SecurityRule_Status_NetworkSecurityGroup_SubResourceEmbeddedARM

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

    subnets
    []Subnet_Status_NetworkSecurityGroup_SubResourceEmbeddedARM

    Subnets: A collection of references to subnets.

    NetworkSecurityGroup_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    NetworkSecurityGroup_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfacePropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    NetworkSecurityGroup_Status_NetworkSecurityGroup_SubResourceEmbedded

    (Appears on:NetworkSecurityGroup)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    defaultSecurityRules
    []SecurityRule_Status_NetworkSecurityGroup_SubResourceEmbedded

    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_SubResourceEmbedded

    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.

    securityRules
    []SecurityRule_Status_NetworkSecurityGroup_SubResourceEmbedded

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

    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_SubResourceEmbeddedARM

    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_StatusARM

    Properties: Properties of the network security group.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    NetworkSecurityGroup_Status_VirtualNetworksSubnet_SubResourceEmbedded

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    NetworkSecurityGroup_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    (Appears on:SubnetPropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    NetworkSecurityGroupsSecurityRule

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


    access
    SecurityRulePropertiesFormatAccess

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

    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
    SecurityRulePropertiesFormatDirection

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

    location
    string

    Location: Location to deploy resource 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/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
    SecurityRulePropertiesFormatProtocol

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

    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.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    status
    SecurityRule_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbedded

    NetworkSecurityGroupsSecurityRulesSpecAPIVersion (string alias)

    Value Description

    "2020-11-01"

    NetworkSecurityGroupsSecurityRules_Spec

    (Appears on:NetworkSecurityGroupsSecurityRule)

    Field Description
    access
    SecurityRulePropertiesFormatAccess

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

    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
    SecurityRulePropertiesFormatDirection

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

    location
    string

    Location: Location to deploy resource 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/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
    SecurityRulePropertiesFormatProtocol

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

    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.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NetworkSecurityGroupsSecurityRules_SpecARM

    Field Description
    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: Name of the resource

    properties
    SecurityRulePropertiesFormatARM

    Properties: Properties of the security rule.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NetworkSecurityGroupsSpecAPIVersion (string alias)

    Value Description

    "2020-11-01"

    NetworkSecurityGroups_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: Location to deploy resource 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 resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    NetworkSecurityGroups_SpecARM

    Field Description
    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: Name of the resource

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    OutboundRulePropertiesFormatARM

    (Appears on:LoadBalancers_Spec_Properties_OutboundRulesARM)

    Field Description
    allocatedOutboundPorts
    int

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

    backendAddressPool
    SubResourceARM

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

    FrontendIPConfigurations: The Frontend IP addresses of the load balancer.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The timeout for the TCP idle connection.

    protocol
    OutboundRulePropertiesFormatProtocol

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

    OutboundRulePropertiesFormatProtocol (string alias)

    (Appears on:LoadBalancers_Spec_Properties_OutboundRules, OutboundRulePropertiesFormatARM)

    Value Description

    "All"

    "Tcp"

    "Udp"

    OutboundRulePropertiesFormatStatusProtocol (string alias)

    (Appears on:OutboundRulePropertiesFormat_StatusARM, OutboundRule_Status)

    Value Description

    "All"

    "Tcp"

    "Udp"

    OutboundRulePropertiesFormat_StatusARM

    (Appears on:OutboundRule_StatusARM)

    Field Description
    allocatedOutboundPorts
    int

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

    backendAddressPool
    SubResource_StatusARM

    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_StatusARM

    FrontendIPConfigurations: The Frontend IP addresses of the load balancer.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The timeout for the TCP idle connection.

    protocol
    OutboundRulePropertiesFormatStatusProtocol

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

    provisioningState
    ProvisioningState_Status

    ProvisioningState: The provisioning state of the outbound rule resource.

    OutboundRule_Status

    (Appears on:LoadBalancer_Status)

    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
    OutboundRulePropertiesFormatStatusProtocol

    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_StatusARM

    (Appears on:LoadBalancerPropertiesFormat_StatusARM)

    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_StatusARM

    Properties: Properties of load balancer outbound rule.

    type
    string

    Type: Type of the resource.

    PfsGroup_Status (string alias)

    (Appears on:IpsecPolicy_Status, IpsecPolicy_StatusARM)

    Value Description

    "ECP256"

    "ECP384"

    "None"

    "PFS1"

    "PFS14"

    "PFS2"

    "PFS2048"

    "PFS24"

    "PFSMM"

    PrivateEndpoint_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    extendedLocation
    ExtendedLocation_Status

    ExtendedLocation: The extended location of the load balancer.

    id
    string

    Id: Resource ID.

    PrivateEndpoint_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfacePropertiesFormat_StatusARM)

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location of the load balancer.

    id
    string

    Id: Resource ID.

    PrivateEndpoint_Status_VirtualNetworksSubnet_SubResourceEmbedded

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    Field Description
    extendedLocation
    ExtendedLocation_Status

    ExtendedLocation: The extended location of the load balancer.

    id
    string

    Id: Resource ID.

    PrivateEndpoint_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    (Appears on:SubnetPropertiesFormat_StatusARM)

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location of the load balancer.

    id
    string

    Id: Resource ID.

    PrivateLinkService_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterface_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    extendedLocation
    ExtendedLocation_Status

    ExtendedLocation: The extended location of the load balancer.

    id
    string

    Id: Resource ID.

    PrivateLinkService_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfacePropertiesFormat_StatusARM)

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location of the load balancer.

    id
    string

    Id: Resource ID.

    ProbePropertiesFormatARM

    (Appears on:LoadBalancers_Spec_Properties_ProbesARM)

    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
    ProbePropertiesFormatProtocol

    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.

    ProbePropertiesFormatProtocol (string alias)

    (Appears on:LoadBalancers_Spec_Properties_Probes, ProbePropertiesFormatARM)

    Value Description

    "Http"

    "Https"

    "Tcp"

    ProbePropertiesFormatStatusProtocol (string alias)

    (Appears on:ProbePropertiesFormat_StatusARM, Probe_Status)

    Value Description

    "Http"

    "Https"

    "Tcp"

    ProbePropertiesFormat_StatusARM

    (Appears on:Probe_StatusARM)

    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_StatusARM

    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
    ProbePropertiesFormatStatusProtocol

    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.

    Probe_Status

    (Appears on:LoadBalancer_Status)

    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
    ProbePropertiesFormatStatusProtocol

    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_StatusARM

    (Appears on:LoadBalancerPropertiesFormat_StatusARM)

    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_StatusARM

    Properties: Properties of load balancer probe.

    type
    string

    Type: Type of the resource.

    ProvisioningState_Status (string alias)

    (Appears on:ApplicationGatewayBackendAddressPoolPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM, ApplicationGatewayBackendAddressPool_Status_NetworkInterface_SubResourceEmbedded, ApplicationGatewayIPConfigurationPropertiesFormat_StatusARM, ApplicationGatewayIPConfiguration_Status, Delegation_Status, FrontendIPConfigurationPropertiesFormat_Status_LoadBalancer_SubResourceEmbeddedARM, FrontendIPConfiguration_Status_LoadBalancer_SubResourceEmbedded, IPConfigurationProfilePropertiesFormat_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM, IPConfigurationProfile_Status_VirtualNetworksSubnet_SubResourceEmbedded, IPConfigurationPropertiesFormat_Status_PublicIPAddress_SubResourceEmbeddedARM, IPConfigurationPropertiesFormat_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM, IPConfiguration_Status_PublicIPAddress_SubResourceEmbedded, IPConfiguration_Status_VirtualNetworksSubnet_SubResourceEmbedded, InboundNatPoolPropertiesFormat_StatusARM, InboundNatPool_Status, LoadBalancerPropertiesFormat_StatusARM, LoadBalancer_Status, LoadBalancingRulePropertiesFormat_StatusARM, LoadBalancingRule_Status, NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM, NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded, NetworkInterfacePropertiesFormat_StatusARM, NetworkInterface_Status_NetworkInterface_SubResourceEmbedded, NetworkSecurityGroupPropertiesFormat_StatusARM, NetworkSecurityGroup_Status_NetworkSecurityGroup_SubResourceEmbedded, OutboundRulePropertiesFormat_StatusARM, OutboundRule_Status, ProbePropertiesFormat_StatusARM, Probe_Status, PublicIPAddressPropertiesFormat_StatusARM, PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded, ResourceNavigationLinkFormat_StatusARM, ResourceNavigationLink_Status, SecurityRulePropertiesFormat_StatusARM, SecurityRule_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbedded, ServiceAssociationLinkPropertiesFormat_StatusARM, ServiceAssociationLink_Status, ServiceDelegationPropertiesFormat_StatusARM, ServiceEndpointPropertiesFormat_Status, ServiceEndpointPropertiesFormat_StatusARM, SubnetPropertiesFormat_StatusARM, Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded, VirtualNetworkGatewayIPConfigurationPropertiesFormat_StatusARM, VirtualNetworkGatewayIPConfiguration_Status, VirtualNetworkGatewayPropertiesFormat_StatusARM, VirtualNetworkGateway_Status, VirtualNetworkPeeringPropertiesFormat_StatusARM, VirtualNetworkPeering_Status, VirtualNetworkPropertiesFormat_StatusARM, VirtualNetwork_Status, VpnClientRevokedCertificatePropertiesFormat_StatusARM, VpnClientRevokedCertificate_Status, VpnClientRootCertificatePropertiesFormat_StatusARM, VpnClientRootCertificate_Status)

    Value Description

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    PublicIPAddress

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    PublicIPAddresses_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.

    location
    string

    Location: Location to deploy resource 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 resources.azure.com/ResourceGroup resource

    publicIPAddressVersion
    PublicIPAddressPropertiesFormatPublicIPAddressVersion

    PublicIPAddressVersion: The public IP address version.

    publicIPAllocationMethod
    PublicIPAddressPropertiesFormatPublicIPAllocationMethod

    PublicIPAllocationMethod: The public IP address allocation method.

    publicIPPrefix
    SubResource

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

    sku
    PublicIPAddressSku

    Sku: The public IP address SKU.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

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

    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.

    PublicIPAddressDnsSettingsARM

    (Appears on:PublicIPAddressPropertiesFormatARM)

    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)

    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_StatusARM

    (Appears on:PublicIPAddressPropertiesFormat_StatusARM)

    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.

    PublicIPAddressPropertiesFormatARM

    (Appears on:PublicIPAddresses_SpecARM)

    Field Description
    ddosSettings
    DdosSettingsARM

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

    dnsSettings
    PublicIPAddressDnsSettingsARM

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

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

    publicIPAddressVersion
    PublicIPAddressPropertiesFormatPublicIPAddressVersion

    PublicIPAddressVersion: The public IP address version.

    publicIPAllocationMethod
    PublicIPAddressPropertiesFormatPublicIPAllocationMethod

    PublicIPAllocationMethod: The public IP address allocation method.

    publicIPPrefix
    SubResourceARM

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

    PublicIPAddressPropertiesFormatPublicIPAddressVersion (string alias)

    (Appears on:PublicIPAddressPropertiesFormatARM, PublicIPAddresses_Spec)

    Value Description

    "IPv4"

    "IPv6"

    PublicIPAddressPropertiesFormatPublicIPAllocationMethod (string alias)

    (Appears on:PublicIPAddressPropertiesFormatARM, PublicIPAddresses_Spec)

    Value Description

    "Dynamic"

    "Static"

    PublicIPAddressPropertiesFormatStatusMigrationPhase (string alias)

    (Appears on:PublicIPAddressPropertiesFormat_StatusARM, PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded)

    Value Description

    "Abort"

    "Commit"

    "Committed"

    "None"

    "Prepare"

    PublicIPAddressPropertiesFormat_StatusARM

    (Appears on:PublicIPAddress_Status_PublicIPAddress_SubResourceEmbeddedARM)

    Field Description
    ddosSettings
    DdosSettings_StatusARM

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

    dnsSettings
    PublicIPAddressDnsSettings_StatusARM

    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_SubResourceEmbeddedARM

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

    ipTags
    []IpTag_StatusARM

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

    migrationPhase
    PublicIPAddressPropertiesFormatStatusMigrationPhase

    MigrationPhase: Migration phase of Public IP Address.

    natGateway
    NatGateway_Status_PublicIPAddress_SubResourceEmbeddedARM

    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_StatusARM

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

    Field Description
    name
    PublicIPAddressSkuName

    Name: Name of a public IP address SKU.

    tier
    PublicIPAddressSkuTier

    Tier: Tier of a public IP address SKU.

    PublicIPAddressSkuARM

    (Appears on:PublicIPAddresses_SpecARM)

    Field Description
    name
    PublicIPAddressSkuName

    Name: Name of a public IP address SKU.

    tier
    PublicIPAddressSkuTier

    Tier: Tier of a public IP address SKU.

    PublicIPAddressSkuName (string alias)

    (Appears on:PublicIPAddressSku, PublicIPAddressSkuARM)

    Value Description

    "Basic"

    "Standard"

    PublicIPAddressSkuStatusName (string alias)

    (Appears on:PublicIPAddressSku_Status, PublicIPAddressSku_StatusARM)

    Value Description

    "Basic"

    "Standard"

    PublicIPAddressSkuStatusTier (string alias)

    (Appears on:PublicIPAddressSku_Status, PublicIPAddressSku_StatusARM)

    Value Description

    "Global"

    "Regional"

    PublicIPAddressSkuTier (string alias)

    (Appears on:PublicIPAddressSku, PublicIPAddressSkuARM)

    Value Description

    "Global"

    "Regional"

    PublicIPAddressSku_Status

    (Appears on:PublicIPAddress_Status_LoadBalancer_SubResourceEmbedded, PublicIPAddress_Status_NetworkInterface_SubResourceEmbedded, PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded, PublicIPAddress_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    Field Description
    name
    PublicIPAddressSkuStatusName

    Name: Name of a public IP address SKU.

    tier
    PublicIPAddressSkuStatusTier

    Tier: Tier of a public IP address SKU.

    PublicIPAddressSku_StatusARM

    (Appears on:PublicIPAddress_Status_LoadBalancer_SubResourceEmbeddedARM, PublicIPAddress_Status_NetworkInterface_SubResourceEmbeddedARM, PublicIPAddress_Status_PublicIPAddress_SubResourceEmbeddedARM, PublicIPAddress_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM)

    Field Description
    name
    PublicIPAddressSkuStatusName

    Name: Name of a public IP address SKU.

    tier
    PublicIPAddressSkuStatusTier

    Tier: Tier of a public IP address SKU.

    PublicIPAddress_Status_LoadBalancer_SubResourceEmbedded

    (Appears on:FrontendIPConfiguration_Status_LoadBalancer_SubResourceEmbedded)

    Field Description
    extendedLocation
    ExtendedLocation_Status

    ExtendedLocation: The extended location of the public ip address.

    id
    string

    Id: Resource ID.

    sku
    PublicIPAddressSku_Status

    Sku: The public IP address SKU.

    zones
    []string

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

    PublicIPAddress_Status_LoadBalancer_SubResourceEmbeddedARM

    (Appears on:FrontendIPConfigurationPropertiesFormat_Status_LoadBalancer_SubResourceEmbeddedARM)

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location of the public ip address.

    id
    string

    Id: Resource ID.

    sku
    PublicIPAddressSku_StatusARM

    Sku: The public IP address SKU.

    zones
    []string

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

    PublicIPAddress_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    extendedLocation
    ExtendedLocation_Status

    ExtendedLocation: The extended location of the public ip address.

    id
    string

    Id: Resource ID.

    sku
    PublicIPAddressSku_Status

    Sku: The public IP address SKU.

    zones
    []string

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

    PublicIPAddress_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM)

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location of the public ip address.

    id
    string

    Id: Resource ID.

    sku
    PublicIPAddressSku_StatusARM

    Sku: The public IP address SKU.

    zones
    []string

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

    PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded

    (Appears on:PublicIPAddress)

    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
    PublicIPAddressPropertiesFormatStatusMigrationPhase

    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_SubResourceEmbeddedARM

    Field Description
    etag
    string

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

    extendedLocation
    ExtendedLocation_StatusARM

    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_StatusARM

    Properties: Public IP address properties.

    sku
    PublicIPAddressSku_StatusARM

    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_VirtualNetworksSubnet_SubResourceEmbedded

    (Appears on:IPConfiguration_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    Field Description
    extendedLocation
    ExtendedLocation_Status

    ExtendedLocation: The extended location of the public ip address.

    id
    string

    Id: Resource ID.

    sku
    PublicIPAddressSku_Status

    Sku: The public IP address SKU.

    zones
    []string

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

    PublicIPAddress_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    (Appears on:IPConfigurationPropertiesFormat_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM)

    Field Description
    extendedLocation
    ExtendedLocation_StatusARM

    ExtendedLocation: The extended location of the public ip address.

    id
    string

    Id: Resource ID.

    sku
    PublicIPAddressSku_StatusARM

    Sku: The public IP address SKU.

    zones
    []string

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

    PublicIPAddressesSpecAPIVersion (string alias)

    Value Description

    "2020-11-01"

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

    location
    string

    Location: Location to deploy resource 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 resources.azure.com/ResourceGroup resource

    publicIPAddressVersion
    PublicIPAddressPropertiesFormatPublicIPAddressVersion

    PublicIPAddressVersion: The public IP address version.

    publicIPAllocationMethod
    PublicIPAddressPropertiesFormatPublicIPAllocationMethod

    PublicIPAllocationMethod: The public IP address allocation method.

    publicIPPrefix
    SubResource

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

    sku
    PublicIPAddressSku

    Sku: The public IP address SKU.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zones
    []string

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

    PublicIPAddresses_SpecARM

    Field Description
    extendedLocation
    ExtendedLocationARM

    ExtendedLocation: The extended location of the public ip address.

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: Name of the resource

    properties
    PublicIPAddressPropertiesFormatARM

    Properties: Public IP address properties.

    sku
    PublicIPAddressSkuARM

    Sku: The public IP address SKU.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    zones
    []string

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

    RadiusServer

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration)

    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.

    RadiusServerARM

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfigurationARM)

    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)

    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_StatusARM

    (Appears on:VpnClientConfiguration_StatusARM)

    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.

    ResourceNavigationLinkFormat_StatusARM

    (Appears on:ResourceNavigationLink_StatusARM)

    Field Description
    link
    string

    Link: Link to the external resource.

    linkedResourceType
    string

    LinkedResourceType: Resource type of the linked resource.

    provisioningState
    ProvisioningState_Status

    ProvisioningState: The provisioning state of the resource navigation link resource.

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    Field Description
    etag
    string

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

    id
    string

    Id: Resource navigation link identifier.

    link
    string

    Link: Link to the external resource.

    linkedResourceType
    string

    LinkedResourceType: Resource type of the linked resource.

    name
    string

    Name: 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 resource navigation link resource.

    type
    string

    Type: Resource type.

    (Appears on:SubnetPropertiesFormat_StatusARM)

    Field Description
    etag
    string

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

    id
    string

    Id: Resource navigation link identifier.

    name
    string

    Name: Name of the resource that is unique within a resource group. This name can be used to access the resource.

    properties
    ResourceNavigationLinkFormat_StatusARM

    Properties: Resource navigation link properties format.

    type
    string

    Type: Resource type.

    RouteTable_Status_VirtualNetworksSubnet_SubResourceEmbedded

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    RouteTable_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    (Appears on:SubnetPropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    SecurityRuleAccess_Status (string alias)

    (Appears on:SecurityRulePropertiesFormat_StatusARM, SecurityRule_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbedded)

    Value Description

    "Allow"

    "Deny"

    SecurityRuleDirection_Status (string alias)

    (Appears on:SecurityRulePropertiesFormat_StatusARM, SecurityRule_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbedded)

    Value Description

    "Inbound"

    "Outbound"

    SecurityRulePropertiesFormatARM

    (Appears on:NetworkSecurityGroupsSecurityRules_SpecARM)

    Field Description
    access
    SecurityRulePropertiesFormatAccess

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

    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
    SecurityRulePropertiesFormatDirection

    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
    SecurityRulePropertiesFormatProtocol

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

    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.

    SecurityRulePropertiesFormatAccess (string alias)

    (Appears on:NetworkSecurityGroupsSecurityRules_Spec, SecurityRulePropertiesFormatARM)

    Value Description

    "Allow"

    "Deny"

    SecurityRulePropertiesFormatDirection (string alias)

    (Appears on:NetworkSecurityGroupsSecurityRules_Spec, SecurityRulePropertiesFormatARM)

    Value Description

    "Inbound"

    "Outbound"

    SecurityRulePropertiesFormatProtocol (string alias)

    (Appears on:NetworkSecurityGroupsSecurityRules_Spec, SecurityRulePropertiesFormatARM)

    Value Description

    "Ah"

    "Esp"

    "Icmp"

    "*"

    "Tcp"

    "Udp"

    SecurityRulePropertiesFormatStatusProtocol (string alias)

    (Appears on:SecurityRulePropertiesFormat_StatusARM, SecurityRule_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbedded)

    Value Description

    "Ah"

    "Esp"

    "Icmp"

    "*"

    "Tcp"

    "Udp"

    SecurityRulePropertiesFormat_StatusARM

    (Appears on:SecurityRule_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbeddedARM)

    Field Description
    access
    SecurityRuleAccess_Status

    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_NetworkSecurityGroupsSecurityRule_SubResourceEmbeddedARM

    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.

    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
    SecurityRulePropertiesFormatStatusProtocol

    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_NetworkSecurityGroupsSecurityRule_SubResourceEmbeddedARM

    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_Status_NetworkSecurityGroup_SubResourceEmbedded

    (Appears on:NetworkSecurityGroup_Status_NetworkSecurityGroup_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    SecurityRule_Status_NetworkSecurityGroup_SubResourceEmbeddedARM

    (Appears on:NetworkSecurityGroupPropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    SecurityRule_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbedded

    (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_NetworkSecurityGroupsSecurityRule_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
    SecurityRulePropertiesFormatStatusProtocol

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

    SecurityRule_Status_NetworkSecurityGroupsSecurityRule_SubResourceEmbeddedARM

    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_StatusARM

    Properties: Properties of the security rule.

    type
    string

    Type: The type of the resource.

    ServiceAssociationLinkPropertiesFormat_StatusARM

    (Appears on:ServiceAssociationLink_StatusARM)

    Field Description
    allowDelete
    bool

    AllowDelete: If true, the resource can be deleted.

    link
    string

    Link: Link to the external resource.

    linkedResourceType
    string

    LinkedResourceType: Resource type of the linked resource.

    locations
    []string

    Locations: A list of locations.

    provisioningState
    ProvisioningState_Status

    ProvisioningState: The provisioning state of the service association link resource.

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    Field Description
    allowDelete
    bool

    AllowDelete: If true, the resource can be deleted.

    etag
    string

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

    id
    string

    Id: Resource ID.

    link
    string

    Link: Link to the external resource.

    linkedResourceType
    string

    LinkedResourceType: Resource type of the linked resource.

    locations
    []string

    Locations: A list of locations.

    name
    string

    Name: 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 service association link resource.

    type
    string

    Type: Resource type.

    (Appears on:SubnetPropertiesFormat_StatusARM)

    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: Name of the resource that is unique within a resource group. This name can be used to access the resource.

    properties
    ServiceAssociationLinkPropertiesFormat_StatusARM

    Properties: Resource navigation link properties format.

    type
    string

    Type: Resource type.

    ServiceDelegationPropertiesFormatARM

    (Appears on:VirtualNetworksSubnets_Spec_Properties_DelegationsARM, VirtualNetworks_Spec_Properties_Subnets_Properties_DelegationsARM)

    Field Description
    serviceName
    string

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

    ServiceDelegationPropertiesFormat_StatusARM

    (Appears on:Delegation_StatusARM)

    Field Description
    actions
    []string

    Actions: The actions permitted to the service upon delegation.

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

    ServiceEndpointPolicy_Status_VirtualNetworksSubnet_SubResourceEmbedded

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    kind
    string

    Kind: Kind of service endpoint policy. This is metadata used for the Azure portal experience.

    ServiceEndpointPolicy_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    (Appears on:SubnetPropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    kind
    string

    Kind: Kind of service endpoint policy. This is metadata used for the Azure portal experience.

    ServiceEndpointPropertiesFormat

    (Appears on:VirtualNetworksSubnets_Spec)

    Field Description
    locations
    []string

    Locations: A list of locations.

    service
    string

    Service: The type of the endpoint service.

    ServiceEndpointPropertiesFormatARM

    (Appears on:VirtualNetworksSubnets_Spec_PropertiesARM, VirtualNetworks_Spec_Properties_Subnets_PropertiesARM)

    Field Description
    locations
    []string

    Locations: A list of locations.

    service
    string

    Service: The type of the endpoint service.

    ServiceEndpointPropertiesFormat_Status

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    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_StatusARM

    (Appears on:SubnetPropertiesFormat_StatusARM)

    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.

    SubResource

    (Appears on:DdosSettings, LoadBalancers_Spec_Properties_BackendAddressPools_Properties_LoadBalancerBackendAddresses, LoadBalancers_Spec_Properties_FrontendIPConfigurations, LoadBalancers_Spec_Properties_InboundNatPools, LoadBalancers_Spec_Properties_LoadBalancingRules, LoadBalancers_Spec_Properties_OutboundRules, NetworkInterfaces_Spec, NetworkInterfaces_Spec_Properties_IpConfigurations, NetworkSecurityGroupsSecurityRules_Spec, PublicIPAddresses_Spec, VirtualNetworkGateways_Spec, VirtualNetworkGateways_Spec_Properties_IpConfigurations, VirtualNetworksSubnets_Spec, VirtualNetworksVirtualNetworkPeerings_Spec, VirtualNetworks_Spec)

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    SubResourceARM

    (Appears on:DdosSettingsARM, FrontendIPConfigurationPropertiesFormatARM, InboundNatPoolPropertiesFormatARM, LoadBalancerBackendAddressPropertiesFormatARM, LoadBalancingRulePropertiesFormatARM, NetworkInterfaceIPConfigurationPropertiesFormatARM, NetworkInterfaces_Spec_PropertiesARM, OutboundRulePropertiesFormatARM, PublicIPAddressPropertiesFormatARM, SecurityRulePropertiesFormatARM, VirtualNetworkGatewayIPConfigurationPropertiesFormatARM, VirtualNetworkGateways_Spec_PropertiesARM, VirtualNetworkPeeringPropertiesFormatARM, VirtualNetworksSubnets_Spec_PropertiesARM, VirtualNetworks_Spec_PropertiesARM, VirtualNetworks_Spec_Properties_Subnets_PropertiesARM)

    Field Description
    id
    string

    SubResource_Status

    (Appears on:ApplicationGatewayIPConfiguration_Status, DdosSettings_Status, FrontendIPConfiguration_Status_LoadBalancer_SubResourceEmbedded, InboundNatPool_Status, LoadBalancingRule_Status, NetworkInterface_Status_NetworkInterface_SubResourceEmbedded, OutboundRule_Status, Probe_Status, PublicIPAddress_Status_PublicIPAddress_SubResourceEmbedded, Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded, VirtualNetworkGatewayIPConfiguration_Status, VirtualNetworkGateway_Status, VirtualNetworkPeering_Status, VirtualNetwork_Status)

    Field Description
    id
    string

    Id: Resource ID.

    SubResource_StatusARM

    (Appears on:ApplicationGatewayIPConfigurationPropertiesFormat_StatusARM, DdosSettings_StatusARM, FrontendIPConfigurationPropertiesFormat_Status_LoadBalancer_SubResourceEmbeddedARM, InboundNatPoolPropertiesFormat_StatusARM, LoadBalancingRulePropertiesFormat_StatusARM, NetworkInterfacePropertiesFormat_StatusARM, OutboundRulePropertiesFormat_StatusARM, ProbePropertiesFormat_StatusARM, PublicIPAddressPropertiesFormat_StatusARM, SubnetPropertiesFormat_StatusARM, VirtualNetworkGatewayIPConfigurationPropertiesFormat_StatusARM, VirtualNetworkGatewayPropertiesFormat_StatusARM, VirtualNetworkPeeringPropertiesFormat_StatusARM, VirtualNetworkPropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    SubnetPropertiesFormatStatusPrivateEndpointNetworkPolicies (string alias)

    (Appears on:SubnetPropertiesFormat_StatusARM, Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    Value Description

    "Disabled"

    "Enabled"

    SubnetPropertiesFormatStatusPrivateLinkServiceNetworkPolicies (string alias)

    (Appears on:SubnetPropertiesFormat_StatusARM, Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded)

    Value Description

    "Disabled"

    "Enabled"

    SubnetPropertiesFormat_StatusARM

    (Appears on:Subnet_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM)

    Field Description
    addressPrefix
    string

    AddressPrefix: The address prefix for the subnet.

    addressPrefixes
    []string

    AddressPrefixes: List of address prefixes for the subnet.

    applicationGatewayIpConfigurations
    []ApplicationGatewayIPConfiguration_StatusARM

    ApplicationGatewayIpConfigurations: Application gateway IP configurations of virtual network resource.

    delegations
    []Delegation_StatusARM

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

    ipAllocations
    []SubResource_StatusARM

    IpAllocations: Array of IpAllocation which reference this subnet.

    ipConfigurationProfiles
    []IPConfigurationProfile_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

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

    ipConfigurations
    []IPConfiguration_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

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

    natGateway
    SubResource_StatusARM

    NatGateway: Nat gateway associated with this subnet.

    networkSecurityGroup
    NetworkSecurityGroup_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    privateEndpointNetworkPolicies
    SubnetPropertiesFormatStatusPrivateEndpointNetworkPolicies

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

    privateEndpoints
    []PrivateEndpoint_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    PrivateEndpoints: An array of references to private endpoints.

    privateLinkServiceNetworkPolicies
    SubnetPropertiesFormatStatusPrivateLinkServiceNetworkPolicies

    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_StatusARM

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

    routeTable
    RouteTable_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    RouteTable: The reference to the RouteTable resource.

    serviceAssociationLinks
    []ServiceAssociationLink_StatusARM

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

    serviceEndpointPolicies
    []ServiceEndpointPolicy_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    ServiceEndpointPolicies: An array of service endpoint policies.

    serviceEndpoints
    []ServiceEndpointPropertiesFormat_StatusARM

    ServiceEndpoints: An array of service endpoints.

    Subnet_Status_LoadBalancer_SubResourceEmbedded

    (Appears on:FrontendIPConfiguration_Status_LoadBalancer_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_Status_LoadBalancer_SubResourceEmbeddedARM

    (Appears on:FrontendIPConfigurationPropertiesFormat_Status_LoadBalancer_SubResourceEmbeddedARM)

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM)

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_Status_NetworkSecurityGroup_SubResourceEmbedded

    (Appears on:NetworkSecurityGroup_Status_NetworkSecurityGroup_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_Status_NetworkSecurityGroup_SubResourceEmbeddedARM

    (Appears on:NetworkSecurityGroupPropertiesFormat_StatusARM)

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_Status_PublicIPAddress_SubResourceEmbedded

    (Appears on:IPConfiguration_Status_PublicIPAddress_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_Status_PublicIPAddress_SubResourceEmbeddedARM

    (Appears on:IPConfigurationPropertiesFormat_Status_PublicIPAddress_SubResourceEmbeddedARM)

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded

    (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

    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_VirtualNetworksSubnet_SubResourceEmbedded

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

    ipConfigurations
    []IPConfiguration_Status_VirtualNetworksSubnet_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_VirtualNetworksSubnet_SubResourceEmbedded

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    privateEndpointNetworkPolicies
    SubnetPropertiesFormatStatusPrivateEndpointNetworkPolicies

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

    privateEndpoints
    []PrivateEndpoint_Status_VirtualNetworksSubnet_SubResourceEmbedded

    PrivateEndpoints: An array of references to private endpoints.

    privateLinkServiceNetworkPolicies
    SubnetPropertiesFormatStatusPrivateLinkServiceNetworkPolicies

    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_VirtualNetworksSubnet_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_VirtualNetworksSubnet_SubResourceEmbedded

    ServiceEndpointPolicies: An array of service endpoint policies.

    serviceEndpoints
    []ServiceEndpointPropertiesFormat_Status

    ServiceEndpoints: An array of service endpoints.

    type
    string

    Type: Resource type.

    Subnet_Status_VirtualNetworksSubnet_SubResourceEmbeddedARM

    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_StatusARM

    Properties: Properties of the subnet.

    type
    string

    Type: Resource type.

    TransportProtocol_Status (string alias)

    (Appears on:InboundNatPoolPropertiesFormat_StatusARM, InboundNatPool_Status, LoadBalancingRulePropertiesFormat_StatusARM, LoadBalancingRule_Status)

    Value Description

    "All"

    "Tcp"

    "Udp"

    VirtualNetwork

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    VirtualNetworks_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: Location to deploy resource 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 resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    status
    VirtualNetwork_Status

    VirtualNetworkBgpCommunities

    (Appears on:VirtualNetworksVirtualNetworkPeerings_Spec, VirtualNetworks_Spec)

    Field Description
    virtualNetworkCommunity
    string

    VirtualNetworkCommunity: The BGP community associated with the virtual network.

    VirtualNetworkBgpCommunitiesARM

    (Appears on:VirtualNetworkPeeringPropertiesFormatARM, VirtualNetworks_Spec_PropertiesARM)

    Field Description
    virtualNetworkCommunity
    string

    VirtualNetworkCommunity: The BGP community associated with the virtual network.

    VirtualNetworkBgpCommunities_Status

    (Appears on:VirtualNetworkPeering_Status, VirtualNetwork_Status)

    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_StatusARM

    (Appears on:VirtualNetworkPeeringPropertiesFormat_StatusARM, VirtualNetworkPropertiesFormat_StatusARM)

    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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    VirtualNetworkGateways_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.

    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
    VirtualNetworkGatewaysSpecPropertiesGatewayType

    GatewayType: The type of this virtual network gateway.

    ipConfigurations
    []VirtualNetworkGateways_Spec_Properties_IpConfigurations

    IpConfigurations: IP configurations for virtual network gateway.

    location
    string

    Location: Location to deploy resource 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 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: Name-value pairs to add to the resource

    vNetExtendedLocationResourceReference
    genruntime.ResourceReference

    VNetExtendedLocationResourceReference: MAS FIJI customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.

    virtualNetworkExtendedLocation
    ExtendedLocation

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

    vpnClientConfiguration
    VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration

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

    vpnGatewayGeneration
    VirtualNetworkGatewaysSpecPropertiesVpnGatewayGeneration

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

    vpnType
    VirtualNetworkGatewaysSpecPropertiesVpnType

    VpnType: The type of this virtual network gateway.

    status
    VirtualNetworkGateway_Status

    VirtualNetworkGatewayIPConfigurationPropertiesFormatARM

    (Appears on:VirtualNetworkGateways_Spec_Properties_IpConfigurationsARM)

    Field Description
    privateIPAllocationMethod
    VirtualNetworkGatewayIPConfigurationPropertiesFormatPrivateIPAllocationMethod

    PrivateIPAllocationMethod: The private IP address allocation method.

    publicIPAddress
    SubResourceARM

    PublicIPAddress: The reference to the public IP resource.

    subnet
    SubResourceARM

    Subnet: The reference to the subnet resource.

    VirtualNetworkGatewayIPConfigurationPropertiesFormatPrivateIPAllocationMethod (string alias)

    (Appears on:VirtualNetworkGatewayIPConfigurationPropertiesFormatARM, VirtualNetworkGateways_Spec_Properties_IpConfigurations)

    Value Description

    "Dynamic"

    "Static"

    VirtualNetworkGatewayIPConfigurationPropertiesFormat_StatusARM

    (Appears on:VirtualNetworkGatewayIPConfiguration_StatusARM)

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

    PublicIPAddress: The reference to the public IP resource.

    subnet
    SubResource_StatusARM

    Subnet: The reference to the subnet resource.

    VirtualNetworkGatewayIPConfiguration_Status

    (Appears on:VirtualNetworkGateway_Status)

    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_StatusARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_StatusARM)

    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_StatusARM

    Properties: Properties of the virtual network gateway ip configuration.

    VirtualNetworkGatewayPropertiesFormatStatusGatewayType (string alias)

    (Appears on:VirtualNetworkGatewayPropertiesFormat_StatusARM, VirtualNetworkGateway_Status)

    Value Description

    "ExpressRoute"

    "LocalGateway"

    "Vpn"

    VirtualNetworkGatewayPropertiesFormatStatusVpnGatewayGeneration (string alias)

    (Appears on:VirtualNetworkGatewayPropertiesFormat_StatusARM, VirtualNetworkGateway_Status)

    Value Description

    "Generation1"

    "Generation2"

    "None"

    VirtualNetworkGatewayPropertiesFormatStatusVpnType (string alias)

    (Appears on:VirtualNetworkGatewayPropertiesFormat_StatusARM, VirtualNetworkGateway_Status)

    Value Description

    "PolicyBased"

    "RouteBased"

    VirtualNetworkGatewayPropertiesFormat_StatusARM

    (Appears on:VirtualNetworkGateway_StatusARM)

    Field Description
    activeActive
    bool

    ActiveActive: ActiveActive flag.

    bgpSettings
    BgpSettings_StatusARM

    BgpSettings: Virtual network gateway’s BGP speaker settings.

    customRoutes
    AddressSpace_StatusARM

    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_StatusARM

    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
    VirtualNetworkGatewayPropertiesFormatStatusGatewayType

    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_StatusARM

    IpConfigurations: IP configurations for virtual network gateway.

    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_StatusARM

    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_StatusARM

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

    vpnGatewayGeneration
    VirtualNetworkGatewayPropertiesFormatStatusVpnGatewayGeneration

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

    vpnType
    VirtualNetworkGatewayPropertiesFormatStatusVpnType

    VpnType: The type of this virtual network gateway.

    VirtualNetworkGatewaySku

    (Appears on:VirtualNetworkGateways_Spec)

    Field Description
    name
    VirtualNetworkGatewaySkuName

    Name: Gateway SKU name.

    tier
    VirtualNetworkGatewaySkuTier

    Tier: Gateway SKU tier.

    VirtualNetworkGatewaySkuARM

    (Appears on:VirtualNetworkGateways_Spec_PropertiesARM)

    Field Description
    name
    VirtualNetworkGatewaySkuName

    Name: Gateway SKU name.

    tier
    VirtualNetworkGatewaySkuTier

    Tier: Gateway SKU tier.

    VirtualNetworkGatewaySkuName (string alias)

    (Appears on:VirtualNetworkGatewaySku, VirtualNetworkGatewaySkuARM)

    Value Description

    "Basic"

    "ErGw1AZ"

    "ErGw2AZ"

    "ErGw3AZ"

    "HighPerformance"

    "Standard"

    "UltraPerformance"

    "VpnGw1"

    "VpnGw1AZ"

    "VpnGw2"

    "VpnGw2AZ"

    "VpnGw3"

    "VpnGw3AZ"

    "VpnGw4"

    "VpnGw4AZ"

    "VpnGw5"

    "VpnGw5AZ"

    VirtualNetworkGatewaySkuStatusName (string alias)

    (Appears on:VirtualNetworkGatewaySku_Status, VirtualNetworkGatewaySku_StatusARM)

    Value Description

    "Basic"

    "ErGw1AZ"

    "ErGw2AZ"

    "ErGw3AZ"

    "HighPerformance"

    "Standard"

    "UltraPerformance"

    "VpnGw1"

    "VpnGw1AZ"

    "VpnGw2"

    "VpnGw2AZ"

    "VpnGw3"

    "VpnGw3AZ"

    "VpnGw4"

    "VpnGw4AZ"

    "VpnGw5"

    "VpnGw5AZ"

    VirtualNetworkGatewaySkuStatusTier (string alias)

    (Appears on:VirtualNetworkGatewaySku_Status, VirtualNetworkGatewaySku_StatusARM)

    Value Description

    "Basic"

    "ErGw1AZ"

    "ErGw2AZ"

    "ErGw3AZ"

    "HighPerformance"

    "Standard"

    "UltraPerformance"

    "VpnGw1"

    "VpnGw1AZ"

    "VpnGw2"

    "VpnGw2AZ"

    "VpnGw3"

    "VpnGw3AZ"

    "VpnGw4"

    "VpnGw4AZ"

    "VpnGw5"

    "VpnGw5AZ"

    VirtualNetworkGatewaySkuTier (string alias)

    (Appears on:VirtualNetworkGatewaySku, VirtualNetworkGatewaySkuARM)

    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)

    Field Description
    capacity
    int

    Capacity: The capacity.

    name
    VirtualNetworkGatewaySkuStatusName

    Name: Gateway SKU name.

    tier
    VirtualNetworkGatewaySkuStatusTier

    Tier: Gateway SKU tier.

    VirtualNetworkGatewaySku_StatusARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_StatusARM)

    Field Description
    capacity
    int

    Capacity: The capacity.

    name
    VirtualNetworkGatewaySkuStatusName

    Name: Gateway SKU name.

    tier
    VirtualNetworkGatewaySkuStatusTier

    Tier: Gateway SKU tier.

    VirtualNetworkGateway_Status

    (Appears on:VirtualNetworkGateway)

    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
    VirtualNetworkGatewayPropertiesFormatStatusGatewayType

    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
    VirtualNetworkGatewayPropertiesFormatStatusVpnGatewayGeneration

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

    vpnType
    VirtualNetworkGatewayPropertiesFormatStatusVpnType

    VpnType: The type of this virtual network gateway.

    VirtualNetworkGateway_StatusARM

    Field Description
    etag
    string

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

    extendedLocation
    ExtendedLocation_StatusARM

    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_StatusARM

    Properties: Properties of the virtual network gateway.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    VirtualNetworkGatewaysSpecAPIVersion (string alias)

    Value Description

    "2020-11-01"

    VirtualNetworkGatewaysSpecPropertiesGatewayType (string alias)

    (Appears on:VirtualNetworkGateways_Spec, VirtualNetworkGateways_Spec_PropertiesARM)

    Value Description

    "ExpressRoute"

    "HyperNet"

    "LocalGateway"

    "Vpn"

    VirtualNetworkGatewaysSpecPropertiesVpnClientConfigurationVpnAuthenticationTypes (string alias)

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration, VirtualNetworkGateways_Spec_Properties_VpnClientConfigurationARM)

    Value Description

    "AAD"

    "Certificate"

    "Radius"

    VirtualNetworkGatewaysSpecPropertiesVpnClientConfigurationVpnClientProtocols (string alias)

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration, VirtualNetworkGateways_Spec_Properties_VpnClientConfigurationARM)

    Value Description

    "IkeV2"

    "OpenVPN"

    "SSTP"

    VirtualNetworkGatewaysSpecPropertiesVpnGatewayGeneration (string alias)

    (Appears on:VirtualNetworkGateways_Spec, VirtualNetworkGateways_Spec_PropertiesARM)

    Value Description

    "Generation1"

    "Generation2"

    "None"

    VirtualNetworkGatewaysSpecPropertiesVpnType (string alias)

    (Appears on:VirtualNetworkGateways_Spec, VirtualNetworkGateways_Spec_PropertiesARM)

    Value Description

    "PolicyBased"

    "RouteBased"

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

    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
    VirtualNetworkGatewaysSpecPropertiesGatewayType

    GatewayType: The type of this virtual network gateway.

    ipConfigurations
    []VirtualNetworkGateways_Spec_Properties_IpConfigurations

    IpConfigurations: IP configurations for virtual network gateway.

    location
    string

    Location: Location to deploy resource 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 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: Name-value pairs to add to the resource

    vNetExtendedLocationResourceReference
    genruntime.ResourceReference

    VNetExtendedLocationResourceReference: MAS FIJI customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.

    virtualNetworkExtendedLocation
    ExtendedLocation

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

    vpnClientConfiguration
    VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration

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

    vpnGatewayGeneration
    VirtualNetworkGatewaysSpecPropertiesVpnGatewayGeneration

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

    vpnType
    VirtualNetworkGatewaysSpecPropertiesVpnType

    VpnType: The type of this virtual network gateway.

    VirtualNetworkGateways_SpecARM

    Field Description
    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: Name of the resource

    properties
    VirtualNetworkGateways_Spec_PropertiesARM

    Properties: Properties of the virtual network gateway.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    VirtualNetworkGateways_Spec_PropertiesARM

    (Appears on:VirtualNetworkGateways_SpecARM)

    Field Description
    activeActive
    bool

    ActiveActive: ActiveActive flag.

    bgpSettings
    BgpSettingsARM

    BgpSettings: Virtual network gateway’s BGP speaker settings.

    customRoutes
    AddressSpaceARM

    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
    SubResourceARM

    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
    VirtualNetworkGatewaysSpecPropertiesGatewayType

    GatewayType: The type of this virtual network gateway.

    ipConfigurations
    []VirtualNetworkGateways_Spec_Properties_IpConfigurationsARM

    IpConfigurations: IP configurations for virtual network gateway.

    sku
    VirtualNetworkGatewaySkuARM

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

    vNetExtendedLocationResourceId
    string
    virtualNetworkExtendedLocation
    ExtendedLocationARM

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

    vpnClientConfiguration
    VirtualNetworkGateways_Spec_Properties_VpnClientConfigurationARM

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

    vpnGatewayGeneration
    VirtualNetworkGatewaysSpecPropertiesVpnGatewayGeneration

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

    vpnType
    VirtualNetworkGatewaysSpecPropertiesVpnType

    VpnType: The type of this virtual network gateway.

    VirtualNetworkGateways_Spec_Properties_IpConfigurations

    (Appears on:VirtualNetworkGateways_Spec)

    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
    VirtualNetworkGatewayIPConfigurationPropertiesFormatPrivateIPAllocationMethod

    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.

    VirtualNetworkGateways_Spec_Properties_IpConfigurationsARM

    (Appears on:VirtualNetworkGateways_Spec_PropertiesARM)

    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
    VirtualNetworkGatewayIPConfigurationPropertiesFormatARM

    Properties: Properties of the virtual network gateway ip configuration.

    VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration

    (Appears on:VirtualNetworkGateways_Spec)

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

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

    VpnClientProtocols: VpnClientProtocols for Virtual network gateway.

    vpnClientRevokedCertificates
    []VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration_VpnClientRevokedCertificates

    VpnClientRevokedCertificates: VpnClientRevokedCertificate for Virtual network gateway.

    vpnClientRootCertificates
    []VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration_VpnClientRootCertificates

    VpnClientRootCertificates: VpnClientRootCertificate for virtual network gateway.

    VirtualNetworkGateways_Spec_Properties_VpnClientConfigurationARM

    (Appears on:VirtualNetworkGateways_Spec_PropertiesARM)

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

    RadiusServers: The radiusServers property for multiple radius server configuration.

    vpnAuthenticationTypes
    []VirtualNetworkGatewaysSpecPropertiesVpnClientConfigurationVpnAuthenticationTypes

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

    vpnClientAddressPool
    AddressSpaceARM

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

    vpnClientIpsecPolicies
    []IpsecPolicyARM

    VpnClientIpsecPolicies: VpnClientIpsecPolicies for virtual network gateway P2S client.

    vpnClientProtocols
    []VirtualNetworkGatewaysSpecPropertiesVpnClientConfigurationVpnClientProtocols

    VpnClientProtocols: VpnClientProtocols for Virtual network gateway.

    vpnClientRevokedCertificates
    []VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration_VpnClientRevokedCertificatesARM

    VpnClientRevokedCertificates: VpnClientRevokedCertificate for Virtual network gateway.

    vpnClientRootCertificates
    []VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration_VpnClientRootCertificatesARM

    VpnClientRootCertificates: VpnClientRootCertificate for virtual network gateway.

    VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration_VpnClientRevokedCertificates

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration)

    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.

    VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration_VpnClientRevokedCertificatesARM

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfigurationARM)

    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
    VpnClientRevokedCertificatePropertiesFormatARM

    Properties: Properties of the vpn client revoked certificate.

    VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration_VpnClientRootCertificates

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration)

    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.

    VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration_VpnClientRootCertificatesARM

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfigurationARM)

    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
    VpnClientRootCertificatePropertiesFormatARM

    Properties: Properties of the vpn client root certificate.

    VirtualNetworkPeeringPropertiesFormatARM

    (Appears on:VirtualNetworksVirtualNetworkPeerings_SpecARM, VirtualNetworks_Spec_Properties_VirtualNetworkPeeringsARM)

    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.

    peeringState
    VirtualNetworkPeeringPropertiesFormatPeeringState

    PeeringState: The status of the virtual network peering.

    remoteAddressSpace
    AddressSpaceARM

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

    remoteBgpCommunities
    VirtualNetworkBgpCommunitiesARM

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

    remoteVirtualNetwork
    SubResourceARM

    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.

    VirtualNetworkPeeringPropertiesFormatPeeringState (string alias)

    (Appears on:VirtualNetworkPeeringPropertiesFormatARM, VirtualNetworksVirtualNetworkPeerings_Spec)

    Value Description

    "Connected"

    "Disconnected"

    "Initiated"

    VirtualNetworkPeeringPropertiesFormatStatusPeeringState (string alias)

    (Appears on:VirtualNetworkPeeringPropertiesFormat_StatusARM, VirtualNetworkPeering_Status)

    Value Description

    "Connected"

    "Disconnected"

    "Initiated"

    VirtualNetworkPeeringPropertiesFormat_StatusARM

    (Appears on:VirtualNetworkPeering_StatusARM)

    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
    VirtualNetworkPeeringPropertiesFormatStatusPeeringState

    PeeringState: The status of the virtual network peering.

    provisioningState
    ProvisioningState_Status

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

    remoteAddressSpace
    AddressSpace_StatusARM

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

    remoteBgpCommunities
    VirtualNetworkBgpCommunities_StatusARM

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

    remoteVirtualNetwork
    SubResource_StatusARM

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

    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.

    VirtualNetworkPeering_StatusARM

    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_StatusARM

    Properties: Properties of the virtual network peering.

    type
    string

    Type: Resource type.

    VirtualNetworkPropertiesFormat_StatusARM

    (Appears on:VirtualNetwork_StatusARM)

    Field Description
    addressSpace
    AddressSpace_StatusARM

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

    bgpCommunities
    VirtualNetworkBgpCommunities_StatusARM

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

    ddosProtectionPlan
    SubResource_StatusARM

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

    dhcpOptions
    DhcpOptions_StatusARM

    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_StatusARM

    IpAllocations: Array of IpAllocation which reference this VNET.

    provisioningState
    ProvisioningState_Status

    ProvisioningState: The provisioning state of the virtual network resource.

    resourceGuid
    string

    ResourceGuid: The resourceGuid property of the Virtual Network resource.

    VirtualNetworkTap_Status_NetworkInterface_SubResourceEmbedded

    (Appears on:NetworkInterfaceIPConfiguration_Status_NetworkInterface_SubResourceEmbedded)

    Field Description
    id
    string

    Id: Resource ID.

    VirtualNetworkTap_Status_NetworkInterface_SubResourceEmbeddedARM

    (Appears on:NetworkInterfaceIPConfigurationPropertiesFormat_Status_NetworkInterface_SubResourceEmbeddedARM)

    Field Description
    id
    string

    Id: Resource ID.

    VirtualNetwork_Status

    (Appears on:VirtualNetwork)

    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_StatusARM

    Field Description
    etag
    string

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

    extendedLocation
    ExtendedLocation_StatusARM

    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_StatusARM

    Properties: Properties of the virtual network.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    VirtualNetworksSpecAPIVersion (string alias)

    Value Description

    "2020-11-01"

    VirtualNetworksSubnet

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


    addressPrefix
    string

    AddressPrefix: The address prefix for the subnet.

    addressPrefixes
    []string

    AddressPrefixes: List of address prefixes for the subnet.

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

    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
    SubResource

    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
    string

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

    privateLinkServiceNetworkPolicies
    string

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

    routeTable
    SubResource

    RouteTable: The reference to the RouteTable resource.

    serviceEndpointPolicies
    []SubResource

    ServiceEndpointPolicies: An array of service endpoint policies.

    serviceEndpoints
    []ServiceEndpointPropertiesFormat

    ServiceEndpoints: An array of service endpoints.

    status
    Subnet_Status_VirtualNetworksSubnet_SubResourceEmbedded

    VirtualNetworksSubnetsSpecAPIVersion (string alias)

    Value Description

    "2020-11-01"

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

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

    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
    SubResource

    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
    string

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

    privateLinkServiceNetworkPolicies
    string

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

    routeTable
    SubResource

    RouteTable: The reference to the RouteTable resource.

    serviceEndpointPolicies
    []SubResource

    ServiceEndpointPolicies: An array of service endpoint policies.

    serviceEndpoints
    []ServiceEndpointPropertiesFormat

    ServiceEndpoints: An array of service endpoints.

    VirtualNetworksSubnets_SpecARM

    Field Description
    name
    string

    Name: Name of the resource

    properties
    VirtualNetworksSubnets_Spec_PropertiesARM

    Properties: Properties of the subnet.

    VirtualNetworksSubnets_Spec_PropertiesARM

    (Appears on:VirtualNetworksSubnets_SpecARM)

    Field Description
    addressPrefix
    string

    AddressPrefix: The address prefix for the subnet.

    addressPrefixes
    []string

    AddressPrefixes: List of address prefixes for the subnet.

    delegations
    []VirtualNetworksSubnets_Spec_Properties_DelegationsARM

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

    ipAllocations
    []SubResourceARM

    IpAllocations: Array of IpAllocation which reference this subnet.

    natGateway
    SubResourceARM

    NatGateway: Nat gateway associated with this subnet.

    networkSecurityGroup
    SubResourceARM

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    privateEndpointNetworkPolicies
    string

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

    privateLinkServiceNetworkPolicies
    string

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

    routeTable
    SubResourceARM

    RouteTable: The reference to the RouteTable resource.

    serviceEndpointPolicies
    []SubResourceARM

    ServiceEndpointPolicies: An array of service endpoint policies.

    serviceEndpoints
    []ServiceEndpointPropertiesFormatARM

    ServiceEndpoints: An array of service endpoints.

    VirtualNetworksSubnets_Spec_Properties_Delegations

    (Appears on:VirtualNetworksSubnets_Spec)

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

    VirtualNetworksSubnets_Spec_Properties_DelegationsARM

    (Appears on:VirtualNetworksSubnets_Spec_PropertiesARM)

    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
    ServiceDelegationPropertiesFormatARM

    Properties: Properties of the subnet.

    VirtualNetworksVirtualNetworkPeering

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    VirtualNetworksVirtualNetworkPeerings_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.

    location
    string

    Location: Location to deploy resource 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/VirtualNetwork resource

    peeringState
    VirtualNetworkPeeringPropertiesFormatPeeringState

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

    tags
    map[string]string

    Tags: Name-value pairs to add to the 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.

    status
    VirtualNetworkPeering_Status

    VirtualNetworksVirtualNetworkPeeringsSpecAPIVersion (string alias)

    Value Description

    "2020-11-01"

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

    location
    string

    Location: Location to deploy resource 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/VirtualNetwork resource

    peeringState
    VirtualNetworkPeeringPropertiesFormatPeeringState

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

    tags
    map[string]string

    Tags: Name-value pairs to add to the 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.

    VirtualNetworksVirtualNetworkPeerings_SpecARM

    Field Description
    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: Name of the resource

    properties
    VirtualNetworkPeeringPropertiesFormatARM

    Properties: Properties of the virtual network peering.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    VirtualNetworks_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: Location to deploy resource 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 resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    VirtualNetworks_SpecARM

    Field Description
    extendedLocation
    ExtendedLocationARM

    ExtendedLocation: The extended location of the virtual network.

    location
    string

    Location: Location to deploy resource to

    name
    string

    Name: Name of the resource

    properties
    VirtualNetworks_Spec_PropertiesARM

    Properties: Properties of the virtual network.

    tags
    map[string]string

    Tags: Name-value pairs to add to the resource

    VirtualNetworks_Spec_PropertiesARM

    (Appears on:VirtualNetworks_SpecARM)

    Field Description
    addressSpace
    AddressSpaceARM

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

    bgpCommunities
    VirtualNetworkBgpCommunitiesARM

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

    ddosProtectionPlan
    SubResourceARM

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

    dhcpOptions
    DhcpOptionsARM

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

    IpAllocations: Array of IpAllocation which reference this VNET.

    subnets
    []VirtualNetworks_Spec_Properties_SubnetsARM

    Subnets: A list of subnets in a Virtual Network.

    virtualNetworkPeerings
    []VirtualNetworks_Spec_Properties_VirtualNetworkPeeringsARM

    VirtualNetworkPeerings: A list of peerings in a Virtual Network.

    VirtualNetworks_Spec_Properties_SubnetsARM

    (Appears on:VirtualNetworks_Spec_PropertiesARM)

    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
    VirtualNetworks_Spec_Properties_Subnets_PropertiesARM

    Properties: Properties of the subnet.

    VirtualNetworks_Spec_Properties_Subnets_PropertiesARM

    (Appears on:VirtualNetworks_Spec_Properties_SubnetsARM)

    Field Description
    addressPrefix
    string

    AddressPrefix: The address prefix for the subnet.

    addressPrefixes
    []string

    AddressPrefixes: List of address prefixes for the subnet.

    delegations
    []VirtualNetworks_Spec_Properties_Subnets_Properties_DelegationsARM

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

    ipAllocations
    []SubResourceARM

    IpAllocations: Array of IpAllocation which reference this subnet.

    natGateway
    SubResourceARM

    NatGateway: Nat gateway associated with this subnet.

    networkSecurityGroup
    SubResourceARM

    NetworkSecurityGroup: The reference to the NetworkSecurityGroup resource.

    privateEndpointNetworkPolicies
    string

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

    privateLinkServiceNetworkPolicies
    string

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

    routeTable
    SubResourceARM

    RouteTable: The reference to the RouteTable resource.

    serviceEndpointPolicies
    []SubResourceARM

    ServiceEndpointPolicies: An array of service endpoint policies.

    serviceEndpoints
    []ServiceEndpointPropertiesFormatARM

    ServiceEndpoints: An array of service endpoints.

    VirtualNetworks_Spec_Properties_Subnets_Properties_DelegationsARM

    (Appears on:VirtualNetworks_Spec_Properties_Subnets_PropertiesARM)

    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
    ServiceDelegationPropertiesFormatARM

    Properties: Properties of the subnet.

    VirtualNetworks_Spec_Properties_VirtualNetworkPeeringsARM

    (Appears on:VirtualNetworks_Spec_PropertiesARM)

    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
    VirtualNetworkPeeringPropertiesFormatARM

    Properties: Properties of the virtual network peering.

    VpnClientConfigurationStatusVpnAuthenticationTypes (string alias)

    (Appears on:VpnClientConfiguration_Status, VpnClientConfiguration_StatusARM)

    Value Description

    "AAD"

    "Certificate"

    "Radius"

    VpnClientConfigurationStatusVpnClientProtocols (string alias)

    (Appears on:VpnClientConfiguration_Status, VpnClientConfiguration_StatusARM)

    Value Description

    "IkeV2"

    "OpenVPN"

    "SSTP"

    VpnClientConfiguration_Status

    (Appears on:VirtualNetworkGateway_Status)

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

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

    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_StatusARM

    (Appears on:VirtualNetworkGatewayPropertiesFormat_StatusARM)

    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_StatusARM

    RadiusServers: The radiusServers property for multiple radius server configuration.

    vpnAuthenticationTypes
    []VpnClientConfigurationStatusVpnAuthenticationTypes

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

    vpnClientAddressPool
    AddressSpace_StatusARM

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

    vpnClientIpsecPolicies
    []IpsecPolicy_StatusARM

    VpnClientIpsecPolicies: VpnClientIpsecPolicies for virtual network gateway P2S client.

    vpnClientProtocols
    []VpnClientConfigurationStatusVpnClientProtocols

    VpnClientProtocols: VpnClientProtocols for Virtual network gateway.

    vpnClientRevokedCertificates
    []VpnClientRevokedCertificate_StatusARM

    VpnClientRevokedCertificates: VpnClientRevokedCertificate for Virtual network gateway.

    vpnClientRootCertificates
    []VpnClientRootCertificate_StatusARM

    VpnClientRootCertificates: VpnClientRootCertificate for virtual network gateway.

    VpnClientRevokedCertificatePropertiesFormatARM

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration_VpnClientRevokedCertificatesARM)

    Field Description
    thumbprint
    string

    Thumbprint: The revoked VPN client certificate thumbprint.

    VpnClientRevokedCertificatePropertiesFormat_StatusARM

    (Appears on:VpnClientRevokedCertificate_StatusARM)

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

    (Appears on:VpnClientConfiguration_Status)

    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_StatusARM

    (Appears on:VpnClientConfiguration_StatusARM)

    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_StatusARM

    Properties: Properties of the vpn client revoked certificate.

    VpnClientRootCertificatePropertiesFormatARM

    (Appears on:VirtualNetworkGateways_Spec_Properties_VpnClientConfiguration_VpnClientRootCertificatesARM)

    Field Description
    publicCertData
    string

    PublicCertData: The certificate public data.

    VpnClientRootCertificatePropertiesFormat_StatusARM

    (Appears on:VpnClientRootCertificate_StatusARM)

    Field Description
    provisioningState
    ProvisioningState_Status

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

    publicCertData
    string

    PublicCertData: The certificate public data.

    VpnClientRootCertificate_Status

    (Appears on:VpnClientConfiguration_Status)

    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_StatusARM

    (Appears on:VpnClientConfiguration_StatusARM)

    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_StatusARM

    Properties: Properties of the vpn client root certificate.