network.azure.com/v1api20220701

network.azure.com/v1api20220701

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

Resource Types:

    APIVersion (string alias)

    Value Description

    "2022-07-01"

    ApplicationGateway

    Generator information: - Generated from: /network/resource-manager/Microsoft.Network/stable/2022-07-01/applicationGateway.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​applicationGateways/​{applicationGatewayName}

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


    authenticationCertificates
    []ApplicationGatewayAuthenticationCertificate

    AuthenticationCertificates: Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits.

    autoscaleConfiguration
    ApplicationGatewayAutoscaleConfiguration

    AutoscaleConfiguration: Autoscale Configuration.

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

    BackendAddressPools: Backend address pool of the application gateway resource. For default limits, see Application Gateway limits.

    backendHttpSettingsCollection
    []ApplicationGatewayBackendHttpSettings

    BackendHttpSettingsCollection: Backend http settings of the application gateway resource. For default limits, see Application Gateway limits.

    backendSettingsCollection
    []ApplicationGatewayBackendSettings

    BackendSettingsCollection: Backend settings of the application gateway resource. For default limits, see Application Gateway limits.

    customErrorConfigurations
    []ApplicationGatewayCustomError

    CustomErrorConfigurations: Custom error configurations of the application gateway resource.

    enableFips
    bool

    EnableFips: Whether FIPS is enabled on the application gateway resource.

    enableHttp2
    bool

    EnableHttp2: Whether HTTP2 is enabled on the application gateway resource.

    firewallPolicy
    ApplicationGatewaySubResource

    FirewallPolicy: Reference to the FirewallPolicy resource.

    forceFirewallPolicyAssociation
    bool

    ForceFirewallPolicyAssociation: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.

    frontendIPConfigurations
    []ApplicationGatewayFrontendIPConfiguration

    FrontendIPConfigurations: Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits.

    frontendPorts
    []ApplicationGatewayFrontendPort

    FrontendPorts: Frontend ports of the application gateway resource. For default limits, see Application Gateway limits.

    gatewayIPConfigurations
    []ApplicationGatewayIPConfiguration_ApplicationGateway_SubResourceEmbedded

    GatewayIPConfigurations: Subnets of the application gateway resource. For default limits, see Application Gateway limits.

    globalConfiguration
    ApplicationGatewayGlobalConfiguration

    GlobalConfiguration: Global Configuration.

    httpListeners
    []ApplicationGatewayHttpListener

    HttpListeners: Http listeners of the application gateway resource. For default limits, see Application Gateway limits.

    identity
    ManagedServiceIdentity

    Identity: The identity of the application gateway, if configured.

    listeners
    []ApplicationGatewayListener

    Listeners: Listeners of the application gateway resource. For default limits, see Application Gateway limits.

    loadDistributionPolicies
    []ApplicationGatewayLoadDistributionPolicy

    LoadDistributionPolicies: Load distribution policies of the application gateway resource.

    location
    string

    Location: Resource location.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    privateLinkConfigurations
    []ApplicationGatewayPrivateLinkConfiguration

    PrivateLinkConfigurations: PrivateLink configurations on application gateway.

    probes
    []ApplicationGatewayProbe

    Probes: Probes of the application gateway resource.

    redirectConfigurations
    []ApplicationGatewayRedirectConfiguration

    RedirectConfigurations: Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits.

    requestRoutingRules
    []ApplicationGatewayRequestRoutingRule

    RequestRoutingRules: Request routing rules of the application gateway resource.

    rewriteRuleSets
    []ApplicationGatewayRewriteRuleSet

    RewriteRuleSets: Rewrite rules for the application gateway resource.

    routingRules
    []ApplicationGatewayRoutingRule

    RoutingRules: Routing rules of the application gateway resource.

    sku
    ApplicationGatewaySku

    Sku: SKU of the application gateway resource.

    sslCertificates
    []ApplicationGatewaySslCertificate

    SslCertificates: SSL certificates of the application gateway resource. For default limits, see Application Gateway limits.

    sslPolicy
    ApplicationGatewaySslPolicy

    SslPolicy: SSL policy of the application gateway resource.

    sslProfiles
    []ApplicationGatewaySslProfile

    SslProfiles: SSL profiles of the application gateway resource. For default limits, see Application Gateway limits.

    tags
    map[string]string

    Tags: Resource tags.

    trustedClientCertificates
    []ApplicationGatewayTrustedClientCertificate

    TrustedClientCertificates: Trusted client certificates of the application gateway resource. For default limits, see Application Gateway limits.

    trustedRootCertificates
    []ApplicationGatewayTrustedRootCertificate

    TrustedRootCertificates: Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits.

    urlPathMaps
    []ApplicationGatewayUrlPathMap

    UrlPathMaps: URL path map of the application gateway resource. For default limits, see Application Gateway limits.

    webApplicationFirewallConfiguration
    ApplicationGatewayWebApplicationFirewallConfiguration

    WebApplicationFirewallConfiguration: Web application firewall configuration.

    zones
    []string

    Zones: A list of availability zones denoting where the resource needs to come from.

    status
    ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded

    ApplicationGatewayAuthenticationCertificate

    (Appears on:ApplicationGateway_Spec)

    Authentication certificates of an application gateway.

    Field Description
    data
    genruntime.SecretReference

    Data: Certificate public data.

    name
    string

    Name: Name of the authentication certificate that is unique within an Application Gateway.

    ApplicationGatewayAuthenticationCertificatePropertiesFormat_ARM

    (Appears on:ApplicationGatewayAuthenticationCertificate_ARM)

    Authentication certificates properties of an application gateway.

    Field Description
    data
    string

    Data: Certificate public data.

    ApplicationGatewayAuthenticationCertificate_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Authentication certificates of an application gateway.

    Field Description
    name
    string

    Name: Name of the authentication certificate that is unique within an Application Gateway.

    properties
    ApplicationGatewayAuthenticationCertificatePropertiesFormat_ARM

    Properties: Properties of the application gateway authentication certificate.

    ApplicationGatewayAuthenticationCertificate_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Authentication certificates of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayAuthenticationCertificate_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Authentication certificates of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayAutoscaleConfiguration

    (Appears on:ApplicationGateway_Spec)

    Application Gateway autoscale configuration.

    Field Description
    maxCapacity
    int

    MaxCapacity: Upper bound on number of Application Gateway capacity.

    minCapacity
    int

    MinCapacity: Lower bound on number of Application Gateway capacity.

    ApplicationGatewayAutoscaleConfiguration_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Application Gateway autoscale configuration.

    Field Description
    maxCapacity
    int

    MaxCapacity: Upper bound on number of Application Gateway capacity.

    minCapacity
    int

    MinCapacity: Lower bound on number of Application Gateway capacity.

    ApplicationGatewayAutoscaleConfiguration_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Application Gateway autoscale configuration.

    Field Description
    maxCapacity
    int

    MaxCapacity: Upper bound on number of Application Gateway capacity.

    minCapacity
    int

    MinCapacity: Lower bound on number of Application Gateway capacity.

    ApplicationGatewayAutoscaleConfiguration_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Application Gateway autoscale configuration.

    Field Description
    maxCapacity
    int

    MaxCapacity: Upper bound on number of Application Gateway capacity.

    minCapacity
    int

    MinCapacity: Lower bound on number of Application Gateway capacity.

    ApplicationGatewayBackendAddress

    (Appears on:ApplicationGatewayBackendAddressPool)

    Backend address of an application gateway.

    Field Description
    fqdn
    string

    Fqdn: Fully qualified domain name (FQDN).

    ipAddress
    string

    IpAddress: IP address.

    ApplicationGatewayBackendAddressPool

    (Appears on:ApplicationGateway_Spec)

    Backend Address Pool of an application gateway.

    Field Description
    backendAddresses
    []ApplicationGatewayBackendAddress

    BackendAddresses: Backend addresses.

    name
    string

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

    ApplicationGatewayBackendAddressPoolPropertiesFormat_ARM

    (Appears on:ApplicationGatewayBackendAddressPool_ARM)

    Properties of Backend Address Pool of an application gateway.

    Field Description
    backendAddresses
    []ApplicationGatewayBackendAddress_ARM

    BackendAddresses: Backend addresses.

    ApplicationGatewayBackendAddressPool_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Backend Address Pool of an application gateway.

    Field Description
    name
    string

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

    properties
    ApplicationGatewayBackendAddressPoolPropertiesFormat_ARM

    Properties: Properties of the application gateway backend address pool.

    ApplicationGatewayBackendAddressPool_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Backend Address Pool of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayBackendAddressPool_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Backend Address Pool of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayBackendAddress_ARM

    (Appears on:ApplicationGatewayBackendAddressPoolPropertiesFormat_ARM)

    Backend address of an application gateway.

    Field Description
    fqdn
    string

    Fqdn: Fully qualified domain name (FQDN).

    ipAddress
    string

    IpAddress: IP address.

    ApplicationGatewayBackendHttpSettings

    (Appears on:ApplicationGateway_Spec)

    Backend address pool settings of an application gateway.

    Field Description
    affinityCookieName
    string

    AffinityCookieName: Cookie name to use for the affinity cookie.

    authenticationCertificates
    []ApplicationGatewaySubResource

    AuthenticationCertificates: Array of references to application gateway authentication certificates.

    connectionDraining
    ApplicationGatewayConnectionDraining

    ConnectionDraining: Connection draining of the backend http settings resource.

    cookieBasedAffinity
    ApplicationGatewayBackendHttpSettingsPropertiesFormat_CookieBasedAffinity

    CookieBasedAffinity: Cookie based affinity.

    hostName
    string

    HostName: Host header to be sent to the backend servers.

    name
    string

    Name: Name of the backend http settings that is unique within an Application Gateway.

    path
    string

    Path: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.

    pickHostNameFromBackendAddress
    bool

    PickHostNameFromBackendAddress: Whether to pick host header should be picked from the host name of the backend server. Default value is false.

    port
    int

    Port: The destination port on the backend.

    probe
    ApplicationGatewaySubResource

    Probe: Probe resource of an application gateway.

    probeEnabled
    bool

    ProbeEnabled: Whether the probe is enabled. Default value is false.

    protocol
    ApplicationGatewayProtocol

    Protocol: The protocol used to communicate with the backend.

    requestTimeout
    int

    RequestTimeout: Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.

    trustedRootCertificates
    []ApplicationGatewaySubResource

    TrustedRootCertificates: Array of references to application gateway trusted root certificates.

    ApplicationGatewayBackendHttpSettingsPropertiesFormat_ARM

    (Appears on:ApplicationGatewayBackendHttpSettings_ARM)

    Properties of Backend address pool settings of an application gateway.

    Field Description
    affinityCookieName
    string

    AffinityCookieName: Cookie name to use for the affinity cookie.

    authenticationCertificates
    []ApplicationGatewaySubResource_ARM

    AuthenticationCertificates: Array of references to application gateway authentication certificates.

    connectionDraining
    ApplicationGatewayConnectionDraining_ARM

    ConnectionDraining: Connection draining of the backend http settings resource.

    cookieBasedAffinity
    ApplicationGatewayBackendHttpSettingsPropertiesFormat_CookieBasedAffinity

    CookieBasedAffinity: Cookie based affinity.

    hostName
    string

    HostName: Host header to be sent to the backend servers.

    path
    string

    Path: Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.

    pickHostNameFromBackendAddress
    bool

    PickHostNameFromBackendAddress: Whether to pick host header should be picked from the host name of the backend server. Default value is false.

    port
    int

    Port: The destination port on the backend.

    probe
    ApplicationGatewaySubResource_ARM

    Probe: Probe resource of an application gateway.

    probeEnabled
    bool

    ProbeEnabled: Whether the probe is enabled. Default value is false.

    protocol
    ApplicationGatewayProtocol

    Protocol: The protocol used to communicate with the backend.

    requestTimeout
    int

    RequestTimeout: Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.

    trustedRootCertificates
    []ApplicationGatewaySubResource_ARM

    TrustedRootCertificates: Array of references to application gateway trusted root certificates.

    ApplicationGatewayBackendHttpSettingsPropertiesFormat_CookieBasedAffinity (string alias)

    (Appears on:ApplicationGatewayBackendHttpSettings, ApplicationGatewayBackendHttpSettingsPropertiesFormat_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ApplicationGatewayBackendHttpSettings_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Backend address pool settings of an application gateway.

    Field Description
    name
    string

    Name: Name of the backend http settings that is unique within an Application Gateway.

    properties
    ApplicationGatewayBackendHttpSettingsPropertiesFormat_ARM

    Properties: Properties of the application gateway backend HTTP settings.

    ApplicationGatewayBackendHttpSettings_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Backend address pool settings of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayBackendHttpSettings_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Backend address pool settings of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayBackendSettings

    (Appears on:ApplicationGateway_Spec)

    Backend address pool settings of an application gateway.

    Field Description
    hostName
    string

    HostName: Server name indication to be sent to the backend servers for Tls protocol.

    name
    string

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

    pickHostNameFromBackendAddress
    bool

    PickHostNameFromBackendAddress: Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false.

    port
    int

    Port: The destination port on the backend.

    probe
    ApplicationGatewaySubResource

    Probe: Probe resource of an application gateway.

    protocol
    ApplicationGatewayProtocol

    Protocol: The protocol used to communicate with the backend.

    timeout
    int

    Timeout: Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds.

    trustedRootCertificates
    []ApplicationGatewaySubResource

    TrustedRootCertificates: Array of references to application gateway trusted root certificates.

    ApplicationGatewayBackendSettingsPropertiesFormat_ARM

    (Appears on:ApplicationGatewayBackendSettings_ARM)

    Properties of Backend address pool settings of an application gateway.

    Field Description
    hostName
    string

    HostName: Server name indication to be sent to the backend servers for Tls protocol.

    pickHostNameFromBackendAddress
    bool

    PickHostNameFromBackendAddress: Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false.

    port
    int

    Port: The destination port on the backend.

    probe
    ApplicationGatewaySubResource_ARM

    Probe: Probe resource of an application gateway.

    protocol
    ApplicationGatewayProtocol

    Protocol: The protocol used to communicate with the backend.

    timeout
    int

    Timeout: Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds.

    trustedRootCertificates
    []ApplicationGatewaySubResource_ARM

    TrustedRootCertificates: Array of references to application gateway trusted root certificates.

    ApplicationGatewayBackendSettings_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Backend address pool settings of an application gateway.

    Field Description
    name
    string

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

    properties
    ApplicationGatewayBackendSettingsPropertiesFormat_ARM

    Properties: Properties of the application gateway backend settings.

    ApplicationGatewayBackendSettings_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Backend address pool settings of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayBackendSettings_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Backend address pool settings of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayClientAuthConfiguration

    (Appears on:ApplicationGatewaySslProfile)

    Application gateway client authentication configuration.

    Field Description
    verifyClientCertIssuerDN
    bool

    VerifyClientCertIssuerDN: Verify client certificate issuer name on the application gateway.

    verifyClientRevocation
    ApplicationGatewayClientAuthConfiguration_VerifyClientRevocation

    VerifyClientRevocation: Verify client certificate revocation status.

    ApplicationGatewayClientAuthConfiguration_ARM

    (Appears on:ApplicationGatewaySslProfilePropertiesFormat_ARM)

    Application gateway client authentication configuration.

    Field Description
    verifyClientCertIssuerDN
    bool

    VerifyClientCertIssuerDN: Verify client certificate issuer name on the application gateway.

    verifyClientRevocation
    ApplicationGatewayClientAuthConfiguration_VerifyClientRevocation

    VerifyClientRevocation: Verify client certificate revocation status.

    ApplicationGatewayClientAuthConfiguration_VerifyClientRevocation (string alias)

    (Appears on:ApplicationGatewayClientAuthConfiguration, ApplicationGatewayClientAuthConfiguration_ARM)

    Value Description

    "None"

    "OCSP"

    ApplicationGatewayConnectionDraining

    (Appears on:ApplicationGatewayBackendHttpSettings)

    Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.

    Field Description
    drainTimeoutInSec
    int

    DrainTimeoutInSec: The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.

    enabled
    bool

    Enabled: Whether connection draining is enabled or not.

    ApplicationGatewayConnectionDraining_ARM

    (Appears on:ApplicationGatewayBackendHttpSettingsPropertiesFormat_ARM)

    Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.

    Field Description
    drainTimeoutInSec
    int

    DrainTimeoutInSec: The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.

    enabled
    bool

    Enabled: Whether connection draining is enabled or not.

    ApplicationGatewayCustomError

    (Appears on:ApplicationGatewayHttpListener, ApplicationGateway_Spec)

    Customer error of an application gateway.

    Field Description
    customErrorPageUrl
    string

    CustomErrorPageUrl: Error page URL of the application gateway customer error.

    statusCode
    ApplicationGatewayCustomError_StatusCode

    StatusCode: Status code of the application gateway customer error.

    ApplicationGatewayCustomError_ARM

    (Appears on:ApplicationGatewayHttpListenerPropertiesFormat_ARM, ApplicationGatewayPropertiesFormat_ARM)

    Customer error of an application gateway.

    Field Description
    customErrorPageUrl
    string

    CustomErrorPageUrl: Error page URL of the application gateway customer error.

    statusCode
    ApplicationGatewayCustomError_StatusCode

    StatusCode: Status code of the application gateway customer error.

    ApplicationGatewayCustomError_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Customer error of an application gateway.

    Field Description
    customErrorPageUrl
    string

    CustomErrorPageUrl: Error page URL of the application gateway customer error.

    statusCode
    ApplicationGatewayCustomError_StatusCode_STATUS

    StatusCode: Status code of the application gateway customer error.

    ApplicationGatewayCustomError_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Customer error of an application gateway.

    Field Description
    customErrorPageUrl
    string

    CustomErrorPageUrl: Error page URL of the application gateway customer error.

    statusCode
    ApplicationGatewayCustomError_StatusCode_STATUS

    StatusCode: Status code of the application gateway customer error.

    ApplicationGatewayCustomError_StatusCode (string alias)

    (Appears on:ApplicationGatewayCustomError, ApplicationGatewayCustomError_ARM)

    Value Description

    "HttpStatus403"

    "HttpStatus502"

    ApplicationGatewayCustomError_StatusCode_STATUS (string alias)

    (Appears on:ApplicationGatewayCustomError_STATUS, ApplicationGatewayCustomError_STATUS_ARM)

    Value Description

    "HttpStatus403"

    "HttpStatus502"

    ApplicationGatewayFirewallDisabledRuleGroup

    (Appears on:ApplicationGatewayWebApplicationFirewallConfiguration)

    Allows to disable rules within a rule group or an entire rule group.

    Field Description
    ruleGroupName
    string

    RuleGroupName: The name of the rule group that will be disabled.

    rules
    []int

    Rules: The list of rules that will be disabled. If null, all rules of the rule group will be disabled.

    ApplicationGatewayFirewallDisabledRuleGroup_ARM

    (Appears on:ApplicationGatewayWebApplicationFirewallConfiguration_ARM)

    Allows to disable rules within a rule group or an entire rule group.

    Field Description
    ruleGroupName
    string

    RuleGroupName: The name of the rule group that will be disabled.

    rules
    []int

    Rules: The list of rules that will be disabled. If null, all rules of the rule group will be disabled.

    ApplicationGatewayFirewallDisabledRuleGroup_STATUS

    (Appears on:ApplicationGatewayWebApplicationFirewallConfiguration_STATUS)

    Allows to disable rules within a rule group or an entire rule group.

    Field Description
    ruleGroupName
    string

    RuleGroupName: The name of the rule group that will be disabled.

    rules
    []int

    Rules: The list of rules that will be disabled. If null, all rules of the rule group will be disabled.

    ApplicationGatewayFirewallDisabledRuleGroup_STATUS_ARM

    (Appears on:ApplicationGatewayWebApplicationFirewallConfiguration_STATUS_ARM)

    Allows to disable rules within a rule group or an entire rule group.

    Field Description
    ruleGroupName
    string

    RuleGroupName: The name of the rule group that will be disabled.

    rules
    []int

    Rules: The list of rules that will be disabled. If null, all rules of the rule group will be disabled.

    ApplicationGatewayFirewallExclusion

    (Appears on:ApplicationGatewayWebApplicationFirewallConfiguration)

    Allow to exclude some variable satisfy the condition for the WAF check.

    Field Description
    matchVariable
    string

    MatchVariable: The variable to be excluded.

    selector
    string

    Selector: When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.

    selectorMatchOperator
    string

    SelectorMatchOperator: When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.

    ApplicationGatewayFirewallExclusion_ARM

    (Appears on:ApplicationGatewayWebApplicationFirewallConfiguration_ARM)

    Allow to exclude some variable satisfy the condition for the WAF check.

    Field Description
    matchVariable
    string

    MatchVariable: The variable to be excluded.

    selector
    string

    Selector: When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.

    selectorMatchOperator
    string

    SelectorMatchOperator: When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.

    ApplicationGatewayFirewallExclusion_STATUS

    (Appears on:ApplicationGatewayWebApplicationFirewallConfiguration_STATUS)

    Allow to exclude some variable satisfy the condition for the WAF check.

    Field Description
    matchVariable
    string

    MatchVariable: The variable to be excluded.

    selector
    string

    Selector: When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.

    selectorMatchOperator
    string

    SelectorMatchOperator: When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.

    ApplicationGatewayFirewallExclusion_STATUS_ARM

    (Appears on:ApplicationGatewayWebApplicationFirewallConfiguration_STATUS_ARM)

    Allow to exclude some variable satisfy the condition for the WAF check.

    Field Description
    matchVariable
    string

    MatchVariable: The variable to be excluded.

    selector
    string

    Selector: When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.

    selectorMatchOperator
    string

    SelectorMatchOperator: When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.

    ApplicationGatewayFrontendIPConfiguration

    (Appears on:ApplicationGateway_Spec)

    Frontend IP configuration of an application gateway.

    Field Description
    name
    string

    Name: Name of the frontend IP configuration that is unique within an Application Gateway.

    privateIPAddress
    string

    PrivateIPAddress: PrivateIPAddress of the network interface IP Configuration.

    privateIPAllocationMethod
    IPAllocationMethod

    PrivateIPAllocationMethod: The private IP address allocation method.

    privateLinkConfiguration
    ApplicationGatewaySubResource

    PrivateLinkConfiguration: Reference to the application gateway private link configuration.

    publicIPAddress
    ApplicationGatewaySubResource

    PublicIPAddress: Reference to the PublicIP resource.

    subnet
    ApplicationGatewaySubResource

    Subnet: Reference to the subnet resource.

    ApplicationGatewayFrontendIPConfigurationPropertiesFormat_ARM

    (Appears on:ApplicationGatewayFrontendIPConfiguration_ARM)

    Properties of Frontend IP configuration of an application gateway.

    Field Description
    privateIPAddress
    string

    PrivateIPAddress: PrivateIPAddress of the network interface IP Configuration.

    privateIPAllocationMethod
    IPAllocationMethod

    PrivateIPAllocationMethod: The private IP address allocation method.

    privateLinkConfiguration
    ApplicationGatewaySubResource_ARM

    PrivateLinkConfiguration: Reference to the application gateway private link configuration.

    publicIPAddress
    ApplicationGatewaySubResource_ARM

    PublicIPAddress: Reference to the PublicIP resource.

    subnet
    ApplicationGatewaySubResource_ARM

    Subnet: Reference to the subnet resource.

    ApplicationGatewayFrontendIPConfiguration_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Frontend IP configuration of an application gateway.

    Field Description
    name
    string

    Name: Name of the frontend IP configuration that is unique within an Application Gateway.

    properties
    ApplicationGatewayFrontendIPConfigurationPropertiesFormat_ARM

    Properties: Properties of the application gateway frontend IP configuration.

    ApplicationGatewayFrontendIPConfiguration_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Frontend IP configuration of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayFrontendIPConfiguration_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Frontend IP configuration of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayFrontendPort

    (Appears on:ApplicationGateway_Spec)

    Frontend port of an application gateway.

    Field Description
    name
    string

    Name: Name of the frontend port that is unique within an Application Gateway.

    port
    int

    Port: Frontend port.

    ApplicationGatewayFrontendPortPropertiesFormat_ARM

    (Appears on:ApplicationGatewayFrontendPort_ARM)

    Properties of Frontend port of an application gateway.

    Field Description
    port
    int

    Port: Frontend port.

    ApplicationGatewayFrontendPort_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Frontend port of an application gateway.

    Field Description
    name
    string

    Name: Name of the frontend port that is unique within an Application Gateway.

    properties
    ApplicationGatewayFrontendPortPropertiesFormat_ARM

    Properties: Properties of the application gateway frontend port.

    ApplicationGatewayFrontendPort_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Frontend port of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayFrontendPort_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Frontend port of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayGlobalConfiguration

    (Appears on:ApplicationGateway_Spec)

    Application Gateway global configuration.

    Field Description
    enableRequestBuffering
    bool

    EnableRequestBuffering: Enable request buffering.

    enableResponseBuffering
    bool

    EnableResponseBuffering: Enable response buffering.

    ApplicationGatewayGlobalConfiguration_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Application Gateway global configuration.

    Field Description
    enableRequestBuffering
    bool

    EnableRequestBuffering: Enable request buffering.

    enableResponseBuffering
    bool

    EnableResponseBuffering: Enable response buffering.

    ApplicationGatewayGlobalConfiguration_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Application Gateway global configuration.

    Field Description
    enableRequestBuffering
    bool

    EnableRequestBuffering: Enable request buffering.

    enableResponseBuffering
    bool

    EnableResponseBuffering: Enable response buffering.

    ApplicationGatewayGlobalConfiguration_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Application Gateway global configuration.

    Field Description
    enableRequestBuffering
    bool

    EnableRequestBuffering: Enable request buffering.

    enableResponseBuffering
    bool

    EnableResponseBuffering: Enable response buffering.

    ApplicationGatewayHeaderConfiguration

    (Appears on:ApplicationGatewayRewriteRuleActionSet)

    Header configuration of the Actions set in Application Gateway.

    Field Description
    headerName
    string

    HeaderName: Header name of the header configuration.

    headerValue
    string

    HeaderValue: Header value of the header configuration.

    ApplicationGatewayHeaderConfiguration_ARM

    (Appears on:ApplicationGatewayRewriteRuleActionSet_ARM)

    Header configuration of the Actions set in Application Gateway.

    Field Description
    headerName
    string

    HeaderName: Header name of the header configuration.

    headerValue
    string

    HeaderValue: Header value of the header configuration.

    ApplicationGatewayHttpListener

    (Appears on:ApplicationGateway_Spec)

    Http listener of an application gateway.

    Field Description
    customErrorConfigurations
    []ApplicationGatewayCustomError

    CustomErrorConfigurations: Custom error configurations of the HTTP listener.

    firewallPolicy
    ApplicationGatewaySubResource

    FirewallPolicy: Reference to the FirewallPolicy resource.

    frontendIPConfiguration
    ApplicationGatewaySubResource

    FrontendIPConfiguration: Frontend IP configuration resource of an application gateway.

    frontendPort
    ApplicationGatewaySubResource

    FrontendPort: Frontend port resource of an application gateway.

    hostName
    string

    HostName: Host name of HTTP listener.

    hostNames
    []string

    HostNames: List of Host names for HTTP Listener that allows special wildcard characters as well.

    name
    string

    Name: Name of the HTTP listener that is unique within an Application Gateway.

    protocol
    ApplicationGatewayProtocol

    Protocol: Protocol of the HTTP listener.

    requireServerNameIndication
    bool

    RequireServerNameIndication: Applicable only if protocol is https. Enables SNI for multi-hosting.

    sslCertificate
    ApplicationGatewaySubResource

    SslCertificate: SSL certificate resource of an application gateway.

    sslProfile
    ApplicationGatewaySubResource

    SslProfile: SSL profile resource of the application gateway.

    ApplicationGatewayHttpListenerPropertiesFormat_ARM

    (Appears on:ApplicationGatewayHttpListener_ARM)

    Properties of HTTP listener of an application gateway.

    Field Description
    customErrorConfigurations
    []ApplicationGatewayCustomError_ARM

    CustomErrorConfigurations: Custom error configurations of the HTTP listener.

    firewallPolicy
    ApplicationGatewaySubResource_ARM

    FirewallPolicy: Reference to the FirewallPolicy resource.

    frontendIPConfiguration
    ApplicationGatewaySubResource_ARM

    FrontendIPConfiguration: Frontend IP configuration resource of an application gateway.

    frontendPort
    ApplicationGatewaySubResource_ARM

    FrontendPort: Frontend port resource of an application gateway.

    hostName
    string

    HostName: Host name of HTTP listener.

    hostNames
    []string

    HostNames: List of Host names for HTTP Listener that allows special wildcard characters as well.

    protocol
    ApplicationGatewayProtocol

    Protocol: Protocol of the HTTP listener.

    requireServerNameIndication
    bool

    RequireServerNameIndication: Applicable only if protocol is https. Enables SNI for multi-hosting.

    sslCertificate
    ApplicationGatewaySubResource_ARM

    SslCertificate: SSL certificate resource of an application gateway.

    sslProfile
    ApplicationGatewaySubResource_ARM

    SslProfile: SSL profile resource of the application gateway.

    ApplicationGatewayHttpListener_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Http listener of an application gateway.

    Field Description
    name
    string

    Name: Name of the HTTP listener that is unique within an Application Gateway.

    properties
    ApplicationGatewayHttpListenerPropertiesFormat_ARM

    Properties: Properties of the application gateway HTTP listener.

    ApplicationGatewayHttpListener_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Http listener of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayHttpListener_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Http listener of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayIPConfigurationPropertiesFormat_ARM

    (Appears on:ApplicationGatewayIPConfiguration_ApplicationGateway_SubResourceEmbedded_ARM)

    Properties of IP configuration of an application gateway.

    Field Description
    subnet
    ApplicationGatewaySubResource_ARM

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

    ApplicationGatewayIPConfiguration_ApplicationGateway_SubResourceEmbedded

    (Appears on:ApplicationGateway_Spec)

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

    Field Description
    name
    string

    Name: Name of the IP configuration that is unique within an Application Gateway.

    subnet
    ApplicationGatewaySubResource

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

    ApplicationGatewayIPConfiguration_ApplicationGateway_SubResourceEmbedded_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

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

    Field Description
    name
    string

    Name: Name of the IP configuration that is unique within an Application Gateway.

    properties
    ApplicationGatewayIPConfigurationPropertiesFormat_ARM

    Properties: Properties of the application gateway IP configuration.

    ApplicationGatewayIPConfiguration_STATUS_ApplicationGateway_SubResourceEmbedded

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

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

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayIPConfiguration_STATUS_ApplicationGateway_SubResourceEmbedded_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

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

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayListener

    (Appears on:ApplicationGateway_Spec)

    Listener of an application gateway.

    Field Description
    frontendIPConfiguration
    ApplicationGatewaySubResource

    FrontendIPConfiguration: Frontend IP configuration resource of an application gateway.

    frontendPort
    ApplicationGatewaySubResource

    FrontendPort: Frontend port resource of an application gateway.

    name
    string

    Name: Name of the listener that is unique within an Application Gateway.

    protocol
    ApplicationGatewayProtocol

    Protocol: Protocol of the listener.

    sslCertificate
    ApplicationGatewaySubResource

    SslCertificate: SSL certificate resource of an application gateway.

    sslProfile
    ApplicationGatewaySubResource

    SslProfile: SSL profile resource of the application gateway.

    ApplicationGatewayListenerPropertiesFormat_ARM

    (Appears on:ApplicationGatewayListener_ARM)

    Properties of listener of an application gateway.

    Field Description
    frontendIPConfiguration
    ApplicationGatewaySubResource_ARM

    FrontendIPConfiguration: Frontend IP configuration resource of an application gateway.

    frontendPort
    ApplicationGatewaySubResource_ARM

    FrontendPort: Frontend port resource of an application gateway.

    protocol
    ApplicationGatewayProtocol

    Protocol: Protocol of the listener.

    sslCertificate
    ApplicationGatewaySubResource_ARM

    SslCertificate: SSL certificate resource of an application gateway.

    sslProfile
    ApplicationGatewaySubResource_ARM

    SslProfile: SSL profile resource of the application gateway.

    ApplicationGatewayListener_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Listener of an application gateway.

    Field Description
    name
    string

    Name: Name of the listener that is unique within an Application Gateway.

    properties
    ApplicationGatewayListenerPropertiesFormat_ARM

    Properties: Properties of the application gateway listener.

    ApplicationGatewayListener_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Listener of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayListener_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Listener of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayLoadDistributionAlgorithmEnum (string alias)

    (Appears on:ApplicationGatewayLoadDistributionPolicy, ApplicationGatewayLoadDistributionPolicyPropertiesFormat_ARM)

    Load Distribution Algorithm enums.

    Value Description

    "IpHash"

    "LeastConnections"

    "RoundRobin"

    ApplicationGatewayLoadDistributionPolicy

    (Appears on:ApplicationGateway_Spec)

    Load Distribution Policy of an application gateway.

    Field Description
    loadDistributionAlgorithm
    ApplicationGatewayLoadDistributionAlgorithmEnum

    LoadDistributionAlgorithm: Load Distribution Targets resource of an application gateway.

    loadDistributionTargets
    []ApplicationGatewayLoadDistributionTarget

    LoadDistributionTargets: Load Distribution Targets resource of an application gateway.

    name
    string

    Name: Name of the load distribution policy that is unique within an Application Gateway.

    ApplicationGatewayLoadDistributionPolicyPropertiesFormat_ARM

    (Appears on:ApplicationGatewayLoadDistributionPolicy_ARM)

    Properties of Load Distribution Policy of an application gateway.

    Field Description
    loadDistributionAlgorithm
    ApplicationGatewayLoadDistributionAlgorithmEnum

    LoadDistributionAlgorithm: Load Distribution Targets resource of an application gateway.

    loadDistributionTargets
    []ApplicationGatewayLoadDistributionTarget_ARM

    LoadDistributionTargets: Load Distribution Targets resource of an application gateway.

    ApplicationGatewayLoadDistributionPolicy_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Load Distribution Policy of an application gateway.

    Field Description
    name
    string

    Name: Name of the load distribution policy that is unique within an Application Gateway.

    properties
    ApplicationGatewayLoadDistributionPolicyPropertiesFormat_ARM

    Properties: Properties of the application gateway load distribution policy.

    ApplicationGatewayLoadDistributionPolicy_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Load Distribution Policy of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayLoadDistributionPolicy_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Load Distribution Policy of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayLoadDistributionTarget

    (Appears on:ApplicationGatewayLoadDistributionPolicy)

    Load Distribution Target of an application gateway.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    ApplicationGatewayLoadDistributionTarget_ARM

    (Appears on:ApplicationGatewayLoadDistributionPolicyPropertiesFormat_ARM)

    Load Distribution Target of an application gateway.

    Field Description
    id
    string

    ApplicationGatewayPathRule

    (Appears on:ApplicationGatewayUrlPathMap)

    Path rule of URL path map of an application gateway.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    ApplicationGatewayPathRule_ARM

    (Appears on:ApplicationGatewayUrlPathMapPropertiesFormat_ARM)

    Path rule of URL path map of an application gateway.

    Field Description
    id
    string

    ApplicationGatewayPrivateEndpointConnection_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Private Endpoint connection on an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayPrivateEndpointConnection_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Private Endpoint connection on an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayPrivateLinkConfiguration

    (Appears on:ApplicationGateway_Spec)

    Private Link Configuration on an application gateway.

    Field Description
    ipConfigurations
    []ApplicationGatewayPrivateLinkIpConfiguration

    IpConfigurations: An array of application gateway private link ip configurations.

    name
    string

    Name: Name of the private link configuration that is unique within an Application Gateway.

    ApplicationGatewayPrivateLinkConfigurationProperties_ARM

    (Appears on:ApplicationGatewayPrivateLinkConfiguration_ARM)

    Properties of private link configuration on an application gateway.

    Field Description
    ipConfigurations
    []ApplicationGatewayPrivateLinkIpConfiguration_ARM

    IpConfigurations: An array of application gateway private link ip configurations.

    ApplicationGatewayPrivateLinkConfiguration_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Private Link Configuration on an application gateway.

    Field Description
    name
    string

    Name: Name of the private link configuration that is unique within an Application Gateway.

    properties
    ApplicationGatewayPrivateLinkConfigurationProperties_ARM

    Properties: Properties of the application gateway private link configuration.

    ApplicationGatewayPrivateLinkConfiguration_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Private Link Configuration on an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayPrivateLinkConfiguration_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Private Link Configuration on an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayPrivateLinkIpConfiguration

    (Appears on:ApplicationGatewayPrivateLinkConfiguration)

    The application gateway private link ip configuration.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    ApplicationGatewayPrivateLinkIpConfiguration_ARM

    (Appears on:ApplicationGatewayPrivateLinkConfigurationProperties_ARM)

    The application gateway private link ip configuration.

    Field Description
    id
    string

    ApplicationGatewayProbe

    (Appears on:ApplicationGateway_Spec)

    Probe of the application gateway.

    Field Description
    host
    string

    Host: Host name to send the probe to.

    interval
    int

    Interval: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.

    match
    ApplicationGatewayProbeHealthResponseMatch

    Match: Criterion for classifying a healthy probe response.

    minServers
    int

    MinServers: Minimum number of servers that are always marked healthy. Default value is 0.

    name
    string

    Name: Name of the probe that is unique within an Application Gateway.

    path
    string

    Path: Relative path of probe. Valid path starts from ‘/’. Probe is sent to ://:.

    pickHostNameFromBackendHttpSettings
    bool

    PickHostNameFromBackendHttpSettings: Whether the host header should be picked from the backend http settings. Default value is false.

    pickHostNameFromBackendSettings
    bool

    PickHostNameFromBackendSettings: Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false.

    port
    int

    Port: Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.

    protocol
    ApplicationGatewayProtocol

    Protocol: The protocol used for the probe.

    timeout
    int

    Timeout: The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

    unhealthyThreshold
    int

    UnhealthyThreshold: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.

    ApplicationGatewayProbeHealthResponseMatch

    (Appears on:ApplicationGatewayProbe)

    Application gateway probe health response match.

    Field Description
    body
    string

    Body: Body that must be contained in the health response. Default value is empty.

    statusCodes
    []string

    StatusCodes: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.

    ApplicationGatewayProbeHealthResponseMatch_ARM

    (Appears on:ApplicationGatewayProbePropertiesFormat_ARM)

    Application gateway probe health response match.

    Field Description
    body
    string

    Body: Body that must be contained in the health response. Default value is empty.

    statusCodes
    []string

    StatusCodes: Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.

    ApplicationGatewayProbePropertiesFormat_ARM

    (Appears on:ApplicationGatewayProbe_ARM)

    Properties of probe of an application gateway.

    Field Description
    host
    string

    Host: Host name to send the probe to.

    interval
    int

    Interval: The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.

    match
    ApplicationGatewayProbeHealthResponseMatch_ARM

    Match: Criterion for classifying a healthy probe response.

    minServers
    int

    MinServers: Minimum number of servers that are always marked healthy. Default value is 0.

    path
    string

    Path: Relative path of probe. Valid path starts from ‘/’. Probe is sent to ://:.

    pickHostNameFromBackendHttpSettings
    bool

    PickHostNameFromBackendHttpSettings: Whether the host header should be picked from the backend http settings. Default value is false.

    pickHostNameFromBackendSettings
    bool

    PickHostNameFromBackendSettings: Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false.

    port
    int

    Port: Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.

    protocol
    ApplicationGatewayProtocol

    Protocol: The protocol used for the probe.

    timeout
    int

    Timeout: The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

    unhealthyThreshold
    int

    UnhealthyThreshold: The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.

    ApplicationGatewayProbe_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Probe of the application gateway.

    Field Description
    name
    string

    Name: Name of the probe that is unique within an Application Gateway.

    properties
    ApplicationGatewayProbePropertiesFormat_ARM

    Properties: Properties of the application gateway probe.

    ApplicationGatewayProbe_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Probe of the application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayProbe_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Probe of the application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayPropertiesFormat_ARM

    (Appears on:ApplicationGateway_Spec_ARM)

    Properties of the application gateway.

    Field Description
    authenticationCertificates
    []ApplicationGatewayAuthenticationCertificate_ARM

    AuthenticationCertificates: Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits.

    autoscaleConfiguration
    ApplicationGatewayAutoscaleConfiguration_ARM

    AutoscaleConfiguration: Autoscale Configuration.

    backendAddressPools
    []ApplicationGatewayBackendAddressPool_ARM

    BackendAddressPools: Backend address pool of the application gateway resource. For default limits, see Application Gateway limits.

    backendHttpSettingsCollection
    []ApplicationGatewayBackendHttpSettings_ARM

    BackendHttpSettingsCollection: Backend http settings of the application gateway resource. For default limits, see Application Gateway limits.

    backendSettingsCollection
    []ApplicationGatewayBackendSettings_ARM

    BackendSettingsCollection: Backend settings of the application gateway resource. For default limits, see Application Gateway limits.

    customErrorConfigurations
    []ApplicationGatewayCustomError_ARM

    CustomErrorConfigurations: Custom error configurations of the application gateway resource.

    enableFips
    bool

    EnableFips: Whether FIPS is enabled on the application gateway resource.

    enableHttp2
    bool

    EnableHttp2: Whether HTTP2 is enabled on the application gateway resource.

    firewallPolicy
    ApplicationGatewaySubResource_ARM

    FirewallPolicy: Reference to the FirewallPolicy resource.

    forceFirewallPolicyAssociation
    bool

    ForceFirewallPolicyAssociation: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.

    frontendIPConfigurations
    []ApplicationGatewayFrontendIPConfiguration_ARM

    FrontendIPConfigurations: Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits.

    frontendPorts
    []ApplicationGatewayFrontendPort_ARM

    FrontendPorts: Frontend ports of the application gateway resource. For default limits, see Application Gateway limits.

    gatewayIPConfigurations
    []ApplicationGatewayIPConfiguration_ApplicationGateway_SubResourceEmbedded_ARM

    GatewayIPConfigurations: Subnets of the application gateway resource. For default limits, see Application Gateway limits.

    globalConfiguration
    ApplicationGatewayGlobalConfiguration_ARM

    GlobalConfiguration: Global Configuration.

    httpListeners
    []ApplicationGatewayHttpListener_ARM

    HttpListeners: Http listeners of the application gateway resource. For default limits, see Application Gateway limits.

    listeners
    []ApplicationGatewayListener_ARM

    Listeners: Listeners of the application gateway resource. For default limits, see Application Gateway limits.

    loadDistributionPolicies
    []ApplicationGatewayLoadDistributionPolicy_ARM

    LoadDistributionPolicies: Load distribution policies of the application gateway resource.

    privateLinkConfigurations
    []ApplicationGatewayPrivateLinkConfiguration_ARM

    PrivateLinkConfigurations: PrivateLink configurations on application gateway.

    probes
    []ApplicationGatewayProbe_ARM

    Probes: Probes of the application gateway resource.

    redirectConfigurations
    []ApplicationGatewayRedirectConfiguration_ARM

    RedirectConfigurations: Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits.

    requestRoutingRules
    []ApplicationGatewayRequestRoutingRule_ARM

    RequestRoutingRules: Request routing rules of the application gateway resource.

    rewriteRuleSets
    []ApplicationGatewayRewriteRuleSet_ARM

    RewriteRuleSets: Rewrite rules for the application gateway resource.

    routingRules
    []ApplicationGatewayRoutingRule_ARM

    RoutingRules: Routing rules of the application gateway resource.

    sku
    ApplicationGatewaySku_ARM

    Sku: SKU of the application gateway resource.

    sslCertificates
    []ApplicationGatewaySslCertificate_ARM

    SslCertificates: SSL certificates of the application gateway resource. For default limits, see Application Gateway limits.

    sslPolicy
    ApplicationGatewaySslPolicy_ARM

    SslPolicy: SSL policy of the application gateway resource.

    sslProfiles
    []ApplicationGatewaySslProfile_ARM

    SslProfiles: SSL profiles of the application gateway resource. For default limits, see Application Gateway limits.

    trustedClientCertificates
    []ApplicationGatewayTrustedClientCertificate_ARM

    TrustedClientCertificates: Trusted client certificates of the application gateway resource. For default limits, see Application Gateway limits.

    trustedRootCertificates
    []ApplicationGatewayTrustedRootCertificate_ARM

    TrustedRootCertificates: Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits.

    urlPathMaps
    []ApplicationGatewayUrlPathMap_ARM

    UrlPathMaps: URL path map of the application gateway resource. For default limits, see Application Gateway limits.

    webApplicationFirewallConfiguration
    ApplicationGatewayWebApplicationFirewallConfiguration_ARM

    WebApplicationFirewallConfiguration: Web application firewall configuration.

    ApplicationGatewayPropertiesFormat_OperationalState_STATUS (string alias)

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM, ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Value Description

    "Running"

    "Starting"

    "Stopped"

    "Stopping"

    ApplicationGatewayPropertiesFormat_STATUS_ARM

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded_ARM)

    Properties of the application gateway.

    Field Description
    authenticationCertificates
    []ApplicationGatewayAuthenticationCertificate_STATUS_ARM

    AuthenticationCertificates: Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits.

    autoscaleConfiguration
    ApplicationGatewayAutoscaleConfiguration_STATUS_ARM

    AutoscaleConfiguration: Autoscale Configuration.

    backendAddressPools
    []ApplicationGatewayBackendAddressPool_STATUS_ARM

    BackendAddressPools: Backend address pool of the application gateway resource. For default limits, see Application Gateway limits.

    backendHttpSettingsCollection
    []ApplicationGatewayBackendHttpSettings_STATUS_ARM

    BackendHttpSettingsCollection: Backend http settings of the application gateway resource. For default limits, see Application Gateway limits.

    backendSettingsCollection
    []ApplicationGatewayBackendSettings_STATUS_ARM

    BackendSettingsCollection: Backend settings of the application gateway resource. For default limits, see Application Gateway limits.

    customErrorConfigurations
    []ApplicationGatewayCustomError_STATUS_ARM

    CustomErrorConfigurations: Custom error configurations of the application gateway resource.

    enableFips
    bool

    EnableFips: Whether FIPS is enabled on the application gateway resource.

    enableHttp2
    bool

    EnableHttp2: Whether HTTP2 is enabled on the application gateway resource.

    firewallPolicy
    ApplicationGatewaySubResource_STATUS_ARM

    FirewallPolicy: Reference to the FirewallPolicy resource.

    forceFirewallPolicyAssociation
    bool

    ForceFirewallPolicyAssociation: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.

    frontendIPConfigurations
    []ApplicationGatewayFrontendIPConfiguration_STATUS_ARM

    FrontendIPConfigurations: Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits.

    frontendPorts
    []ApplicationGatewayFrontendPort_STATUS_ARM

    FrontendPorts: Frontend ports of the application gateway resource. For default limits, see Application Gateway limits.

    gatewayIPConfigurations
    []ApplicationGatewayIPConfiguration_STATUS_ApplicationGateway_SubResourceEmbedded_ARM

    GatewayIPConfigurations: Subnets of the application gateway resource. For default limits, see Application Gateway limits.

    globalConfiguration
    ApplicationGatewayGlobalConfiguration_STATUS_ARM

    GlobalConfiguration: Global Configuration.

    httpListeners
    []ApplicationGatewayHttpListener_STATUS_ARM

    HttpListeners: Http listeners of the application gateway resource. For default limits, see Application Gateway limits.

    listeners
    []ApplicationGatewayListener_STATUS_ARM

    Listeners: Listeners of the application gateway resource. For default limits, see Application Gateway limits.

    loadDistributionPolicies
    []ApplicationGatewayLoadDistributionPolicy_STATUS_ARM

    LoadDistributionPolicies: Load distribution policies of the application gateway resource.

    operationalState
    ApplicationGatewayPropertiesFormat_OperationalState_STATUS

    OperationalState: Operational state of the application gateway resource.

    privateEndpointConnections
    []ApplicationGatewayPrivateEndpointConnection_STATUS_ARM

    PrivateEndpointConnections: Private Endpoint connections on application gateway.

    privateLinkConfigurations
    []ApplicationGatewayPrivateLinkConfiguration_STATUS_ARM

    PrivateLinkConfigurations: PrivateLink configurations on application gateway.

    probes
    []ApplicationGatewayProbe_STATUS_ARM

    Probes: Probes of the application gateway resource.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

    ProvisioningState: The provisioning state of the application gateway resource.

    redirectConfigurations
    []ApplicationGatewayRedirectConfiguration_STATUS_ARM

    RedirectConfigurations: Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits.

    requestRoutingRules
    []ApplicationGatewayRequestRoutingRule_STATUS_ARM

    RequestRoutingRules: Request routing rules of the application gateway resource.

    resourceGuid
    string

    ResourceGuid: The resource GUID property of the application gateway resource.

    rewriteRuleSets
    []ApplicationGatewayRewriteRuleSet_STATUS_ARM

    RewriteRuleSets: Rewrite rules for the application gateway resource.

    routingRules
    []ApplicationGatewayRoutingRule_STATUS_ARM

    RoutingRules: Routing rules of the application gateway resource.

    sku
    ApplicationGatewaySku_STATUS_ARM

    Sku: SKU of the application gateway resource.

    sslCertificates
    []ApplicationGatewaySslCertificate_STATUS_ARM

    SslCertificates: SSL certificates of the application gateway resource. For default limits, see Application Gateway limits.

    sslPolicy
    ApplicationGatewaySslPolicy_STATUS_ARM

    SslPolicy: SSL policy of the application gateway resource.

    sslProfiles
    []ApplicationGatewaySslProfile_STATUS_ARM

    SslProfiles: SSL profiles of the application gateway resource. For default limits, see Application Gateway limits.

    trustedClientCertificates
    []ApplicationGatewayTrustedClientCertificate_STATUS_ARM

    TrustedClientCertificates: Trusted client certificates of the application gateway resource. For default limits, see Application Gateway limits.

    trustedRootCertificates
    []ApplicationGatewayTrustedRootCertificate_STATUS_ARM

    TrustedRootCertificates: Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits.

    urlPathMaps
    []ApplicationGatewayUrlPathMap_STATUS_ARM

    UrlPathMaps: URL path map of the application gateway resource. For default limits, see Application Gateway limits.

    webApplicationFirewallConfiguration
    ApplicationGatewayWebApplicationFirewallConfiguration_STATUS_ARM

    WebApplicationFirewallConfiguration: Web application firewall configuration.

    ApplicationGatewayProtocol (string alias)

    (Appears on:ApplicationGatewayBackendHttpSettings, ApplicationGatewayBackendHttpSettingsPropertiesFormat_ARM, ApplicationGatewayBackendSettings, ApplicationGatewayBackendSettingsPropertiesFormat_ARM, ApplicationGatewayHttpListener, ApplicationGatewayHttpListenerPropertiesFormat_ARM, ApplicationGatewayListener, ApplicationGatewayListenerPropertiesFormat_ARM, ApplicationGatewayProbe, ApplicationGatewayProbePropertiesFormat_ARM)

    Application Gateway protocol.

    Value Description

    "Http"

    "Https"

    "Tcp"

    "Tls"

    ApplicationGatewayProvisioningState_STATUS (string alias)

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM, ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded, NatGatewayPropertiesFormat_STATUS_ARM, NatGateway_STATUS, PrivateEndpointProperties_STATUS_ARM, PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded, PrivateLinkServiceConnectionProperties_STATUS_ARM, PrivateLinkServiceConnection_STATUS, PrivateLinkServiceIpConfigurationProperties_STATUS_ARM, PrivateLinkServiceIpConfiguration_STATUS, PrivateLinkServiceProperties_STATUS_ARM, PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)

    The current provisioning state.

    Value Description

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    ApplicationGatewayRedirectConfiguration

    (Appears on:ApplicationGateway_Spec)

    Redirect configuration of an application gateway.

    Field Description
    includePath
    bool

    IncludePath: Include path in the redirected url.

    includeQueryString
    bool

    IncludeQueryString: Include query string in the redirected url.

    name
    string

    Name: Name of the redirect configuration that is unique within an Application Gateway.

    pathRules
    []ApplicationGatewaySubResource

    PathRules: Path rules specifying redirect configuration.

    redirectType
    RedirectTypeEnum

    RedirectType: HTTP redirection type.

    requestRoutingRules
    []ApplicationGatewaySubResource

    RequestRoutingRules: Request routing specifying redirect configuration.

    targetListener
    ApplicationGatewaySubResource

    TargetListener: Reference to a listener to redirect the request to.

    targetUrl
    string

    TargetUrl: Url to redirect the request to.

    urlPathMaps
    []ApplicationGatewaySubResource

    UrlPathMaps: Url path maps specifying default redirect configuration.

    ApplicationGatewayRedirectConfigurationPropertiesFormat_ARM

    (Appears on:ApplicationGatewayRedirectConfiguration_ARM)

    Properties of redirect configuration of the application gateway.

    Field Description
    includePath
    bool

    IncludePath: Include path in the redirected url.

    includeQueryString
    bool

    IncludeQueryString: Include query string in the redirected url.

    pathRules
    []ApplicationGatewaySubResource_ARM

    PathRules: Path rules specifying redirect configuration.

    redirectType
    RedirectTypeEnum

    RedirectType: HTTP redirection type.

    requestRoutingRules
    []ApplicationGatewaySubResource_ARM

    RequestRoutingRules: Request routing specifying redirect configuration.

    targetListener
    ApplicationGatewaySubResource_ARM

    TargetListener: Reference to a listener to redirect the request to.

    targetUrl
    string

    TargetUrl: Url to redirect the request to.

    urlPathMaps
    []ApplicationGatewaySubResource_ARM

    UrlPathMaps: Url path maps specifying default redirect configuration.

    ApplicationGatewayRedirectConfiguration_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Redirect configuration of an application gateway.

    Field Description
    name
    string

    Name: Name of the redirect configuration that is unique within an Application Gateway.

    properties
    ApplicationGatewayRedirectConfigurationPropertiesFormat_ARM

    Properties: Properties of the application gateway redirect configuration.

    ApplicationGatewayRedirectConfiguration_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Redirect configuration of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayRedirectConfiguration_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Redirect configuration of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayRequestRoutingRule

    (Appears on:ApplicationGateway_Spec)

    Request routing rule of an application gateway.

    Field Description
    backendAddressPool
    ApplicationGatewaySubResource

    BackendAddressPool: Backend address pool resource of the application gateway.

    backendHttpSettings
    ApplicationGatewaySubResource

    BackendHttpSettings: Backend http settings resource of the application gateway.

    httpListener
    ApplicationGatewaySubResource

    HttpListener: Http listener resource of the application gateway.

    loadDistributionPolicy
    ApplicationGatewaySubResource

    LoadDistributionPolicy: Load Distribution Policy resource of the application gateway.

    name
    string

    Name: Name of the request routing rule that is unique within an Application Gateway.

    priority
    int

    Priority: Priority of the request routing rule.

    redirectConfiguration
    ApplicationGatewaySubResource

    RedirectConfiguration: Redirect configuration resource of the application gateway.

    rewriteRuleSet
    ApplicationGatewaySubResource

    RewriteRuleSet: Rewrite Rule Set resource in Basic rule of the application gateway.

    ruleType
    ApplicationGatewayRequestRoutingRulePropertiesFormat_RuleType

    RuleType: Rule type.

    urlPathMap
    ApplicationGatewaySubResource

    UrlPathMap: URL path map resource of the application gateway.

    ApplicationGatewayRequestRoutingRulePropertiesFormat_ARM

    (Appears on:ApplicationGatewayRequestRoutingRule_ARM)

    Properties of request routing rule of the application gateway.

    Field Description
    backendAddressPool
    ApplicationGatewaySubResource_ARM

    BackendAddressPool: Backend address pool resource of the application gateway.

    backendHttpSettings
    ApplicationGatewaySubResource_ARM

    BackendHttpSettings: Backend http settings resource of the application gateway.

    httpListener
    ApplicationGatewaySubResource_ARM

    HttpListener: Http listener resource of the application gateway.

    loadDistributionPolicy
    ApplicationGatewaySubResource_ARM

    LoadDistributionPolicy: Load Distribution Policy resource of the application gateway.

    priority
    int

    Priority: Priority of the request routing rule.

    redirectConfiguration
    ApplicationGatewaySubResource_ARM

    RedirectConfiguration: Redirect configuration resource of the application gateway.

    rewriteRuleSet
    ApplicationGatewaySubResource_ARM

    RewriteRuleSet: Rewrite Rule Set resource in Basic rule of the application gateway.

    ruleType
    ApplicationGatewayRequestRoutingRulePropertiesFormat_RuleType

    RuleType: Rule type.

    urlPathMap
    ApplicationGatewaySubResource_ARM

    UrlPathMap: URL path map resource of the application gateway.

    ApplicationGatewayRequestRoutingRulePropertiesFormat_RuleType (string alias)

    (Appears on:ApplicationGatewayRequestRoutingRule, ApplicationGatewayRequestRoutingRulePropertiesFormat_ARM)

    Value Description

    "Basic"

    "PathBasedRouting"

    ApplicationGatewayRequestRoutingRule_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Request routing rule of an application gateway.

    Field Description
    name
    string

    Name: Name of the request routing rule that is unique within an Application Gateway.

    properties
    ApplicationGatewayRequestRoutingRulePropertiesFormat_ARM

    Properties: Properties of the application gateway request routing rule.

    ApplicationGatewayRequestRoutingRule_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Request routing rule of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayRequestRoutingRule_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Request routing rule of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayRewriteRule

    (Appears on:ApplicationGatewayRewriteRuleSet)

    Rewrite rule of an application gateway.

    Field Description
    actionSet
    ApplicationGatewayRewriteRuleActionSet

    ActionSet: Set of actions to be done as part of the rewrite Rule.

    conditions
    []ApplicationGatewayRewriteRuleCondition

    Conditions: Conditions based on which the action set execution will be evaluated.

    name
    string

    Name: Name of the rewrite rule that is unique within an Application Gateway.

    ruleSequence
    int

    RuleSequence: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.

    ApplicationGatewayRewriteRuleActionSet

    (Appears on:ApplicationGatewayRewriteRule)

    Set of actions in the Rewrite Rule in Application Gateway.

    Field Description
    requestHeaderConfigurations
    []ApplicationGatewayHeaderConfiguration

    RequestHeaderConfigurations: Request Header Actions in the Action Set.

    responseHeaderConfigurations
    []ApplicationGatewayHeaderConfiguration

    ResponseHeaderConfigurations: Response Header Actions in the Action Set.

    urlConfiguration
    ApplicationGatewayUrlConfiguration

    UrlConfiguration: Url Configuration Action in the Action Set.

    ApplicationGatewayRewriteRuleActionSet_ARM

    (Appears on:ApplicationGatewayRewriteRule_ARM)

    Set of actions in the Rewrite Rule in Application Gateway.

    Field Description
    requestHeaderConfigurations
    []ApplicationGatewayHeaderConfiguration_ARM

    RequestHeaderConfigurations: Request Header Actions in the Action Set.

    responseHeaderConfigurations
    []ApplicationGatewayHeaderConfiguration_ARM

    ResponseHeaderConfigurations: Response Header Actions in the Action Set.

    urlConfiguration
    ApplicationGatewayUrlConfiguration_ARM

    UrlConfiguration: Url Configuration Action in the Action Set.

    ApplicationGatewayRewriteRuleCondition

    (Appears on:ApplicationGatewayRewriteRule)

    Set of conditions in the Rewrite Rule in Application Gateway.

    Field Description
    ignoreCase
    bool

    IgnoreCase: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison.

    negate
    bool

    Negate: Setting this value as truth will force to check the negation of the condition given by the user.

    pattern
    string

    Pattern: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.

    variable
    string

    Variable: The condition parameter of the RewriteRuleCondition.

    ApplicationGatewayRewriteRuleCondition_ARM

    (Appears on:ApplicationGatewayRewriteRule_ARM)

    Set of conditions in the Rewrite Rule in Application Gateway.

    Field Description
    ignoreCase
    bool

    IgnoreCase: Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison.

    negate
    bool

    Negate: Setting this value as truth will force to check the negation of the condition given by the user.

    pattern
    string

    Pattern: The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.

    variable
    string

    Variable: The condition parameter of the RewriteRuleCondition.

    ApplicationGatewayRewriteRuleSet

    (Appears on:ApplicationGateway_Spec)

    Rewrite rule set of an application gateway.

    Field Description
    name
    string

    Name: Name of the rewrite rule set that is unique within an Application Gateway.

    rewriteRules
    []ApplicationGatewayRewriteRule

    RewriteRules: Rewrite rules in the rewrite rule set.

    ApplicationGatewayRewriteRuleSetPropertiesFormat_ARM

    (Appears on:ApplicationGatewayRewriteRuleSet_ARM)

    Properties of rewrite rule set of the application gateway.

    Field Description
    rewriteRules
    []ApplicationGatewayRewriteRule_ARM

    RewriteRules: Rewrite rules in the rewrite rule set.

    ApplicationGatewayRewriteRuleSet_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Rewrite rule set of an application gateway.

    Field Description
    name
    string

    Name: Name of the rewrite rule set that is unique within an Application Gateway.

    properties
    ApplicationGatewayRewriteRuleSetPropertiesFormat_ARM

    Properties: Properties of the application gateway rewrite rule set.

    ApplicationGatewayRewriteRuleSet_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Rewrite rule set of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayRewriteRuleSet_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Rewrite rule set of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayRewriteRule_ARM

    (Appears on:ApplicationGatewayRewriteRuleSetPropertiesFormat_ARM)

    Rewrite rule of an application gateway.

    Field Description
    actionSet
    ApplicationGatewayRewriteRuleActionSet_ARM

    ActionSet: Set of actions to be done as part of the rewrite Rule.

    conditions
    []ApplicationGatewayRewriteRuleCondition_ARM

    Conditions: Conditions based on which the action set execution will be evaluated.

    name
    string

    Name: Name of the rewrite rule that is unique within an Application Gateway.

    ruleSequence
    int

    RuleSequence: Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.

    ApplicationGatewayRoutingRule

    (Appears on:ApplicationGateway_Spec)

    Routing rule of an application gateway.

    Field Description
    backendAddressPool
    ApplicationGatewaySubResource

    BackendAddressPool: Backend address pool resource of the application gateway.

    backendSettings
    ApplicationGatewaySubResource

    BackendSettings: Backend settings resource of the application gateway.

    listener
    ApplicationGatewaySubResource

    Listener: Listener resource of the application gateway.

    name
    string

    Name: Name of the routing rule that is unique within an Application Gateway.

    priority
    int

    Priority: Priority of the routing rule.

    ruleType
    ApplicationGatewayRoutingRulePropertiesFormat_RuleType

    RuleType: Rule type.

    ApplicationGatewayRoutingRulePropertiesFormat_ARM

    (Appears on:ApplicationGatewayRoutingRule_ARM)

    Properties of routing rule of the application gateway.

    Field Description
    backendAddressPool
    ApplicationGatewaySubResource_ARM

    BackendAddressPool: Backend address pool resource of the application gateway.

    backendSettings
    ApplicationGatewaySubResource_ARM

    BackendSettings: Backend settings resource of the application gateway.

    listener
    ApplicationGatewaySubResource_ARM

    Listener: Listener resource of the application gateway.

    priority
    int

    Priority: Priority of the routing rule.

    ruleType
    ApplicationGatewayRoutingRulePropertiesFormat_RuleType

    RuleType: Rule type.

    ApplicationGatewayRoutingRulePropertiesFormat_RuleType (string alias)

    (Appears on:ApplicationGatewayRoutingRule, ApplicationGatewayRoutingRulePropertiesFormat_ARM)

    Value Description

    "Basic"

    "PathBasedRouting"

    ApplicationGatewayRoutingRule_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Routing rule of an application gateway.

    Field Description
    name
    string

    Name: Name of the routing rule that is unique within an Application Gateway.

    properties
    ApplicationGatewayRoutingRulePropertiesFormat_ARM

    Properties: Properties of the application gateway routing rule.

    ApplicationGatewayRoutingRule_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Routing rule of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayRoutingRule_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Routing rule of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewaySku

    (Appears on:ApplicationGateway_Spec)

    SKU of an application gateway.

    Field Description
    capacity
    int

    Capacity: Capacity (instance count) of an application gateway.

    name
    ApplicationGatewaySku_Name

    Name: Name of an application gateway SKU.

    tier
    ApplicationGatewaySku_Tier

    Tier: Tier of an application gateway.

    ApplicationGatewaySku_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    SKU of an application gateway.

    Field Description
    capacity
    int

    Capacity: Capacity (instance count) of an application gateway.

    name
    ApplicationGatewaySku_Name

    Name: Name of an application gateway SKU.

    tier
    ApplicationGatewaySku_Tier

    Tier: Tier of an application gateway.

    ApplicationGatewaySku_Name (string alias)

    (Appears on:ApplicationGatewaySku, ApplicationGatewaySku_ARM)

    Value Description

    "Standard_Large"

    "Standard_Medium"

    "Standard_Small"

    "Standard_v2"

    "WAF_Large"

    "WAF_Medium"

    "WAF_v2"

    ApplicationGatewaySku_Name_STATUS (string alias)

    (Appears on:ApplicationGatewaySku_STATUS, ApplicationGatewaySku_STATUS_ARM)

    Value Description

    "Standard_Large"

    "Standard_Medium"

    "Standard_Small"

    "Standard_v2"

    "WAF_Large"

    "WAF_Medium"

    "WAF_v2"

    ApplicationGatewaySku_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    SKU of an application gateway.

    Field Description
    capacity
    int

    Capacity: Capacity (instance count) of an application gateway.

    name
    ApplicationGatewaySku_Name_STATUS

    Name: Name of an application gateway SKU.

    tier
    ApplicationGatewaySku_Tier_STATUS

    Tier: Tier of an application gateway.

    ApplicationGatewaySku_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    SKU of an application gateway.

    Field Description
    capacity
    int

    Capacity: Capacity (instance count) of an application gateway.

    name
    ApplicationGatewaySku_Name_STATUS

    Name: Name of an application gateway SKU.

    tier
    ApplicationGatewaySku_Tier_STATUS

    Tier: Tier of an application gateway.

    ApplicationGatewaySku_Tier (string alias)

    (Appears on:ApplicationGatewaySku, ApplicationGatewaySku_ARM)

    Value Description

    "Standard"

    "Standard_v2"

    "WAF"

    "WAF_v2"

    ApplicationGatewaySku_Tier_STATUS (string alias)

    (Appears on:ApplicationGatewaySku_STATUS, ApplicationGatewaySku_STATUS_ARM)

    Value Description

    "Standard"

    "Standard_v2"

    "WAF"

    "WAF_v2"

    ApplicationGatewaySslCertificate

    (Appears on:ApplicationGateway_Spec)

    SSL certificates of an application gateway.

    Field Description
    data
    genruntime.SecretReference

    Data: Base-64 encoded pfx certificate. Only applicable in PUT Request.

    keyVaultSecretId
    string

    KeyVaultSecretId: Secret Id of (base-64 encoded unencrypted pfx) ‘Secret’ or ‘Certificate’ object stored in KeyVault.

    name
    string

    Name: Name of the SSL certificate that is unique within an Application Gateway.

    password
    genruntime.SecretReference

    Password: Password for the pfx file specified in data. Only applicable in PUT request.

    ApplicationGatewaySslCertificatePropertiesFormat_ARM

    (Appears on:ApplicationGatewaySslCertificate_ARM)

    Properties of SSL certificates of an application gateway.

    Field Description
    data
    string

    Data: Base-64 encoded pfx certificate. Only applicable in PUT Request.

    keyVaultSecretId
    string

    KeyVaultSecretId: Secret Id of (base-64 encoded unencrypted pfx) ‘Secret’ or ‘Certificate’ object stored in KeyVault.

    password
    string

    Password: Password for the pfx file specified in data. Only applicable in PUT request.

    ApplicationGatewaySslCertificate_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    SSL certificates of an application gateway.

    Field Description
    name
    string

    Name: Name of the SSL certificate that is unique within an Application Gateway.

    properties
    ApplicationGatewaySslCertificatePropertiesFormat_ARM

    Properties: Properties of the application gateway SSL certificate.

    ApplicationGatewaySslCertificate_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    SSL certificates of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewaySslCertificate_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    SSL certificates of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewaySslPolicy

    (Appears on:ApplicationGatewaySslProfile, ApplicationGateway_Spec)

    Application Gateway Ssl policy.

    Field Description
    cipherSuites
    []CipherSuitesEnum

    CipherSuites: Ssl cipher suites to be enabled in the specified order to application gateway.

    disabledSslProtocols
    []ProtocolsEnum

    DisabledSslProtocols: Ssl protocols to be disabled on application gateway.

    minProtocolVersion
    ProtocolsEnum

    MinProtocolVersion: Minimum version of Ssl protocol to be supported on application gateway.

    policyName
    PolicyNameEnum

    PolicyName: Name of Ssl predefined policy.

    policyType
    ApplicationGatewaySslPolicy_PolicyType

    PolicyType: Type of Ssl Policy.

    ApplicationGatewaySslPolicy_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM, ApplicationGatewaySslProfilePropertiesFormat_ARM)

    Application Gateway Ssl policy.

    Field Description
    cipherSuites
    []CipherSuitesEnum

    CipherSuites: Ssl cipher suites to be enabled in the specified order to application gateway.

    disabledSslProtocols
    []ProtocolsEnum

    DisabledSslProtocols: Ssl protocols to be disabled on application gateway.

    minProtocolVersion
    ProtocolsEnum

    MinProtocolVersion: Minimum version of Ssl protocol to be supported on application gateway.

    policyName
    PolicyNameEnum

    PolicyName: Name of Ssl predefined policy.

    policyType
    ApplicationGatewaySslPolicy_PolicyType

    PolicyType: Type of Ssl Policy.

    ApplicationGatewaySslPolicy_PolicyType (string alias)

    (Appears on:ApplicationGatewaySslPolicy, ApplicationGatewaySslPolicy_ARM)

    Value Description

    "Custom"

    "CustomV2"

    "Predefined"

    ApplicationGatewaySslPolicy_PolicyType_STATUS (string alias)

    (Appears on:ApplicationGatewaySslPolicy_STATUS, ApplicationGatewaySslPolicy_STATUS_ARM)

    Value Description

    "Custom"

    "CustomV2"

    "Predefined"

    ApplicationGatewaySslPolicy_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Application Gateway Ssl policy.

    Field Description
    cipherSuites
    []CipherSuitesEnum_STATUS

    CipherSuites: Ssl cipher suites to be enabled in the specified order to application gateway.

    disabledSslProtocols
    []ProtocolsEnum_STATUS

    DisabledSslProtocols: Ssl protocols to be disabled on application gateway.

    minProtocolVersion
    ProtocolsEnum_STATUS

    MinProtocolVersion: Minimum version of Ssl protocol to be supported on application gateway.

    policyName
    PolicyNameEnum_STATUS

    PolicyName: Name of Ssl predefined policy.

    policyType
    ApplicationGatewaySslPolicy_PolicyType_STATUS

    PolicyType: Type of Ssl Policy.

    ApplicationGatewaySslPolicy_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Application Gateway Ssl policy.

    Field Description
    cipherSuites
    []CipherSuitesEnum_STATUS

    CipherSuites: Ssl cipher suites to be enabled in the specified order to application gateway.

    disabledSslProtocols
    []ProtocolsEnum_STATUS

    DisabledSslProtocols: Ssl protocols to be disabled on application gateway.

    minProtocolVersion
    ProtocolsEnum_STATUS

    MinProtocolVersion: Minimum version of Ssl protocol to be supported on application gateway.

    policyName
    PolicyNameEnum_STATUS

    PolicyName: Name of Ssl predefined policy.

    policyType
    ApplicationGatewaySslPolicy_PolicyType_STATUS

    PolicyType: Type of Ssl Policy.

    ApplicationGatewaySslProfile

    (Appears on:ApplicationGateway_Spec)

    SSL profile of an application gateway.

    Field Description
    clientAuthConfiguration
    ApplicationGatewayClientAuthConfiguration

    ClientAuthConfiguration: Client authentication configuration of the application gateway resource.

    name
    string

    Name: Name of the SSL profile that is unique within an Application Gateway.

    sslPolicy
    ApplicationGatewaySslPolicy

    SslPolicy: SSL policy of the application gateway resource.

    trustedClientCertificates
    []ApplicationGatewaySubResource

    TrustedClientCertificates: Array of references to application gateway trusted client certificates.

    ApplicationGatewaySslProfilePropertiesFormat_ARM

    (Appears on:ApplicationGatewaySslProfile_ARM)

    Properties of SSL profile of an application gateway.

    Field Description
    clientAuthConfiguration
    ApplicationGatewayClientAuthConfiguration_ARM

    ClientAuthConfiguration: Client authentication configuration of the application gateway resource.

    sslPolicy
    ApplicationGatewaySslPolicy_ARM

    SslPolicy: SSL policy of the application gateway resource.

    trustedClientCertificates
    []ApplicationGatewaySubResource_ARM

    TrustedClientCertificates: Array of references to application gateway trusted client certificates.

    ApplicationGatewaySslProfile_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    SSL profile of an application gateway.

    Field Description
    name
    string

    Name: Name of the SSL profile that is unique within an Application Gateway.

    properties
    ApplicationGatewaySslProfilePropertiesFormat_ARM

    Properties: Properties of the application gateway SSL profile.

    ApplicationGatewaySslProfile_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    SSL profile of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewaySslProfile_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    SSL profile of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewaySubResource

    (Appears on:ApplicationGatewayBackendHttpSettings, ApplicationGatewayBackendSettings, ApplicationGatewayFrontendIPConfiguration, ApplicationGatewayHttpListener, ApplicationGatewayIPConfiguration_ApplicationGateway_SubResourceEmbedded, ApplicationGatewayListener, ApplicationGatewayRedirectConfiguration, ApplicationGatewayRequestRoutingRule, ApplicationGatewayRoutingRule, ApplicationGatewaySslProfile, ApplicationGatewayUrlPathMap, ApplicationGateway_Spec, NatGateway_Spec)

    Reference to another subresource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    ApplicationGatewaySubResource_ARM

    (Appears on:ApplicationGatewayBackendHttpSettingsPropertiesFormat_ARM, ApplicationGatewayBackendSettingsPropertiesFormat_ARM, ApplicationGatewayFrontendIPConfigurationPropertiesFormat_ARM, ApplicationGatewayHttpListenerPropertiesFormat_ARM, ApplicationGatewayIPConfigurationPropertiesFormat_ARM, ApplicationGatewayListenerPropertiesFormat_ARM, ApplicationGatewayPropertiesFormat_ARM, ApplicationGatewayRedirectConfigurationPropertiesFormat_ARM, ApplicationGatewayRequestRoutingRulePropertiesFormat_ARM, ApplicationGatewayRoutingRulePropertiesFormat_ARM, ApplicationGatewaySslProfilePropertiesFormat_ARM, ApplicationGatewayUrlPathMapPropertiesFormat_ARM, NatGatewayPropertiesFormat_ARM)

    Reference to another subresource.

    Field Description
    id
    string

    ApplicationGatewaySubResource_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded, NatGateway_STATUS)

    Reference to another subresource.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewaySubResource_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM, NatGatewayPropertiesFormat_STATUS_ARM)

    Reference to another subresource.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayTrustedClientCertificate

    (Appears on:ApplicationGateway_Spec)

    Trusted client certificates of an application gateway.

    Field Description
    data
    genruntime.SecretReference

    Data: Certificate public data.

    name
    string

    Name: Name of the trusted client certificate that is unique within an Application Gateway.

    ApplicationGatewayTrustedClientCertificatePropertiesFormat_ARM

    (Appears on:ApplicationGatewayTrustedClientCertificate_ARM)

    Trusted client certificates properties of an application gateway.

    Field Description
    data
    string

    Data: Certificate public data.

    ApplicationGatewayTrustedClientCertificate_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Trusted client certificates of an application gateway.

    Field Description
    name
    string

    Name: Name of the trusted client certificate that is unique within an Application Gateway.

    properties
    ApplicationGatewayTrustedClientCertificatePropertiesFormat_ARM

    Properties: Properties of the application gateway trusted client certificate.

    ApplicationGatewayTrustedClientCertificate_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Trusted client certificates of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayTrustedClientCertificate_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Trusted client certificates of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayTrustedRootCertificate

    (Appears on:ApplicationGateway_Spec)

    Trusted Root certificates of an application gateway.

    Field Description
    data
    genruntime.SecretReference

    Data: Certificate public data.

    keyVaultSecretId
    string

    KeyVaultSecretId: Secret Id of (base-64 encoded unencrypted pfx) ‘Secret’ or ‘Certificate’ object stored in KeyVault.

    name
    string

    Name: Name of the trusted root certificate that is unique within an Application Gateway.

    ApplicationGatewayTrustedRootCertificatePropertiesFormat_ARM

    (Appears on:ApplicationGatewayTrustedRootCertificate_ARM)

    Trusted Root certificates properties of an application gateway.

    Field Description
    data
    string

    Data: Certificate public data.

    keyVaultSecretId
    string

    KeyVaultSecretId: Secret Id of (base-64 encoded unencrypted pfx) ‘Secret’ or ‘Certificate’ object stored in KeyVault.

    ApplicationGatewayTrustedRootCertificate_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Trusted Root certificates of an application gateway.

    Field Description
    name
    string

    Name: Name of the trusted root certificate that is unique within an Application Gateway.

    properties
    ApplicationGatewayTrustedRootCertificatePropertiesFormat_ARM

    Properties: Properties of the application gateway trusted root certificate.

    ApplicationGatewayTrustedRootCertificate_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Trusted Root certificates of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayTrustedRootCertificate_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Trusted Root certificates of an application gateway.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayUrlConfiguration

    (Appears on:ApplicationGatewayRewriteRuleActionSet)

    Url configuration of the Actions set in Application Gateway.

    Field Description
    modifiedPath
    string

    ModifiedPath: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null.

    modifiedQueryString
    string

    ModifiedQueryString: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null.

    reroute
    bool

    Reroute: If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false.

    ApplicationGatewayUrlConfiguration_ARM

    (Appears on:ApplicationGatewayRewriteRuleActionSet_ARM)

    Url configuration of the Actions set in Application Gateway.

    Field Description
    modifiedPath
    string

    ModifiedPath: Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null.

    modifiedQueryString
    string

    ModifiedQueryString: Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null.

    reroute
    bool

    Reroute: If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false.

    ApplicationGatewayUrlPathMap

    (Appears on:ApplicationGateway_Spec)

    UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.

    Field Description
    defaultBackendAddressPool
    ApplicationGatewaySubResource

    DefaultBackendAddressPool: Default backend address pool resource of URL path map.

    defaultBackendHttpSettings
    ApplicationGatewaySubResource

    DefaultBackendHttpSettings: Default backend http settings resource of URL path map.

    defaultLoadDistributionPolicy
    ApplicationGatewaySubResource

    DefaultLoadDistributionPolicy: Default Load Distribution Policy resource of URL path map.

    defaultRedirectConfiguration
    ApplicationGatewaySubResource

    DefaultRedirectConfiguration: Default redirect configuration resource of URL path map.

    defaultRewriteRuleSet
    ApplicationGatewaySubResource

    DefaultRewriteRuleSet: Default Rewrite rule set resource of URL path map.

    name
    string

    Name: Name of the URL path map that is unique within an Application Gateway.

    pathRules
    []ApplicationGatewayPathRule

    PathRules: Path rule of URL path map resource.

    ApplicationGatewayUrlPathMapPropertiesFormat_ARM

    (Appears on:ApplicationGatewayUrlPathMap_ARM)

    Properties of UrlPathMap of the application gateway.

    Field Description
    defaultBackendAddressPool
    ApplicationGatewaySubResource_ARM

    DefaultBackendAddressPool: Default backend address pool resource of URL path map.

    defaultBackendHttpSettings
    ApplicationGatewaySubResource_ARM

    DefaultBackendHttpSettings: Default backend http settings resource of URL path map.

    defaultLoadDistributionPolicy
    ApplicationGatewaySubResource_ARM

    DefaultLoadDistributionPolicy: Default Load Distribution Policy resource of URL path map.

    defaultRedirectConfiguration
    ApplicationGatewaySubResource_ARM

    DefaultRedirectConfiguration: Default redirect configuration resource of URL path map.

    defaultRewriteRuleSet
    ApplicationGatewaySubResource_ARM

    DefaultRewriteRuleSet: Default Rewrite rule set resource of URL path map.

    pathRules
    []ApplicationGatewayPathRule_ARM

    PathRules: Path rule of URL path map resource.

    ApplicationGatewayUrlPathMap_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.

    Field Description
    name
    string

    Name: Name of the URL path map that is unique within an Application Gateway.

    properties
    ApplicationGatewayUrlPathMapPropertiesFormat_ARM

    Properties: Properties of the application gateway URL path map.

    ApplicationGatewayUrlPathMap_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayUrlPathMap_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationGatewayWebApplicationFirewallConfiguration

    (Appears on:ApplicationGateway_Spec)

    Application gateway web application firewall configuration.

    Field Description
    disabledRuleGroups
    []ApplicationGatewayFirewallDisabledRuleGroup

    DisabledRuleGroups: The disabled rule groups.

    enabled
    bool

    Enabled: Whether the web application firewall is enabled or not.

    exclusions
    []ApplicationGatewayFirewallExclusion

    Exclusions: The exclusion list.

    fileUploadLimitInMb
    int

    FileUploadLimitInMb: Maximum file upload size in Mb for WAF.

    firewallMode
    ApplicationGatewayWebApplicationFirewallConfiguration_FirewallMode

    FirewallMode: Web application firewall mode.

    maxRequestBodySize
    int

    MaxRequestBodySize: Maximum request body size for WAF.

    maxRequestBodySizeInKb
    int

    MaxRequestBodySizeInKb: Maximum request body size in Kb for WAF.

    requestBodyCheck
    bool

    RequestBodyCheck: Whether allow WAF to check request Body.

    ruleSetType
    string

    RuleSetType: The type of the web application firewall rule set. Possible values are: ‘OWASP’.

    ruleSetVersion
    string

    RuleSetVersion: The version of the rule set type.

    ApplicationGatewayWebApplicationFirewallConfiguration_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_ARM)

    Application gateway web application firewall configuration.

    Field Description
    disabledRuleGroups
    []ApplicationGatewayFirewallDisabledRuleGroup_ARM

    DisabledRuleGroups: The disabled rule groups.

    enabled
    bool

    Enabled: Whether the web application firewall is enabled or not.

    exclusions
    []ApplicationGatewayFirewallExclusion_ARM

    Exclusions: The exclusion list.

    fileUploadLimitInMb
    int

    FileUploadLimitInMb: Maximum file upload size in Mb for WAF.

    firewallMode
    ApplicationGatewayWebApplicationFirewallConfiguration_FirewallMode

    FirewallMode: Web application firewall mode.

    maxRequestBodySize
    int

    MaxRequestBodySize: Maximum request body size for WAF.

    maxRequestBodySizeInKb
    int

    MaxRequestBodySizeInKb: Maximum request body size in Kb for WAF.

    requestBodyCheck
    bool

    RequestBodyCheck: Whether allow WAF to check request Body.

    ruleSetType
    string

    RuleSetType: The type of the web application firewall rule set. Possible values are: ‘OWASP’.

    ruleSetVersion
    string

    RuleSetVersion: The version of the rule set type.

    ApplicationGatewayWebApplicationFirewallConfiguration_FirewallMode (string alias)

    (Appears on:ApplicationGatewayWebApplicationFirewallConfiguration, ApplicationGatewayWebApplicationFirewallConfiguration_ARM)

    Value Description

    "Detection"

    "Prevention"

    ApplicationGatewayWebApplicationFirewallConfiguration_FirewallMode_STATUS (string alias)

    (Appears on:ApplicationGatewayWebApplicationFirewallConfiguration_STATUS, ApplicationGatewayWebApplicationFirewallConfiguration_STATUS_ARM)

    Value Description

    "Detection"

    "Prevention"

    ApplicationGatewayWebApplicationFirewallConfiguration_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Application gateway web application firewall configuration.

    Field Description
    disabledRuleGroups
    []ApplicationGatewayFirewallDisabledRuleGroup_STATUS

    DisabledRuleGroups: The disabled rule groups.

    enabled
    bool

    Enabled: Whether the web application firewall is enabled or not.

    exclusions
    []ApplicationGatewayFirewallExclusion_STATUS

    Exclusions: The exclusion list.

    fileUploadLimitInMb
    int

    FileUploadLimitInMb: Maximum file upload size in Mb for WAF.

    firewallMode
    ApplicationGatewayWebApplicationFirewallConfiguration_FirewallMode_STATUS

    FirewallMode: Web application firewall mode.

    maxRequestBodySize
    int

    MaxRequestBodySize: Maximum request body size for WAF.

    maxRequestBodySizeInKb
    int

    MaxRequestBodySizeInKb: Maximum request body size in Kb for WAF.

    requestBodyCheck
    bool

    RequestBodyCheck: Whether allow WAF to check request Body.

    ruleSetType
    string

    RuleSetType: The type of the web application firewall rule set. Possible values are: ‘OWASP’.

    ruleSetVersion
    string

    RuleSetVersion: The version of the rule set type.

    ApplicationGatewayWebApplicationFirewallConfiguration_STATUS_ARM

    (Appears on:ApplicationGatewayPropertiesFormat_STATUS_ARM)

    Application gateway web application firewall configuration.

    Field Description
    disabledRuleGroups
    []ApplicationGatewayFirewallDisabledRuleGroup_STATUS_ARM

    DisabledRuleGroups: The disabled rule groups.

    enabled
    bool

    Enabled: Whether the web application firewall is enabled or not.

    exclusions
    []ApplicationGatewayFirewallExclusion_STATUS_ARM

    Exclusions: The exclusion list.

    fileUploadLimitInMb
    int

    FileUploadLimitInMb: Maximum file upload size in Mb for WAF.

    firewallMode
    ApplicationGatewayWebApplicationFirewallConfiguration_FirewallMode_STATUS

    FirewallMode: Web application firewall mode.

    maxRequestBodySize
    int

    MaxRequestBodySize: Maximum request body size for WAF.

    maxRequestBodySizeInKb
    int

    MaxRequestBodySizeInKb: Maximum request body size in Kb for WAF.

    requestBodyCheck
    bool

    RequestBodyCheck: Whether allow WAF to check request Body.

    ruleSetType
    string

    RuleSetType: The type of the web application firewall rule set. Possible values are: ‘OWASP’.

    ruleSetVersion
    string

    RuleSetVersion: The version of the rule set type.

    ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded

    (Appears on:ApplicationGateway)

    Application gateway resource.

    Field Description
    authenticationCertificates
    []ApplicationGatewayAuthenticationCertificate_STATUS

    AuthenticationCertificates: Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits.

    autoscaleConfiguration
    ApplicationGatewayAutoscaleConfiguration_STATUS

    AutoscaleConfiguration: Autoscale Configuration.

    backendAddressPools
    []ApplicationGatewayBackendAddressPool_STATUS

    BackendAddressPools: Backend address pool of the application gateway resource. For default limits, see Application Gateway limits.

    backendHttpSettingsCollection
    []ApplicationGatewayBackendHttpSettings_STATUS

    BackendHttpSettingsCollection: Backend http settings of the application gateway resource. For default limits, see Application Gateway limits.

    backendSettingsCollection
    []ApplicationGatewayBackendSettings_STATUS

    BackendSettingsCollection: Backend settings of the application gateway resource. For default limits, see Application Gateway limits.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    customErrorConfigurations
    []ApplicationGatewayCustomError_STATUS

    CustomErrorConfigurations: Custom error configurations of the application gateway resource.

    enableFips
    bool

    EnableFips: Whether FIPS is enabled on the application gateway resource.

    enableHttp2
    bool

    EnableHttp2: Whether HTTP2 is enabled on the application gateway resource.

    etag
    string

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

    firewallPolicy
    ApplicationGatewaySubResource_STATUS

    FirewallPolicy: Reference to the FirewallPolicy resource.

    forceFirewallPolicyAssociation
    bool

    ForceFirewallPolicyAssociation: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.

    frontendIPConfigurations
    []ApplicationGatewayFrontendIPConfiguration_STATUS

    FrontendIPConfigurations: Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits.

    frontendPorts
    []ApplicationGatewayFrontendPort_STATUS

    FrontendPorts: Frontend ports of the application gateway resource. For default limits, see Application Gateway limits.

    gatewayIPConfigurations
    []ApplicationGatewayIPConfiguration_STATUS_ApplicationGateway_SubResourceEmbedded

    GatewayIPConfigurations: Subnets of the application gateway resource. For default limits, see Application Gateway limits.

    globalConfiguration
    ApplicationGatewayGlobalConfiguration_STATUS

    GlobalConfiguration: Global Configuration.

    httpListeners
    []ApplicationGatewayHttpListener_STATUS

    HttpListeners: Http listeners of the application gateway resource. For default limits, see Application Gateway limits.

    id
    string

    Id: Resource ID.

    identity
    ManagedServiceIdentity_STATUS

    Identity: The identity of the application gateway, if configured.

    listeners
    []ApplicationGatewayListener_STATUS

    Listeners: Listeners of the application gateway resource. For default limits, see Application Gateway limits.

    loadDistributionPolicies
    []ApplicationGatewayLoadDistributionPolicy_STATUS

    LoadDistributionPolicies: Load distribution policies of the application gateway resource.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    operationalState
    ApplicationGatewayPropertiesFormat_OperationalState_STATUS

    OperationalState: Operational state of the application gateway resource.

    privateEndpointConnections
    []ApplicationGatewayPrivateEndpointConnection_STATUS

    PrivateEndpointConnections: Private Endpoint connections on application gateway.

    privateLinkConfigurations
    []ApplicationGatewayPrivateLinkConfiguration_STATUS

    PrivateLinkConfigurations: PrivateLink configurations on application gateway.

    probes
    []ApplicationGatewayProbe_STATUS

    Probes: Probes of the application gateway resource.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

    ProvisioningState: The provisioning state of the application gateway resource.

    redirectConfigurations
    []ApplicationGatewayRedirectConfiguration_STATUS

    RedirectConfigurations: Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits.

    requestRoutingRules
    []ApplicationGatewayRequestRoutingRule_STATUS

    RequestRoutingRules: Request routing rules of the application gateway resource.

    resourceGuid
    string

    ResourceGuid: The resource GUID property of the application gateway resource.

    rewriteRuleSets
    []ApplicationGatewayRewriteRuleSet_STATUS

    RewriteRuleSets: Rewrite rules for the application gateway resource.

    routingRules
    []ApplicationGatewayRoutingRule_STATUS

    RoutingRules: Routing rules of the application gateway resource.

    sku
    ApplicationGatewaySku_STATUS

    Sku: SKU of the application gateway resource.

    sslCertificates
    []ApplicationGatewaySslCertificate_STATUS

    SslCertificates: SSL certificates of the application gateway resource. For default limits, see Application Gateway limits.

    sslPolicy
    ApplicationGatewaySslPolicy_STATUS

    SslPolicy: SSL policy of the application gateway resource.

    sslProfiles
    []ApplicationGatewaySslProfile_STATUS

    SslProfiles: SSL profiles of the application gateway resource. For default limits, see Application Gateway limits.

    tags
    map[string]string

    Tags: Resource tags.

    trustedClientCertificates
    []ApplicationGatewayTrustedClientCertificate_STATUS

    TrustedClientCertificates: Trusted client certificates of the application gateway resource. For default limits, see Application Gateway limits.

    trustedRootCertificates
    []ApplicationGatewayTrustedRootCertificate_STATUS

    TrustedRootCertificates: Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits.

    type
    string

    Type: Resource type.

    urlPathMaps
    []ApplicationGatewayUrlPathMap_STATUS

    UrlPathMaps: URL path map of the application gateway resource. For default limits, see Application Gateway limits.

    webApplicationFirewallConfiguration
    ApplicationGatewayWebApplicationFirewallConfiguration_STATUS

    WebApplicationFirewallConfiguration: Web application firewall configuration.

    zones
    []string

    Zones: A list of availability zones denoting where the resource needs to come from.

    ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded_ARM

    Application gateway resource.

    Field Description
    etag
    string

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

    id
    string

    Id: Resource ID.

    identity
    ManagedServiceIdentity_STATUS_ARM

    Identity: The identity of the application gateway, if configured.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    ApplicationGatewayPropertiesFormat_STATUS_ARM

    Properties: Properties of the application gateway.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    zones
    []string

    Zones: A list of availability zones denoting where the resource needs to come from.

    ApplicationGateway_Spec

    (Appears on:ApplicationGateway)

    Field Description
    authenticationCertificates
    []ApplicationGatewayAuthenticationCertificate

    AuthenticationCertificates: Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits.

    autoscaleConfiguration
    ApplicationGatewayAutoscaleConfiguration

    AutoscaleConfiguration: Autoscale Configuration.

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

    BackendAddressPools: Backend address pool of the application gateway resource. For default limits, see Application Gateway limits.

    backendHttpSettingsCollection
    []ApplicationGatewayBackendHttpSettings

    BackendHttpSettingsCollection: Backend http settings of the application gateway resource. For default limits, see Application Gateway limits.

    backendSettingsCollection
    []ApplicationGatewayBackendSettings

    BackendSettingsCollection: Backend settings of the application gateway resource. For default limits, see Application Gateway limits.

    customErrorConfigurations
    []ApplicationGatewayCustomError

    CustomErrorConfigurations: Custom error configurations of the application gateway resource.

    enableFips
    bool

    EnableFips: Whether FIPS is enabled on the application gateway resource.

    enableHttp2
    bool

    EnableHttp2: Whether HTTP2 is enabled on the application gateway resource.

    firewallPolicy
    ApplicationGatewaySubResource

    FirewallPolicy: Reference to the FirewallPolicy resource.

    forceFirewallPolicyAssociation
    bool

    ForceFirewallPolicyAssociation: If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.

    frontendIPConfigurations
    []ApplicationGatewayFrontendIPConfiguration

    FrontendIPConfigurations: Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits.

    frontendPorts
    []ApplicationGatewayFrontendPort

    FrontendPorts: Frontend ports of the application gateway resource. For default limits, see Application Gateway limits.

    gatewayIPConfigurations
    []ApplicationGatewayIPConfiguration_ApplicationGateway_SubResourceEmbedded

    GatewayIPConfigurations: Subnets of the application gateway resource. For default limits, see Application Gateway limits.

    globalConfiguration
    ApplicationGatewayGlobalConfiguration

    GlobalConfiguration: Global Configuration.

    httpListeners
    []ApplicationGatewayHttpListener

    HttpListeners: Http listeners of the application gateway resource. For default limits, see Application Gateway limits.

    identity
    ManagedServiceIdentity

    Identity: The identity of the application gateway, if configured.

    listeners
    []ApplicationGatewayListener

    Listeners: Listeners of the application gateway resource. For default limits, see Application Gateway limits.

    loadDistributionPolicies
    []ApplicationGatewayLoadDistributionPolicy

    LoadDistributionPolicies: Load distribution policies of the application gateway resource.

    location
    string

    Location: Resource location.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    privateLinkConfigurations
    []ApplicationGatewayPrivateLinkConfiguration

    PrivateLinkConfigurations: PrivateLink configurations on application gateway.

    probes
    []ApplicationGatewayProbe

    Probes: Probes of the application gateway resource.

    redirectConfigurations
    []ApplicationGatewayRedirectConfiguration

    RedirectConfigurations: Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits.

    requestRoutingRules
    []ApplicationGatewayRequestRoutingRule

    RequestRoutingRules: Request routing rules of the application gateway resource.

    rewriteRuleSets
    []ApplicationGatewayRewriteRuleSet

    RewriteRuleSets: Rewrite rules for the application gateway resource.

    routingRules
    []ApplicationGatewayRoutingRule

    RoutingRules: Routing rules of the application gateway resource.

    sku
    ApplicationGatewaySku

    Sku: SKU of the application gateway resource.

    sslCertificates
    []ApplicationGatewaySslCertificate

    SslCertificates: SSL certificates of the application gateway resource. For default limits, see Application Gateway limits.

    sslPolicy
    ApplicationGatewaySslPolicy

    SslPolicy: SSL policy of the application gateway resource.

    sslProfiles
    []ApplicationGatewaySslProfile

    SslProfiles: SSL profiles of the application gateway resource. For default limits, see Application Gateway limits.

    tags
    map[string]string

    Tags: Resource tags.

    trustedClientCertificates
    []ApplicationGatewayTrustedClientCertificate

    TrustedClientCertificates: Trusted client certificates of the application gateway resource. For default limits, see Application Gateway limits.

    trustedRootCertificates
    []ApplicationGatewayTrustedRootCertificate

    TrustedRootCertificates: Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits.

    urlPathMaps
    []ApplicationGatewayUrlPathMap

    UrlPathMaps: URL path map of the application gateway resource. For default limits, see Application Gateway limits.

    webApplicationFirewallConfiguration
    ApplicationGatewayWebApplicationFirewallConfiguration

    WebApplicationFirewallConfiguration: Web application firewall configuration.

    zones
    []string

    Zones: A list of availability zones denoting where the resource needs to come from.

    ApplicationGateway_Spec_ARM

    Field Description
    identity
    ManagedServiceIdentity_ARM

    Identity: The identity of the application gateway, if configured.

    location
    string

    Location: Resource location.

    name
    string
    properties
    ApplicationGatewayPropertiesFormat_ARM

    Properties: Properties of the application gateway.

    tags
    map[string]string

    Tags: Resource tags.

    zones
    []string

    Zones: A list of availability zones denoting where the resource needs to come from.

    ApplicationSecurityGroupSpec_PrivateEndpoint_SubResourceEmbedded

    (Appears on:PrivateEndpoint_Spec)

    An application security group in a resource group.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    ApplicationSecurityGroupSpec_PrivateEndpoint_SubResourceEmbedded_ARM

    (Appears on:PrivateEndpointProperties_ARM)

    An application security group in a resource group.

    Field Description
    id
    string

    ApplicationSecurityGroup_STATUS_PrivateEndpoint_SubResourceEmbedded

    (Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)

    An application security group in a resource group.

    Field Description
    id
    string

    Id: Resource ID.

    ApplicationSecurityGroup_STATUS_PrivateEndpoint_SubResourceEmbedded_ARM

    (Appears on:PrivateEndpointProperties_STATUS_ARM)

    An application security group in a resource group.

    Field Description
    id
    string

    Id: Resource ID.

    BastionHost

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

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

    disableCopyPaste
    bool

    DisableCopyPaste: Enable/Disable Copy/Paste feature of the Bastion Host resource.

    dnsName
    string

    DnsName: FQDN for the endpoint on which bastion host is accessible.

    enableFileCopy
    bool

    EnableFileCopy: Enable/Disable File Copy feature of the Bastion Host resource.

    enableIpConnect
    bool

    EnableIpConnect: Enable/Disable IP Connect feature of the Bastion Host resource.

    enableShareableLink
    bool

    EnableShareableLink: Enable/Disable Shareable Link of the Bastion Host resource.

    enableTunneling
    bool

    EnableTunneling: Enable/Disable Tunneling feature of the Bastion Host resource.

    ipConfigurations
    []BastionHostIPConfiguration

    IpConfigurations: IP configuration of the Bastion Host resource.

    location
    string

    Location: Resource location.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    scaleUnits
    int

    ScaleUnits: The scale units for the Bastion Host resource.

    sku
    Sku

    Sku: The sku of this Bastion Host.

    tags
    map[string]string

    Tags: Resource tags.

    status
    BastionHost_STATUS

    BastionHostIPConfiguration

    (Appears on:BastionHost_Spec)

    IP configuration of an Bastion Host.

    Field Description
    name
    string

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

    privateIPAllocationMethod
    IPAllocationMethod

    PrivateIPAllocationMethod: Private IP allocation method.

    publicIPAddress
    BastionHostSubResource

    PublicIPAddress: Reference of the PublicIP resource.

    subnet
    BastionHostSubResource

    Subnet: Reference of the subnet resource.

    BastionHostIPConfigurationPropertiesFormat_ARM

    (Appears on:BastionHostIPConfiguration_ARM)

    Properties of IP configuration of an Bastion Host.

    Field Description
    privateIPAllocationMethod
    IPAllocationMethod

    PrivateIPAllocationMethod: Private IP allocation method.

    publicIPAddress
    BastionHostSubResource_ARM

    PublicIPAddress: Reference of the PublicIP resource.

    subnet
    BastionHostSubResource_ARM

    Subnet: Reference of the subnet resource.

    BastionHostIPConfiguration_ARM

    (Appears on:BastionHostPropertiesFormat_ARM)

    IP configuration of an Bastion Host.

    Field Description
    name
    string

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

    properties
    BastionHostIPConfigurationPropertiesFormat_ARM

    Properties: Represents the ip configuration associated with the resource.

    BastionHostIPConfiguration_STATUS

    (Appears on:BastionHost_STATUS)

    IP configuration of an Bastion Host.

    Field Description
    id
    string

    Id: Resource ID.

    BastionHostIPConfiguration_STATUS_ARM

    (Appears on:BastionHostPropertiesFormat_STATUS_ARM)

    IP configuration of an Bastion Host.

    Field Description
    id
    string

    Id: Resource ID.

    BastionHostPropertiesFormat_ARM

    (Appears on:BastionHost_Spec_ARM)

    Properties of the Bastion Host.

    Field Description
    disableCopyPaste
    bool

    DisableCopyPaste: Enable/Disable Copy/Paste feature of the Bastion Host resource.

    dnsName
    string

    DnsName: FQDN for the endpoint on which bastion host is accessible.

    enableFileCopy
    bool

    EnableFileCopy: Enable/Disable File Copy feature of the Bastion Host resource.

    enableIpConnect
    bool

    EnableIpConnect: Enable/Disable IP Connect feature of the Bastion Host resource.

    enableShareableLink
    bool

    EnableShareableLink: Enable/Disable Shareable Link of the Bastion Host resource.

    enableTunneling
    bool

    EnableTunneling: Enable/Disable Tunneling feature of the Bastion Host resource.

    ipConfigurations
    []BastionHostIPConfiguration_ARM

    IpConfigurations: IP configuration of the Bastion Host resource.

    scaleUnits
    int

    ScaleUnits: The scale units for the Bastion Host resource.

    BastionHostPropertiesFormat_STATUS_ARM

    (Appears on:BastionHost_STATUS_ARM)

    Properties of the Bastion Host.

    Field Description
    disableCopyPaste
    bool

    DisableCopyPaste: Enable/Disable Copy/Paste feature of the Bastion Host resource.

    dnsName
    string

    DnsName: FQDN for the endpoint on which bastion host is accessible.

    enableFileCopy
    bool

    EnableFileCopy: Enable/Disable File Copy feature of the Bastion Host resource.

    enableIpConnect
    bool

    EnableIpConnect: Enable/Disable IP Connect feature of the Bastion Host resource.

    enableShareableLink
    bool

    EnableShareableLink: Enable/Disable Shareable Link of the Bastion Host resource.

    enableTunneling
    bool

    EnableTunneling: Enable/Disable Tunneling feature of the Bastion Host resource.

    ipConfigurations
    []BastionHostIPConfiguration_STATUS_ARM

    IpConfigurations: IP configuration of the Bastion Host resource.

    provisioningState
    BastionHostProvisioningState_STATUS

    ProvisioningState: The provisioning state of the bastion host resource.

    scaleUnits
    int

    ScaleUnits: The scale units for the Bastion Host resource.

    BastionHostProvisioningState_STATUS (string alias)

    (Appears on:BastionHostPropertiesFormat_STATUS_ARM, BastionHost_STATUS)

    The current provisioning state.

    Value Description

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    BastionHostSubResource

    (Appears on:BastionHostIPConfiguration)

    Reference to another subresource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    BastionHostSubResource_ARM

    (Appears on:BastionHostIPConfigurationPropertiesFormat_ARM)

    Reference to another subresource.

    Field Description
    id
    string

    BastionHost_STATUS

    (Appears on:BastionHost)

    Bastion Host resource.

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    disableCopyPaste
    bool

    DisableCopyPaste: Enable/Disable Copy/Paste feature of the Bastion Host resource.

    dnsName
    string

    DnsName: FQDN for the endpoint on which bastion host is accessible.

    enableFileCopy
    bool

    EnableFileCopy: Enable/Disable File Copy feature of the Bastion Host resource.

    enableIpConnect
    bool

    EnableIpConnect: Enable/Disable IP Connect feature of the Bastion Host resource.

    enableShareableLink
    bool

    EnableShareableLink: Enable/Disable Shareable Link of the Bastion Host resource.

    enableTunneling
    bool

    EnableTunneling: Enable/Disable Tunneling feature of the Bastion Host resource.

    etag
    string

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

    id
    string

    Id: Resource ID.

    ipConfigurations
    []BastionHostIPConfiguration_STATUS

    IpConfigurations: IP configuration of the Bastion Host resource.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    provisioningState
    BastionHostProvisioningState_STATUS

    ProvisioningState: The provisioning state of the bastion host resource.

    scaleUnits
    int

    ScaleUnits: The scale units for the Bastion Host resource.

    sku
    Sku_STATUS

    Sku: The sku of this Bastion Host.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    BastionHost_STATUS_ARM

    Bastion Host resource.

    Field Description
    etag
    string

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

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    BastionHostPropertiesFormat_STATUS_ARM

    Properties: Represents the bastion host resource.

    sku
    Sku_STATUS_ARM

    Sku: The sku of this Bastion Host.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    BastionHost_Spec

    (Appears on:BastionHost)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    disableCopyPaste
    bool

    DisableCopyPaste: Enable/Disable Copy/Paste feature of the Bastion Host resource.

    dnsName
    string

    DnsName: FQDN for the endpoint on which bastion host is accessible.

    enableFileCopy
    bool

    EnableFileCopy: Enable/Disable File Copy feature of the Bastion Host resource.

    enableIpConnect
    bool

    EnableIpConnect: Enable/Disable IP Connect feature of the Bastion Host resource.

    enableShareableLink
    bool

    EnableShareableLink: Enable/Disable Shareable Link of the Bastion Host resource.

    enableTunneling
    bool

    EnableTunneling: Enable/Disable Tunneling feature of the Bastion Host resource.

    ipConfigurations
    []BastionHostIPConfiguration

    IpConfigurations: IP configuration of the Bastion Host resource.

    location
    string

    Location: Resource location.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    scaleUnits
    int

    ScaleUnits: The scale units for the Bastion Host resource.

    sku
    Sku

    Sku: The sku of this Bastion Host.

    tags
    map[string]string

    Tags: Resource tags.

    BastionHost_Spec_ARM

    Field Description
    location
    string

    Location: Resource location.

    name
    string
    properties
    BastionHostPropertiesFormat_ARM

    Properties: Represents the bastion host resource.

    sku
    Sku_ARM

    Sku: The sku of this Bastion Host.

    tags
    map[string]string

    Tags: Resource tags.

    CipherSuitesEnum (string alias)

    (Appears on:ApplicationGatewaySslPolicy, ApplicationGatewaySslPolicy_ARM)

    Ssl cipher suites enums.

    Value Description

    "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA"

    "TLS_DHE_DSS_WITH_AES_128_CBC_SHA"

    "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256"

    "TLS_DHE_DSS_WITH_AES_256_CBC_SHA"

    "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256"

    "TLS_DHE_RSA_WITH_AES_128_CBC_SHA"

    "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256"

    "TLS_DHE_RSA_WITH_AES_256_CBC_SHA"

    "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384"

    "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA"

    "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256"

    "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"

    "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA"

    "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384"

    "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"

    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"

    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"

    "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"

    "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"

    "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"

    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"

    "TLS_RSA_WITH_3DES_EDE_CBC_SHA"

    "TLS_RSA_WITH_AES_128_CBC_SHA"

    "TLS_RSA_WITH_AES_128_CBC_SHA256"

    "TLS_RSA_WITH_AES_128_GCM_SHA256"

    "TLS_RSA_WITH_AES_256_CBC_SHA"

    "TLS_RSA_WITH_AES_256_CBC_SHA256"

    "TLS_RSA_WITH_AES_256_GCM_SHA384"

    CipherSuitesEnum_STATUS (string alias)

    (Appears on:ApplicationGatewaySslPolicy_STATUS, ApplicationGatewaySslPolicy_STATUS_ARM)

    Ssl cipher suites enums.

    Value Description

    "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA"

    "TLS_DHE_DSS_WITH_AES_128_CBC_SHA"

    "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256"

    "TLS_DHE_DSS_WITH_AES_256_CBC_SHA"

    "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256"

    "TLS_DHE_RSA_WITH_AES_128_CBC_SHA"

    "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256"

    "TLS_DHE_RSA_WITH_AES_256_CBC_SHA"

    "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384"

    "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA"

    "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256"

    "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"

    "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA"

    "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384"

    "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"

    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"

    "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"

    "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"

    "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"

    "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"

    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"

    "TLS_RSA_WITH_3DES_EDE_CBC_SHA"

    "TLS_RSA_WITH_AES_128_CBC_SHA"

    "TLS_RSA_WITH_AES_128_CBC_SHA256"

    "TLS_RSA_WITH_AES_128_GCM_SHA256"

    "TLS_RSA_WITH_AES_256_CBC_SHA"

    "TLS_RSA_WITH_AES_256_CBC_SHA256"

    "TLS_RSA_WITH_AES_256_GCM_SHA384"

    CustomDnsConfigPropertiesFormat_STATUS

    (Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)

    Contains custom Dns resolution configuration from customer.

    Field Description
    fqdn
    string

    Fqdn: Fqdn that resolves to private endpoint ip address.

    ipAddresses
    []string

    IpAddresses: A list of private ip addresses of the private endpoint.

    CustomDnsConfigPropertiesFormat_STATUS_ARM

    (Appears on:PrivateEndpointProperties_STATUS_ARM)

    Contains custom Dns resolution configuration from customer.

    Field Description
    fqdn
    string

    Fqdn: Fqdn that resolves to private endpoint ip address.

    ipAddresses
    []string

    IpAddresses: A list of private ip addresses of the private endpoint.

    DnsForwardingRuleSetsForwardingRule

    Generator information: - Generated from: /dnsresolver/resource-manager/Microsoft.Network/stable/2022-07-01/dnsresolver.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​dnsForwardingRulesets/​{dnsForwardingRulesetName}/​forwardingRules/​{forwardingRuleName}

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

    domainName
    string

    DomainName: The domain name for the forwarding rule.

    forwardingRuleState
    ForwardingRuleProperties_ForwardingRuleState

    ForwardingRuleState: The state of forwarding rule.

    metadata
    map[string]string

    Metadata: Metadata attached to the forwarding rule.

    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/DnsForwardingRuleset resource

    targetDnsServers
    []TargetDnsServer

    TargetDnsServers: DNS servers to forward the DNS query to.

    status
    DnsForwardingRulesets_ForwardingRule_STATUS

    DnsForwardingRuleset

    Generator information: - Generated from: /dnsresolver/resource-manager/Microsoft.Network/stable/2022-07-01/dnsresolver.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​dnsForwardingRulesets/​{dnsForwardingRulesetName}

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

    dnsResolverOutboundEndpoints
    []DnsresolverSubResource

    DnsResolverOutboundEndpoints: The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.

    location
    string

    Location: The geo-location where the resource lives

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Resource tags.

    status
    DnsForwardingRuleset_STATUS

    DnsForwardingRulesetProperties_ARM

    (Appears on:DnsForwardingRuleset_Spec_ARM)

    Represents the properties of a DNS forwarding ruleset.

    Field Description
    dnsResolverOutboundEndpoints
    []DnsresolverSubResource_ARM

    DnsResolverOutboundEndpoints: The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.

    DnsForwardingRulesetProperties_STATUS_ARM

    (Appears on:DnsForwardingRuleset_STATUS_ARM)

    Represents the properties of a DNS forwarding ruleset.

    Field Description
    dnsResolverOutboundEndpoints
    []DnsresolverSubResource_STATUS_ARM

    DnsResolverOutboundEndpoints: The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.

    provisioningState
    DnsresolverProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the DNS forwarding ruleset. This is a read-only property and any attempt to set this value will be ignored.

    resourceGuid
    string

    ResourceGuid: The resourceGuid for the DNS forwarding ruleset.

    DnsForwardingRuleset_STATUS

    (Appears on:DnsForwardingRuleset)

    Describes a DNS forwarding ruleset.

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    dnsResolverOutboundEndpoints
    []DnsresolverSubResource_STATUS

    DnsResolverOutboundEndpoints: The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.

    etag
    string

    Etag: ETag of the DNS forwarding ruleset.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    provisioningState
    DnsresolverProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the DNS forwarding ruleset. This is a read-only property and any attempt to set this value will be ignored.

    resourceGuid
    string

    ResourceGuid: The resourceGuid for the DNS forwarding ruleset.

    systemData
    SystemData_STATUS

    SystemData: Metadata pertaining to creation and last modification of the resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    DnsForwardingRuleset_STATUS_ARM

    Describes a DNS forwarding ruleset.

    Field Description
    etag
    string

    Etag: ETag of the DNS forwarding ruleset.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    DnsForwardingRulesetProperties_STATUS_ARM

    Properties: Properties of the DNS forwarding ruleset.

    systemData
    SystemData_STATUS_ARM

    SystemData: Metadata pertaining to creation and last modification of the resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    DnsForwardingRuleset_Spec

    (Appears on:DnsForwardingRuleset)

    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.

    dnsResolverOutboundEndpoints
    []DnsresolverSubResource

    DnsResolverOutboundEndpoints: The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.

    location
    string

    Location: The geo-location where the resource lives

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Resource tags.

    DnsForwardingRuleset_Spec_ARM

    Field Description
    location
    string

    Location: The geo-location where the resource lives

    name
    string
    properties
    DnsForwardingRulesetProperties_ARM

    Properties: Properties of the DNS forwarding ruleset.

    tags
    map[string]string

    Tags: Resource tags.

    DnsForwardingRulesets_ForwardingRule_STATUS

    (Appears on:DnsForwardingRuleSetsForwardingRule)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    domainName
    string

    DomainName: The domain name for the forwarding rule.

    etag
    string

    Etag: ETag of the forwarding rule.

    forwardingRuleState
    ForwardingRuleProperties_ForwardingRuleState_STATUS

    ForwardingRuleState: The state of forwarding rule.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    metadata
    map[string]string

    Metadata: Metadata attached to the forwarding rule.

    name
    string

    Name: The name of the resource

    provisioningState
    DnsresolverProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.

    systemData
    SystemData_STATUS

    SystemData: Metadata pertaining to creation and last modification of the resource.

    targetDnsServers
    []TargetDnsServer_STATUS

    TargetDnsServers: DNS servers to forward the DNS query to.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    DnsForwardingRulesets_ForwardingRule_STATUS_ARM

    Field Description
    etag
    string

    Etag: ETag of the forwarding rule.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    name
    string

    Name: The name of the resource

    properties
    ForwardingRuleProperties_STATUS_ARM

    Properties: Properties of the forwarding rule.

    systemData
    SystemData_STATUS_ARM

    SystemData: Metadata pertaining to creation and last modification of the resource.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    DnsForwardingRulesets_ForwardingRule_Spec

    (Appears on:DnsForwardingRuleSetsForwardingRule)

    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.

    domainName
    string

    DomainName: The domain name for the forwarding rule.

    forwardingRuleState
    ForwardingRuleProperties_ForwardingRuleState

    ForwardingRuleState: The state of forwarding rule.

    metadata
    map[string]string

    Metadata: Metadata attached to the forwarding rule.

    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/DnsForwardingRuleset resource

    targetDnsServers
    []TargetDnsServer

    TargetDnsServers: DNS servers to forward the DNS query to.

    DnsForwardingRulesets_ForwardingRule_Spec_ARM

    Field Description
    name
    string
    properties
    ForwardingRuleProperties_ARM

    Properties: Properties of the forwarding rule.

    DnsResolver

    Generator information: - Generated from: /dnsresolver/resource-manager/Microsoft.Network/stable/2022-07-01/dnsresolver.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​dnsResolvers/​{dnsResolverName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DnsResolver_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: The geo-location where the resource lives

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Resource tags.

    virtualNetwork
    DnsresolverSubResource

    VirtualNetwork: The reference to the virtual network. This cannot be changed after creation.

    status
    DnsResolver_STATUS

    DnsResolverProperties_ARM

    (Appears on:DnsResolver_Spec_ARM)

    Represents the properties of a DNS resolver.

    Field Description
    virtualNetwork
    DnsresolverSubResource_ARM

    VirtualNetwork: The reference to the virtual network. This cannot be changed after creation.

    DnsResolverProperties_DnsResolverState_STATUS (string alias)

    (Appears on:DnsResolverProperties_STATUS_ARM, DnsResolver_STATUS)

    Value Description

    "Connected"

    "Disconnected"

    DnsResolverProperties_STATUS_ARM

    (Appears on:DnsResolver_STATUS_ARM)

    Represents the properties of a DNS resolver.

    Field Description
    dnsResolverState
    DnsResolverProperties_DnsResolverState_STATUS

    DnsResolverState: The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.

    provisioningState
    DnsresolverProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.

    resourceGuid
    string

    ResourceGuid: The resourceGuid property of the DNS resolver resource.

    virtualNetwork
    DnsresolverSubResource_STATUS_ARM

    VirtualNetwork: The reference to the virtual network. This cannot be changed after creation.

    DnsResolver_STATUS

    (Appears on:DnsResolver)

    Describes a DNS resolver.

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    dnsResolverState
    DnsResolverProperties_DnsResolverState_STATUS

    DnsResolverState: The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.

    etag
    string

    Etag: ETag of the DNS resolver.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    provisioningState
    DnsresolverProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.

    resourceGuid
    string

    ResourceGuid: The resourceGuid property of the DNS resolver resource.

    systemData
    SystemData_STATUS

    SystemData: Metadata pertaining to creation and last modification of the resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    virtualNetwork
    DnsresolverSubResource_STATUS

    VirtualNetwork: The reference to the virtual network. This cannot be changed after creation.

    DnsResolver_STATUS_ARM

    Describes a DNS resolver.

    Field Description
    etag
    string

    Etag: ETag of the DNS resolver.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    DnsResolverProperties_STATUS_ARM

    Properties: Properties of the DNS resolver.

    systemData
    SystemData_STATUS_ARM

    SystemData: Metadata pertaining to creation and last modification of the resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    DnsResolver_Spec

    (Appears on:DnsResolver)

    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: The geo-location where the resource lives

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Resource tags.

    virtualNetwork
    DnsresolverSubResource

    VirtualNetwork: The reference to the virtual network. This cannot be changed after creation.

    DnsResolver_Spec_ARM

    Field Description
    location
    string

    Location: The geo-location where the resource lives

    name
    string
    properties
    DnsResolverProperties_ARM

    Properties: Properties of the DNS resolver.

    tags
    map[string]string

    Tags: Resource tags.

    DnsResolversInboundEndpoint

    Generator information: - Generated from: /dnsresolver/resource-manager/Microsoft.Network/stable/2022-07-01/dnsresolver.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​dnsResolvers/​{dnsResolverName}/​inboundEndpoints/​{inboundEndpointName}

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

    ipConfigurations
    []IpConfiguration

    IpConfigurations: IP configurations for the inbound endpoint.

    location
    string

    Location: The geo-location where the resource lives

    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/DnsResolver resource

    tags
    map[string]string

    Tags: Resource tags.

    status
    DnsResolvers_InboundEndpoint_STATUS

    DnsResolversOutboundEndpoint

    Generator information: - Generated from: /dnsresolver/resource-manager/Microsoft.Network/stable/2022-07-01/dnsresolver.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​dnsResolvers/​{dnsResolverName}/​outboundEndpoints/​{outboundEndpointName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DnsResolvers_OutboundEndpoint_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: The geo-location where the resource lives

    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/DnsResolver resource

    subnet
    DnsresolverSubResource

    Subnet: The reference to the subnet used for the outbound endpoint.

    tags
    map[string]string

    Tags: Resource tags.

    status
    DnsResolvers_OutboundEndpoint_STATUS

    DnsResolvers_InboundEndpoint_STATUS

    (Appears on:DnsResolversInboundEndpoint)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    etag
    string

    Etag: ETag of the inbound endpoint.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    ipConfigurations
    []IpConfiguration_STATUS

    IpConfigurations: IP configurations for the inbound endpoint.

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    provisioningState
    DnsresolverProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the inbound endpoint. This is a read-only property and any attempt to set this value will be ignored.

    resourceGuid
    string

    ResourceGuid: The resourceGuid property of the inbound endpoint resource.

    systemData
    SystemData_STATUS

    SystemData: Metadata pertaining to creation and last modification of the resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    DnsResolvers_InboundEndpoint_STATUS_ARM

    Field Description
    etag
    string

    Etag: ETag of the inbound endpoint.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    InboundEndpointProperties_STATUS_ARM

    Properties: Properties of the inbound endpoint.

    systemData
    SystemData_STATUS_ARM

    SystemData: Metadata pertaining to creation and last modification of the resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    DnsResolvers_InboundEndpoint_Spec

    (Appears on:DnsResolversInboundEndpoint)

    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.

    ipConfigurations
    []IpConfiguration

    IpConfigurations: IP configurations for the inbound endpoint.

    location
    string

    Location: The geo-location where the resource lives

    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/DnsResolver resource

    tags
    map[string]string

    Tags: Resource tags.

    DnsResolvers_InboundEndpoint_Spec_ARM

    Field Description
    location
    string

    Location: The geo-location where the resource lives

    name
    string
    properties
    InboundEndpointProperties_ARM

    Properties: Properties of the inbound endpoint.

    tags
    map[string]string

    Tags: Resource tags.

    DnsResolvers_OutboundEndpoint_STATUS

    (Appears on:DnsResolversOutboundEndpoint)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    etag
    string

    Etag: ETag of the outbound endpoint.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    provisioningState
    DnsresolverProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.

    resourceGuid
    string

    ResourceGuid: The resourceGuid property of the outbound endpoint resource.

    subnet
    DnsresolverSubResource_STATUS

    Subnet: The reference to the subnet used for the outbound endpoint.

    systemData
    SystemData_STATUS

    SystemData: Metadata pertaining to creation and last modification of the resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    DnsResolvers_OutboundEndpoint_STATUS_ARM

    Field Description
    etag
    string

    Etag: ETag of the outbound endpoint.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    OutboundEndpointProperties_STATUS_ARM

    Properties: Properties of the outbound endpoint.

    systemData
    SystemData_STATUS_ARM

    SystemData: Metadata pertaining to creation and last modification of the resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    DnsResolvers_OutboundEndpoint_Spec

    (Appears on:DnsResolversOutboundEndpoint)

    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: The geo-location where the resource lives

    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/DnsResolver resource

    subnet
    DnsresolverSubResource

    Subnet: The reference to the subnet used for the outbound endpoint.

    tags
    map[string]string

    Tags: Resource tags.

    DnsResolvers_OutboundEndpoint_Spec_ARM

    Field Description
    location
    string

    Location: The geo-location where the resource lives

    name
    string
    properties
    OutboundEndpointProperties_ARM

    Properties: Properties of the outbound endpoint.

    tags
    map[string]string

    Tags: Resource tags.

    DnsresolverProvisioningState_STATUS (string alias)

    (Appears on:DnsForwardingRulesetProperties_STATUS_ARM, DnsForwardingRuleset_STATUS, DnsForwardingRulesets_ForwardingRule_STATUS, DnsResolverProperties_STATUS_ARM, DnsResolver_STATUS, DnsResolvers_InboundEndpoint_STATUS, DnsResolvers_OutboundEndpoint_STATUS, ForwardingRuleProperties_STATUS_ARM, InboundEndpointProperties_STATUS_ARM, OutboundEndpointProperties_STATUS_ARM)

    The current provisioning state of the resource.

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    DnsresolverSubResource

    (Appears on:DnsForwardingRuleset_Spec, DnsResolver_Spec, DnsResolvers_OutboundEndpoint_Spec, IpConfiguration)

    Reference to another ARM resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    DnsresolverSubResource_ARM

    (Appears on:DnsForwardingRulesetProperties_ARM, DnsResolverProperties_ARM, IpConfiguration_ARM, OutboundEndpointProperties_ARM)

    Reference to another ARM resource.

    Field Description
    id
    string

    DnsresolverSubResource_STATUS

    (Appears on:DnsForwardingRuleset_STATUS, DnsResolver_STATUS, DnsResolvers_OutboundEndpoint_STATUS, IpConfiguration_STATUS)

    Reference to another ARM resource.

    Field Description
    id
    string

    Id: Resource ID.

    DnsresolverSubResource_STATUS_ARM

    (Appears on:DnsForwardingRulesetProperties_STATUS_ARM, DnsResolverProperties_STATUS_ARM, IpConfiguration_STATUS_ARM, OutboundEndpointProperties_STATUS_ARM)

    Reference to another ARM resource.

    Field Description
    id
    string

    Id: Resource ID.

    ExtendedLocation

    (Appears on:PrivateEndpoint_Spec, PrivateLinkService_Spec, PublicIPPrefix_Spec)

    ExtendedLocation complex type.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocationType (string alias)

    (Appears on:ExtendedLocation, ExtendedLocation_ARM)

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

    Value Description

    "EdgeZone"

    ExtendedLocationType_STATUS (string alias)

    (Appears on:ExtendedLocation_STATUS, ExtendedLocation_STATUS_ARM)

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

    Value Description

    "EdgeZone"

    ExtendedLocation_ARM

    (Appears on:PrivateEndpoint_Spec_ARM, PrivateLinkService_Spec_ARM, PublicIPPrefix_Spec_ARM)

    ExtendedLocation complex type.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType

    Type: The type of the extended location.

    ExtendedLocation_STATUS

    (Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded, PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded, PublicIPPrefix_STATUS)

    ExtendedLocation complex type.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_STATUS

    Type: The type of the extended location.

    ExtendedLocation_STATUS_ARM

    (Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded_ARM, PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded_ARM, PublicIPPrefix_STATUS_ARM)

    ExtendedLocation complex type.

    Field Description
    name
    string

    Name: The name of the extended location.

    type
    ExtendedLocationType_STATUS

    Type: The type of the extended location.

    ForwardingRuleProperties_ARM

    (Appears on:DnsForwardingRulesets_ForwardingRule_Spec_ARM)

    Represents the properties of a forwarding rule within a DNS forwarding ruleset.

    Field Description
    domainName
    string

    DomainName: The domain name for the forwarding rule.

    forwardingRuleState
    ForwardingRuleProperties_ForwardingRuleState

    ForwardingRuleState: The state of forwarding rule.

    metadata
    map[string]string

    Metadata: Metadata attached to the forwarding rule.

    targetDnsServers
    []TargetDnsServer_ARM

    TargetDnsServers: DNS servers to forward the DNS query to.

    ForwardingRuleProperties_ForwardingRuleState (string alias)

    (Appears on:DnsForwardingRulesets_ForwardingRule_Spec, ForwardingRuleProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ForwardingRuleProperties_ForwardingRuleState_STATUS (string alias)

    (Appears on:DnsForwardingRulesets_ForwardingRule_STATUS, ForwardingRuleProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ForwardingRuleProperties_STATUS_ARM

    (Appears on:DnsForwardingRulesets_ForwardingRule_STATUS_ARM)

    Represents the properties of a forwarding rule within a DNS forwarding ruleset.

    Field Description
    domainName
    string

    DomainName: The domain name for the forwarding rule.

    forwardingRuleState
    ForwardingRuleProperties_ForwardingRuleState_STATUS

    ForwardingRuleState: The state of forwarding rule.

    metadata
    map[string]string

    Metadata: Metadata attached to the forwarding rule.

    provisioningState
    DnsresolverProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.

    targetDnsServers
    []TargetDnsServer_STATUS_ARM

    TargetDnsServers: DNS servers to forward the DNS query to.

    FrontendIPConfiguration_PrivateLinkService_SubResourceEmbedded

    (Appears on:PrivateLinkService_Spec)

    Frontend IP address of the load balancer.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    FrontendIPConfiguration_PrivateLinkService_SubResourceEmbedded_ARM

    (Appears on:PrivateLinkServiceProperties_ARM)

    Frontend IP address of the load balancer.

    Field Description
    id
    string

    FrontendIPConfiguration_STATUS_PrivateLinkService_SubResourceEmbedded

    (Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)

    Frontend IP address of the load balancer.

    Field Description
    id
    string

    Id: Resource ID.

    FrontendIPConfiguration_STATUS_PrivateLinkService_SubResourceEmbedded_ARM

    (Appears on:PrivateLinkServiceProperties_STATUS_ARM)

    Frontend IP address of the load balancer.

    Field Description
    id
    string

    Id: Resource ID.

    IPAllocationMethod (string alias)

    (Appears on:ApplicationGatewayFrontendIPConfiguration, ApplicationGatewayFrontendIPConfigurationPropertiesFormat_ARM, BastionHostIPConfiguration, BastionHostIPConfigurationPropertiesFormat_ARM, PrivateLinkServiceIpConfiguration, PrivateLinkServiceIpConfigurationProperties_ARM)

    IP address allocation method.

    Value Description

    "Dynamic"

    "Static"

    IPAllocationMethod_STATUS (string alias)

    (Appears on:PrivateLinkServiceIpConfigurationProperties_STATUS_ARM, PrivateLinkServiceIpConfiguration_STATUS)

    IP address allocation method.

    Value Description

    "Dynamic"

    "Static"

    IPVersion (string alias)

    (Appears on:PrivateLinkServiceIpConfiguration, PrivateLinkServiceIpConfigurationProperties_ARM, PublicIPPrefixPropertiesFormat_ARM, PublicIPPrefix_Spec)

    IP address version.

    Value Description

    "IPv4"

    "IPv6"

    IPVersion_STATUS (string alias)

    (Appears on:PrivateLinkServiceIpConfigurationProperties_STATUS_ARM, PrivateLinkServiceIpConfiguration_STATUS, PublicIPPrefixPropertiesFormat_STATUS_ARM, PublicIPPrefix_STATUS)

    IP address version.

    Value Description

    "IPv4"

    "IPv6"

    InboundEndpointProperties_ARM

    (Appears on:DnsResolvers_InboundEndpoint_Spec_ARM)

    Represents the properties of an inbound endpoint for a DNS resolver.

    Field Description
    ipConfigurations
    []IpConfiguration_ARM

    IpConfigurations: IP configurations for the inbound endpoint.

    InboundEndpointProperties_STATUS_ARM

    (Appears on:DnsResolvers_InboundEndpoint_STATUS_ARM)

    Represents the properties of an inbound endpoint for a DNS resolver.

    Field Description
    ipConfigurations
    []IpConfiguration_STATUS_ARM

    IpConfigurations: IP configurations for the inbound endpoint.

    provisioningState
    DnsresolverProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the inbound endpoint. This is a read-only property and any attempt to set this value will be ignored.

    resourceGuid
    string

    ResourceGuid: The resourceGuid property of the inbound endpoint resource.

    IpConfiguration

    (Appears on:DnsResolvers_InboundEndpoint_Spec)

    IP configuration.

    Field Description
    privateIpAddress
    string

    PrivateIpAddress: Private IP address of the IP configuration.

    privateIpAllocationMethod
    IpConfiguration_PrivateIpAllocationMethod

    PrivateIpAllocationMethod: Private IP address allocation method.

    subnet
    DnsresolverSubResource

    Subnet: The reference to the subnet bound to the IP configuration.

    IpConfiguration_ARM

    (Appears on:InboundEndpointProperties_ARM)

    IP configuration.

    Field Description
    privateIpAddress
    string

    PrivateIpAddress: Private IP address of the IP configuration.

    privateIpAllocationMethod
    IpConfiguration_PrivateIpAllocationMethod

    PrivateIpAllocationMethod: Private IP address allocation method.

    subnet
    DnsresolverSubResource_ARM

    Subnet: The reference to the subnet bound to the IP configuration.

    IpConfiguration_PrivateIpAllocationMethod (string alias)

    (Appears on:IpConfiguration, IpConfiguration_ARM)

    Value Description

    "Dynamic"

    "Static"

    IpConfiguration_PrivateIpAllocationMethod_STATUS (string alias)

    (Appears on:IpConfiguration_STATUS, IpConfiguration_STATUS_ARM)

    Value Description

    "Dynamic"

    "Static"

    IpConfiguration_STATUS

    (Appears on:DnsResolvers_InboundEndpoint_STATUS)

    IP configuration.

    Field Description
    privateIpAddress
    string

    PrivateIpAddress: Private IP address of the IP configuration.

    privateIpAllocationMethod
    IpConfiguration_PrivateIpAllocationMethod_STATUS

    PrivateIpAllocationMethod: Private IP address allocation method.

    subnet
    DnsresolverSubResource_STATUS

    Subnet: The reference to the subnet bound to the IP configuration.

    IpConfiguration_STATUS_ARM

    (Appears on:InboundEndpointProperties_STATUS_ARM)

    IP configuration.

    Field Description
    privateIpAddress
    string

    PrivateIpAddress: Private IP address of the IP configuration.

    privateIpAllocationMethod
    IpConfiguration_PrivateIpAllocationMethod_STATUS

    PrivateIpAllocationMethod: Private IP address allocation method.

    subnet
    DnsresolverSubResource_STATUS_ARM

    Subnet: The reference to the subnet bound to the IP configuration.

    IpTag

    (Appears on:PublicIPPrefix_Spec)

    Contains the IpTag associated with the object.

    Field Description
    ipTagType
    string

    IpTagType: The IP tag type. Example: FirstPartyUsage.

    tag
    string

    Tag: The value of the IP tag associated with the public IP. Example: SQL.

    IpTag_ARM

    (Appears on:PublicIPPrefixPropertiesFormat_ARM)

    Contains the IpTag associated with the object.

    Field Description
    ipTagType
    string

    IpTagType: The IP tag type. Example: FirstPartyUsage.

    tag
    string

    Tag: The value of the IP tag associated with the public IP. Example: SQL.

    IpTag_STATUS

    (Appears on:PublicIPPrefix_STATUS)

    Contains the IpTag associated with the object.

    Field Description
    ipTagType
    string

    IpTagType: The IP tag type. Example: FirstPartyUsage.

    tag
    string

    Tag: The value of the IP tag associated with the public IP. Example: SQL.

    IpTag_STATUS_ARM

    (Appears on:PublicIPPrefixPropertiesFormat_STATUS_ARM)

    Contains the IpTag associated with the object.

    Field Description
    ipTagType
    string

    IpTagType: The IP tag type. Example: FirstPartyUsage.

    tag
    string

    Tag: The value of the IP tag associated with the public IP. Example: SQL.

    ManagedServiceIdentity

    (Appears on:ApplicationGateway_Spec)

    Identity for the resource.

    Field Description
    type
    ManagedServiceIdentity_Type

    Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine.

    userAssignedIdentities
    []UserAssignedIdentityDetails

    UserAssignedIdentities: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    ManagedServiceIdentity_ARM

    (Appears on:ApplicationGateway_Spec_ARM)

    Identity for the resource.

    Field Description
    type
    ManagedServiceIdentity_Type

    Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine.

    userAssignedIdentities
    map[string]./api/network/v1api20220701.UserAssignedIdentityDetails_ARM

    ManagedServiceIdentity_STATUS

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded)

    Identity for the resource.

    Field Description
    principalId
    string

    PrincipalId: The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

    tenantId
    string

    TenantId: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

    type
    ManagedServiceIdentity_Type_STATUS

    Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine.

    userAssignedIdentities
    map[string]./api/network/v1api20220701.ManagedServiceIdentity_UserAssignedIdentities_STATUS

    UserAssignedIdentities: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    ManagedServiceIdentity_STATUS_ARM

    (Appears on:ApplicationGateway_STATUS_ApplicationGateway_SubResourceEmbedded_ARM)

    Identity for the resource.

    Field Description
    principalId
    string

    PrincipalId: The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

    tenantId
    string

    TenantId: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

    type
    ManagedServiceIdentity_Type_STATUS

    Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the virtual machine.

    userAssignedIdentities
    map[string]./api/network/v1api20220701.ManagedServiceIdentity_UserAssignedIdentities_STATUS_ARM

    UserAssignedIdentities: The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

    ManagedServiceIdentity_Type (string alias)

    (Appears on:ManagedServiceIdentity, ManagedServiceIdentity_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    ManagedServiceIdentity_Type_STATUS (string alias)

    (Appears on:ManagedServiceIdentity_STATUS, ManagedServiceIdentity_STATUS_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    ManagedServiceIdentity_UserAssignedIdentities_STATUS

    (Appears on:ManagedServiceIdentity_STATUS)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    ManagedServiceIdentity_UserAssignedIdentities_STATUS_ARM

    (Appears on:ManagedServiceIdentity_STATUS_ARM)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    NatGateway

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

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

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the nat gateway.

    location
    string

    Location: Resource location.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    publicIpAddresses
    []ApplicationGatewaySubResource

    PublicIpAddresses: An array of public ip addresses associated with the nat gateway resource.

    publicIpPrefixes
    []ApplicationGatewaySubResource

    PublicIpPrefixes: An array of public ip prefixes associated with the nat gateway resource.

    sku
    NatGatewaySku

    Sku: The nat gateway SKU.

    tags
    map[string]string

    Tags: Resource tags.

    zones
    []string

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

    status
    NatGateway_STATUS

    NatGatewayPropertiesFormat_ARM

    (Appears on:NatGateway_Spec_ARM)

    Nat Gateway properties.

    Field Description
    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the nat gateway.

    publicIpAddresses
    []ApplicationGatewaySubResource_ARM

    PublicIpAddresses: An array of public ip addresses associated with the nat gateway resource.

    publicIpPrefixes
    []ApplicationGatewaySubResource_ARM

    PublicIpPrefixes: An array of public ip prefixes associated with the nat gateway resource.

    NatGatewayPropertiesFormat_STATUS_ARM

    (Appears on:NatGateway_STATUS_ARM)

    Nat Gateway properties.

    Field Description
    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the nat gateway.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

    ProvisioningState: The provisioning state of the NAT gateway resource.

    publicIpAddresses
    []ApplicationGatewaySubResource_STATUS_ARM

    PublicIpAddresses: An array of public ip addresses associated with the nat gateway resource.

    publicIpPrefixes
    []ApplicationGatewaySubResource_STATUS_ARM

    PublicIpPrefixes: An array of public ip prefixes associated with the nat gateway resource.

    resourceGuid
    string

    ResourceGuid: The resource GUID property of the NAT gateway resource.

    subnets
    []ApplicationGatewaySubResource_STATUS_ARM

    Subnets: An array of references to the subnets using this nat gateway resource.

    NatGatewaySku

    (Appears on:NatGateway_Spec)

    SKU of nat gateway.

    Field Description
    name
    NatGatewaySku_Name

    Name: Name of Nat Gateway SKU.

    NatGatewaySku_ARM

    (Appears on:NatGateway_Spec_ARM)

    SKU of nat gateway.

    Field Description
    name
    NatGatewaySku_Name

    Name: Name of Nat Gateway SKU.

    NatGatewaySku_Name (string alias)

    (Appears on:NatGatewaySku, NatGatewaySku_ARM)

    Value Description

    "Standard"

    NatGatewaySku_Name_STATUS (string alias)

    (Appears on:NatGatewaySku_STATUS, NatGatewaySku_STATUS_ARM)

    Value Description

    "Standard"

    NatGatewaySku_STATUS

    (Appears on:NatGateway_STATUS)

    SKU of nat gateway.

    Field Description
    name
    NatGatewaySku_Name_STATUS

    Name: Name of Nat Gateway SKU.

    NatGatewaySku_STATUS_ARM

    (Appears on:NatGateway_STATUS_ARM)

    SKU of nat gateway.

    Field Description
    name
    NatGatewaySku_Name_STATUS

    Name: Name of Nat Gateway SKU.

    NatGatewaySpec_PublicIPPrefix_SubResourceEmbedded

    (Appears on:PublicIPPrefix_Spec)

    Nat Gateway resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    NatGatewaySpec_PublicIPPrefix_SubResourceEmbedded_ARM

    (Appears on:PublicIPPrefixPropertiesFormat_ARM)

    Nat Gateway resource.

    Field Description
    id
    string

    NatGateway_STATUS

    (Appears on:NatGateway)

    Nat Gateway resource.

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    etag
    string

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

    id
    string

    Id: Resource ID.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the nat gateway.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

    ProvisioningState: The provisioning state of the NAT gateway resource.

    publicIpAddresses
    []ApplicationGatewaySubResource_STATUS

    PublicIpAddresses: An array of public ip addresses associated with the nat gateway resource.

    publicIpPrefixes
    []ApplicationGatewaySubResource_STATUS

    PublicIpPrefixes: An array of public ip prefixes associated with the nat gateway resource.

    resourceGuid
    string

    ResourceGuid: The resource GUID property of the NAT gateway resource.

    sku
    NatGatewaySku_STATUS

    Sku: The nat gateway SKU.

    subnets
    []ApplicationGatewaySubResource_STATUS

    Subnets: An array of references to the subnets using this nat gateway resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    zones
    []string

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

    NatGateway_STATUS_ARM

    Nat Gateway resource.

    Field Description
    etag
    string

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

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    NatGatewayPropertiesFormat_STATUS_ARM

    Properties: Nat Gateway properties.

    sku
    NatGatewaySku_STATUS_ARM

    Sku: The nat gateway SKU.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    zones
    []string

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

    NatGateway_STATUS_PublicIPPrefix_SubResourceEmbedded

    (Appears on:PublicIPPrefix_STATUS)

    Nat Gateway resource.

    Field Description
    id
    string

    Id: Resource ID.

    NatGateway_STATUS_PublicIPPrefix_SubResourceEmbedded_ARM

    (Appears on:PublicIPPrefixPropertiesFormat_STATUS_ARM)

    Nat Gateway resource.

    Field Description
    id
    string

    Id: Resource ID.

    NatGateway_Spec

    (Appears on:NatGateway)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    idleTimeoutInMinutes
    int

    IdleTimeoutInMinutes: The idle timeout of the nat gateway.

    location
    string

    Location: Resource location.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    publicIpAddresses
    []ApplicationGatewaySubResource

    PublicIpAddresses: An array of public ip addresses associated with the nat gateway resource.

    publicIpPrefixes
    []ApplicationGatewaySubResource

    PublicIpPrefixes: An array of public ip prefixes associated with the nat gateway resource.

    sku
    NatGatewaySku

    Sku: The nat gateway SKU.

    tags
    map[string]string

    Tags: Resource tags.

    zones
    []string

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

    NatGateway_Spec_ARM

    Field Description
    location
    string

    Location: Resource location.

    name
    string
    properties
    NatGatewayPropertiesFormat_ARM

    Properties: Nat Gateway properties.

    sku
    NatGatewaySku_ARM

    Sku: The nat gateway SKU.

    tags
    map[string]string

    Tags: Resource tags.

    zones
    []string

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

    NetworkInterface_STATUS_PrivateEndpoint_SubResourceEmbedded

    (Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)

    A network interface in a resource group.

    Field Description
    id
    string

    Id: Resource ID.

    NetworkInterface_STATUS_PrivateEndpoint_SubResourceEmbedded_ARM

    (Appears on:PrivateEndpointProperties_STATUS_ARM)

    A network interface in a resource group.

    Field Description
    id
    string

    Id: Resource ID.

    NetworkInterface_STATUS_PrivateLinkService_SubResourceEmbedded

    (Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)

    A network interface in a resource group.

    Field Description
    id
    string

    Id: Resource ID.

    NetworkInterface_STATUS_PrivateLinkService_SubResourceEmbedded_ARM

    (Appears on:PrivateLinkServiceProperties_STATUS_ARM)

    A network interface in a resource group.

    Field Description
    id
    string

    Id: Resource ID.

    OutboundEndpointProperties_ARM

    (Appears on:DnsResolvers_OutboundEndpoint_Spec_ARM)

    Represents the properties of an outbound endpoint for a DNS resolver.

    Field Description
    subnet
    DnsresolverSubResource_ARM

    Subnet: The reference to the subnet used for the outbound endpoint.

    OutboundEndpointProperties_STATUS_ARM

    (Appears on:DnsResolvers_OutboundEndpoint_STATUS_ARM)

    Represents the properties of an outbound endpoint for a DNS resolver.

    Field Description
    provisioningState
    DnsresolverProvisioningState_STATUS

    ProvisioningState: The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.

    resourceGuid
    string

    ResourceGuid: The resourceGuid property of the outbound endpoint resource.

    subnet
    DnsresolverSubResource_STATUS_ARM

    Subnet: The reference to the subnet used for the outbound endpoint.

    PolicyNameEnum (string alias)

    (Appears on:ApplicationGatewaySslPolicy, ApplicationGatewaySslPolicy_ARM)

    Ssl predefined policy name enums.

    Value Description

    "AppGwSslPolicy20150501"

    "AppGwSslPolicy20170401"

    "AppGwSslPolicy20170401S"

    "AppGwSslPolicy20220101"

    "AppGwSslPolicy20220101S"

    PolicyNameEnum_STATUS (string alias)

    (Appears on:ApplicationGatewaySslPolicy_STATUS, ApplicationGatewaySslPolicy_STATUS_ARM)

    Ssl predefined policy name enums.

    Value Description

    "AppGwSslPolicy20150501"

    "AppGwSslPolicy20170401"

    "AppGwSslPolicy20170401S"

    "AppGwSslPolicy20220101"

    "AppGwSslPolicy20220101S"

    PrivateDnsZoneConfig

    (Appears on:PrivateEndpoints_PrivateDnsZoneGroup_Spec)

    PrivateDnsZoneConfig resource.

    Field Description
    name
    string

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

    privateDnsZoneReference
    genruntime.ResourceReference

    PrivateDnsZoneReference: The resource id of the private dns zone.

    PrivateDnsZoneConfig_ARM

    (Appears on:PrivateDnsZoneGroupPropertiesFormat_ARM)

    PrivateDnsZoneConfig resource.

    Field Description
    name
    string

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

    properties
    PrivateDnsZonePropertiesFormat_ARM

    Properties: Properties of the private dns zone configuration.

    PrivateDnsZoneConfig_STATUS

    (Appears on:PrivateEndpoints_PrivateDnsZoneGroup_STATUS)

    PrivateDnsZoneConfig resource.

    Field Description
    name
    string

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

    privateDnsZoneId
    string

    PrivateDnsZoneId: The resource id of the private dns zone.

    recordSets
    []RecordSet_STATUS

    RecordSets: A collection of information regarding a recordSet, holding information to identify private resources.

    PrivateDnsZoneConfig_STATUS_ARM

    (Appears on:PrivateDnsZoneGroupPropertiesFormat_STATUS_ARM)

    PrivateDnsZoneConfig resource.

    Field Description
    name
    string

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

    properties
    PrivateDnsZonePropertiesFormat_STATUS_ARM

    Properties: Properties of the private dns zone configuration.

    PrivateDnsZoneGroupPropertiesFormat_ARM

    (Appears on:PrivateEndpoints_PrivateDnsZoneGroup_Spec_ARM)

    Properties of the private dns zone group.

    Field Description
    privateDnsZoneConfigs
    []PrivateDnsZoneConfig_ARM

    PrivateDnsZoneConfigs: A collection of private dns zone configurations of the private dns zone group.

    PrivateDnsZoneGroupPropertiesFormat_STATUS_ARM

    (Appears on:PrivateEndpoints_PrivateDnsZoneGroup_STATUS_ARM)

    Properties of the private dns zone group.

    Field Description
    privateDnsZoneConfigs
    []PrivateDnsZoneConfig_STATUS_ARM

    PrivateDnsZoneConfigs: A collection of private dns zone configurations of the private dns zone group.

    provisioningState
    PrivateEndpointProvisioningState_STATUS

    ProvisioningState: The provisioning state of the private dns zone group resource.

    PrivateDnsZonePropertiesFormat_ARM

    (Appears on:PrivateDnsZoneConfig_ARM)

    Properties of the private dns zone configuration resource.

    Field Description
    privateDnsZoneId
    string

    PrivateDnsZonePropertiesFormat_STATUS_ARM

    (Appears on:PrivateDnsZoneConfig_STATUS_ARM)

    Properties of the private dns zone configuration resource.

    Field Description
    privateDnsZoneId
    string

    PrivateDnsZoneId: The resource id of the private dns zone.

    recordSets
    []RecordSet_STATUS_ARM

    RecordSets: A collection of information regarding a recordSet, holding information to identify private resources.

    PrivateEndpoint

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

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


    applicationSecurityGroups
    []ApplicationSecurityGroupSpec_PrivateEndpoint_SubResourceEmbedded

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

    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    customNetworkInterfaceName
    string

    CustomNetworkInterfaceName: The custom name of the network interface attached to the private endpoint.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the load balancer.

    ipConfigurations
    []PrivateEndpointIPConfiguration

    IpConfigurations: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints.

    location
    string

    Location: Resource location.

    manualPrivateLinkServiceConnections
    []PrivateLinkServiceConnection

    ManualPrivateLinkServiceConnections: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    privateLinkServiceConnections
    []PrivateLinkServiceConnection

    PrivateLinkServiceConnections: A grouping of information about the connection to the remote resource.

    subnet
    Subnet_PrivateEndpoint_SubResourceEmbedded

    Subnet: The ID of the subnet from which the private IP will be allocated.

    tags
    map[string]string

    Tags: Resource tags.

    status
    PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded

    PrivateEndpointConnection_STATUS

    (Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)

    PrivateEndpointConnection resource.

    Field Description
    id
    string

    Id: Resource ID.

    PrivateEndpointConnection_STATUS_ARM

    (Appears on:PrivateLinkServiceProperties_STATUS_ARM)

    PrivateEndpointConnection resource.

    Field Description
    id
    string

    Id: Resource ID.

    PrivateEndpointIPConfiguration

    (Appears on:PrivateEndpoint_Spec)

    An IP Configuration of the private endpoint.

    Field Description
    groupId
    string

    GroupId: The ID of a group obtained from the remote resource that this private endpoint should connect to.

    memberName
    string

    MemberName: The member name of a group obtained from the remote resource that this private endpoint should connect to.

    name
    string

    Name: The name of the resource that is unique within a resource group.

    privateIPAddress
    string

    PrivateIPAddress: A private ip address obtained from the private endpoint’s subnet.

    PrivateEndpointIPConfigurationProperties_ARM

    (Appears on:PrivateEndpointIPConfiguration_ARM)

    Properties of an IP Configuration of the private endpoint.

    Field Description
    groupId
    string

    GroupId: The ID of a group obtained from the remote resource that this private endpoint should connect to.

    memberName
    string

    MemberName: The member name of a group obtained from the remote resource that this private endpoint should connect to.

    privateIPAddress
    string

    PrivateIPAddress: A private ip address obtained from the private endpoint’s subnet.

    PrivateEndpointIPConfigurationProperties_STATUS_ARM

    (Appears on:PrivateEndpointIPConfiguration_STATUS_ARM)

    Properties of an IP Configuration of the private endpoint.

    Field Description
    groupId
    string

    GroupId: The ID of a group obtained from the remote resource that this private endpoint should connect to.

    memberName
    string

    MemberName: The member name of a group obtained from the remote resource that this private endpoint should connect to.

    privateIPAddress
    string

    PrivateIPAddress: A private ip address obtained from the private endpoint’s subnet.

    PrivateEndpointIPConfiguration_ARM

    (Appears on:PrivateEndpointProperties_ARM)

    An IP Configuration of the private endpoint.

    Field Description
    name
    string

    Name: The name of the resource that is unique within a resource group.

    properties
    PrivateEndpointIPConfigurationProperties_ARM

    Properties: Properties of private endpoint IP configurations.

    PrivateEndpointIPConfiguration_STATUS

    (Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)

    An IP Configuration of the private endpoint.

    Field Description
    etag
    string

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

    groupId
    string

    GroupId: The ID of a group obtained from the remote resource that this private endpoint should connect to.

    memberName
    string

    MemberName: The member name of a group obtained from the remote resource that this private endpoint should connect to.

    name
    string

    Name: The name of the resource that is unique within a resource group.

    privateIPAddress
    string

    PrivateIPAddress: A private ip address obtained from the private endpoint’s subnet.

    type
    string

    Type: The resource type.

    PrivateEndpointIPConfiguration_STATUS_ARM

    (Appears on:PrivateEndpointProperties_STATUS_ARM)

    An IP Configuration of the private endpoint.

    Field Description
    etag
    string

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

    name
    string

    Name: The name of the resource that is unique within a resource group.

    properties
    PrivateEndpointIPConfigurationProperties_STATUS_ARM

    Properties: Properties of private endpoint IP configurations.

    type
    string

    Type: The resource type.

    PrivateEndpointProperties_ARM

    (Appears on:PrivateEndpoint_Spec_ARM)

    Properties of the private endpoint.

    Field Description
    applicationSecurityGroups
    []ApplicationSecurityGroupSpec_PrivateEndpoint_SubResourceEmbedded_ARM

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

    customNetworkInterfaceName
    string

    CustomNetworkInterfaceName: The custom name of the network interface attached to the private endpoint.

    ipConfigurations
    []PrivateEndpointIPConfiguration_ARM

    IpConfigurations: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints.

    manualPrivateLinkServiceConnections
    []PrivateLinkServiceConnection_ARM

    ManualPrivateLinkServiceConnections: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.

    privateLinkServiceConnections
    []PrivateLinkServiceConnection_ARM

    PrivateLinkServiceConnections: A grouping of information about the connection to the remote resource.

    subnet
    Subnet_PrivateEndpoint_SubResourceEmbedded_ARM

    Subnet: The ID of the subnet from which the private IP will be allocated.

    PrivateEndpointProperties_STATUS_ARM

    (Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded_ARM)

    Properties of the private endpoint.

    Field Description
    applicationSecurityGroups
    []ApplicationSecurityGroup_STATUS_PrivateEndpoint_SubResourceEmbedded_ARM

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

    customDnsConfigs
    []CustomDnsConfigPropertiesFormat_STATUS_ARM

    CustomDnsConfigs: An array of custom dns configurations.

    customNetworkInterfaceName
    string

    CustomNetworkInterfaceName: The custom name of the network interface attached to the private endpoint.

    ipConfigurations
    []PrivateEndpointIPConfiguration_STATUS_ARM

    IpConfigurations: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints.

    manualPrivateLinkServiceConnections
    []PrivateLinkServiceConnection_STATUS_ARM

    ManualPrivateLinkServiceConnections: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.

    networkInterfaces
    []NetworkInterface_STATUS_PrivateEndpoint_SubResourceEmbedded_ARM

    NetworkInterfaces: An array of references to the network interfaces created for this private endpoint.

    privateLinkServiceConnections
    []PrivateLinkServiceConnection_STATUS_ARM

    PrivateLinkServiceConnections: A grouping of information about the connection to the remote resource.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

    ProvisioningState: The provisioning state of the private endpoint resource.

    subnet
    Subnet_STATUS_PrivateEndpoint_SubResourceEmbedded_ARM

    Subnet: The ID of the subnet from which the private IP will be allocated.

    PrivateEndpointProvisioningState_STATUS (string alias)

    (Appears on:PrivateDnsZoneGroupPropertiesFormat_STATUS_ARM, PrivateEndpoints_PrivateDnsZoneGroup_STATUS, RecordSet_STATUS, RecordSet_STATUS_ARM)

    The current provisioning state.

    Value Description

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded

    (Appears on:PrivateEndpoint)

    Private endpoint resource.

    Field Description
    applicationSecurityGroups
    []ApplicationSecurityGroup_STATUS_PrivateEndpoint_SubResourceEmbedded

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

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    customDnsConfigs
    []CustomDnsConfigPropertiesFormat_STATUS

    CustomDnsConfigs: An array of custom dns configurations.

    customNetworkInterfaceName
    string

    CustomNetworkInterfaceName: The custom name of the network interface attached to the private endpoint.

    etag
    string

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

    extendedLocation
    ExtendedLocation_STATUS

    ExtendedLocation: The extended location of the load balancer.

    id
    string

    Id: Resource ID.

    ipConfigurations
    []PrivateEndpointIPConfiguration_STATUS

    IpConfigurations: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints.

    location
    string

    Location: Resource location.

    manualPrivateLinkServiceConnections
    []PrivateLinkServiceConnection_STATUS

    ManualPrivateLinkServiceConnections: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.

    name
    string

    Name: Resource name.

    networkInterfaces
    []NetworkInterface_STATUS_PrivateEndpoint_SubResourceEmbedded

    NetworkInterfaces: An array of references to the network interfaces created for this private endpoint.

    privateLinkServiceConnections
    []PrivateLinkServiceConnection_STATUS

    PrivateLinkServiceConnections: A grouping of information about the connection to the remote resource.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

    ProvisioningState: The provisioning state of the private endpoint resource.

    subnet
    Subnet_STATUS_PrivateEndpoint_SubResourceEmbedded

    Subnet: The ID of the subnet from which the private IP will be allocated.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded_ARM

    Private endpoint resource.

    Field Description
    etag
    string

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

    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of the load balancer.

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    PrivateEndpointProperties_STATUS_ARM

    Properties: Properties of the private endpoint.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    PrivateEndpoint_Spec

    (Appears on:PrivateEndpoint)

    Field Description
    applicationSecurityGroups
    []ApplicationSecurityGroupSpec_PrivateEndpoint_SubResourceEmbedded

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

    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    customNetworkInterfaceName
    string

    CustomNetworkInterfaceName: The custom name of the network interface attached to the private endpoint.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the load balancer.

    ipConfigurations
    []PrivateEndpointIPConfiguration

    IpConfigurations: A list of IP configurations of the private endpoint. This will be used to map to the First Party Service’s endpoints.

    location
    string

    Location: Resource location.

    manualPrivateLinkServiceConnections
    []PrivateLinkServiceConnection

    ManualPrivateLinkServiceConnections: A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    privateLinkServiceConnections
    []PrivateLinkServiceConnection

    PrivateLinkServiceConnections: A grouping of information about the connection to the remote resource.

    subnet
    Subnet_PrivateEndpoint_SubResourceEmbedded

    Subnet: The ID of the subnet from which the private IP will be allocated.

    tags
    map[string]string

    Tags: Resource tags.

    PrivateEndpoint_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of the load balancer.

    location
    string

    Location: Resource location.

    name
    string
    properties
    PrivateEndpointProperties_ARM

    Properties: Properties of the private endpoint.

    tags
    map[string]string

    Tags: Resource tags.

    PrivateEndpointsPrivateDnsZoneGroup

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

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

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/PrivateEndpoint resource

    privateDnsZoneConfigs
    []PrivateDnsZoneConfig

    PrivateDnsZoneConfigs: A collection of private dns zone configurations of the private dns zone group.

    status
    PrivateEndpoints_PrivateDnsZoneGroup_STATUS

    PrivateEndpoints_PrivateDnsZoneGroup_STATUS

    (Appears on:PrivateEndpointsPrivateDnsZoneGroup)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    etag
    string

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

    id
    string

    Id: Resource ID.

    name
    string

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

    privateDnsZoneConfigs
    []PrivateDnsZoneConfig_STATUS

    PrivateDnsZoneConfigs: A collection of private dns zone configurations of the private dns zone group.

    provisioningState
    PrivateEndpointProvisioningState_STATUS

    ProvisioningState: The provisioning state of the private dns zone group resource.

    PrivateEndpoints_PrivateDnsZoneGroup_STATUS_ARM

    Field Description
    etag
    string

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

    id
    string

    Id: Resource ID.

    name
    string

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

    properties
    PrivateDnsZoneGroupPropertiesFormat_STATUS_ARM

    Properties: Properties of the private dns zone group.

    PrivateEndpoints_PrivateDnsZoneGroup_Spec

    (Appears on:PrivateEndpointsPrivateDnsZoneGroup)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/PrivateEndpoint resource

    privateDnsZoneConfigs
    []PrivateDnsZoneConfig

    PrivateDnsZoneConfigs: A collection of private dns zone configurations of the private dns zone group.

    PrivateEndpoints_PrivateDnsZoneGroup_Spec_ARM

    Field Description
    name
    string

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

    properties
    PrivateDnsZoneGroupPropertiesFormat_ARM

    Properties: Properties of the private dns zone group.

    PrivateLinkService

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

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


    autoApproval
    ResourceSet

    AutoApproval: The auto-approval list of the private link service.

    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    enableProxyProtocol
    bool

    EnableProxyProtocol: Whether the private link service is enabled for proxy protocol or not.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the load balancer.

    fqdns
    []string

    Fqdns: The list of Fqdn.

    ipConfigurations
    []PrivateLinkServiceIpConfiguration

    IpConfigurations: An array of private link service IP configurations.

    loadBalancerFrontendIpConfigurations
    []FrontendIPConfiguration_PrivateLinkService_SubResourceEmbedded

    LoadBalancerFrontendIpConfigurations: An array of references to the load balancer IP configurations.

    location
    string

    Location: Resource location.

    operatorSpec
    PrivateLinkServiceOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Resource tags.

    visibility
    ResourceSet

    Visibility: The visibility list of the private link service.

    status
    PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded

    PrivateLinkServiceConnection

    (Appears on:PrivateEndpoint_Spec)

    PrivateLinkServiceConnection resource.

    Field Description
    groupIds
    []string

    GroupIds: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.

    name
    string

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

    privateLinkServiceConnectionState
    PrivateLinkServiceConnectionState

    PrivateLinkServiceConnectionState: A collection of read-only information about the state of the connection to the remote resource.

    privateLinkServiceReference
    genruntime.ResourceReference

    PrivateLinkServiceReference: The resource id of private link service.

    requestMessage
    string

    RequestMessage: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.

    PrivateLinkServiceConnectionProperties_ARM

    (Appears on:PrivateLinkServiceConnection_ARM)

    Properties of the PrivateLinkServiceConnection.

    Field Description
    groupIds
    []string

    GroupIds: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.

    privateLinkServiceConnectionState
    PrivateLinkServiceConnectionState_ARM

    PrivateLinkServiceConnectionState: A collection of read-only information about the state of the connection to the remote resource.

    privateLinkServiceId
    string
    requestMessage
    string

    RequestMessage: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.

    PrivateLinkServiceConnectionProperties_STATUS_ARM

    (Appears on:PrivateLinkServiceConnection_STATUS_ARM)

    Properties of the PrivateLinkServiceConnection.

    Field Description
    groupIds
    []string

    GroupIds: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.

    privateLinkServiceConnectionState
    PrivateLinkServiceConnectionState_STATUS_ARM

    PrivateLinkServiceConnectionState: A collection of read-only information about the state of the connection to the remote resource.

    privateLinkServiceId
    string

    PrivateLinkServiceId: The resource id of private link service.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

    ProvisioningState: The provisioning state of the private link service connection resource.

    requestMessage
    string

    RequestMessage: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.

    PrivateLinkServiceConnectionState

    (Appears on:PrivateLinkServiceConnection)

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

    Field Description
    actionsRequired
    string

    ActionsRequired: A message indicating if changes on the service provider require any updates on the consumer.

    description
    string

    Description: The reason for approval/rejection of the connection.

    status
    string

    Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    PrivateLinkServiceConnectionState_ARM

    (Appears on:PrivateLinkServiceConnectionProperties_ARM)

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

    Field Description
    actionsRequired
    string

    ActionsRequired: A message indicating if changes on the service provider require any updates on the consumer.

    description
    string

    Description: The reason for approval/rejection of the connection.

    status
    string

    Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    PrivateLinkServiceConnectionState_STATUS

    (Appears on:PrivateLinkServiceConnection_STATUS)

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

    Field Description
    actionsRequired
    string

    ActionsRequired: A message indicating if changes on the service provider require any updates on the consumer.

    description
    string

    Description: The reason for approval/rejection of the connection.

    status
    string

    Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    PrivateLinkServiceConnectionState_STATUS_ARM

    (Appears on:PrivateLinkServiceConnectionProperties_STATUS_ARM)

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

    Field Description
    actionsRequired
    string

    ActionsRequired: A message indicating if changes on the service provider require any updates on the consumer.

    description
    string

    Description: The reason for approval/rejection of the connection.

    status
    string

    Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    PrivateLinkServiceConnection_ARM

    (Appears on:PrivateEndpointProperties_ARM)

    PrivateLinkServiceConnection resource.

    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
    PrivateLinkServiceConnectionProperties_ARM

    Properties: Properties of the private link service connection.

    PrivateLinkServiceConnection_STATUS

    (Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)

    PrivateLinkServiceConnection resource.

    Field Description
    etag
    string

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

    groupIds
    []string

    GroupIds: The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.

    id
    string

    Id: Resource ID.

    name
    string

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

    privateLinkServiceConnectionState
    PrivateLinkServiceConnectionState_STATUS

    PrivateLinkServiceConnectionState: A collection of read-only information about the state of the connection to the remote resource.

    privateLinkServiceId
    string

    PrivateLinkServiceId: The resource id of private link service.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

    ProvisioningState: The provisioning state of the private link service connection resource.

    requestMessage
    string

    RequestMessage: A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.

    type
    string

    Type: The resource type.

    PrivateLinkServiceConnection_STATUS_ARM

    (Appears on:PrivateEndpointProperties_STATUS_ARM)

    PrivateLinkServiceConnection resource.

    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
    PrivateLinkServiceConnectionProperties_STATUS_ARM

    Properties: Properties of the private link service connection.

    type
    string

    Type: The resource type.

    PrivateLinkServiceIpConfiguration

    (Appears on:PrivateLinkService_Spec)

    The private link service ip configuration.

    Field Description
    name
    string

    Name: The name of private link service ip configuration.

    primary
    bool

    Primary: Whether the ip configuration is primary or not.

    privateIPAddress
    string

    PrivateIPAddress: The private IP address of the IP configuration.

    privateIPAddressVersion
    IPVersion

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

    privateIPAllocationMethod
    IPAllocationMethod

    PrivateIPAllocationMethod: The private IP address allocation method.

    subnet
    Subnet_PrivateLinkService_SubResourceEmbedded

    Subnet: The reference to the subnet resource.

    PrivateLinkServiceIpConfigurationProperties_ARM

    (Appears on:PrivateLinkServiceIpConfiguration_ARM)

    Properties of private link service IP configuration.

    Field Description
    primary
    bool

    Primary: Whether the ip configuration is primary or not.

    privateIPAddress
    string

    PrivateIPAddress: The private IP address of the IP configuration.

    privateIPAddressVersion
    IPVersion

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

    privateIPAllocationMethod
    IPAllocationMethod

    PrivateIPAllocationMethod: The private IP address allocation method.

    subnet
    Subnet_PrivateLinkService_SubResourceEmbedded_ARM

    Subnet: The reference to the subnet resource.

    PrivateLinkServiceIpConfigurationProperties_STATUS_ARM

    (Appears on:PrivateLinkServiceIpConfiguration_STATUS_ARM)

    Properties of private link service IP configuration.

    Field Description
    primary
    bool

    Primary: Whether the ip configuration is primary or not.

    privateIPAddress
    string

    PrivateIPAddress: The private IP address of the IP configuration.

    privateIPAddressVersion
    IPVersion_STATUS

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

    privateIPAllocationMethod
    IPAllocationMethod_STATUS

    PrivateIPAllocationMethod: The private IP address allocation method.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

    ProvisioningState: The provisioning state of the private link service IP configuration resource.

    subnet
    Subnet_STATUS_PrivateLinkService_SubResourceEmbedded_ARM

    Subnet: The reference to the subnet resource.

    PrivateLinkServiceIpConfiguration_ARM

    (Appears on:PrivateLinkServiceProperties_ARM)

    The private link service ip configuration.

    Field Description
    name
    string

    Name: The name of private link service ip configuration.

    properties
    PrivateLinkServiceIpConfigurationProperties_ARM

    Properties: Properties of the private link service ip configuration.

    PrivateLinkServiceIpConfiguration_STATUS

    (Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)

    The private link service ip configuration.

    Field Description
    etag
    string

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

    id
    string

    Id: Resource ID.

    name
    string

    Name: The name of private link service ip configuration.

    primary
    bool

    Primary: Whether the ip configuration is primary or not.

    privateIPAddress
    string

    PrivateIPAddress: The private IP address of the IP configuration.

    privateIPAddressVersion
    IPVersion_STATUS

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

    privateIPAllocationMethod
    IPAllocationMethod_STATUS

    PrivateIPAllocationMethod: The private IP address allocation method.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

    ProvisioningState: The provisioning state of the private link service IP configuration resource.

    subnet
    Subnet_STATUS_PrivateLinkService_SubResourceEmbedded

    Subnet: The reference to the subnet resource.

    type
    string

    Type: The resource type.

    PrivateLinkServiceIpConfiguration_STATUS_ARM

    (Appears on:PrivateLinkServiceProperties_STATUS_ARM)

    The private link service ip configuration.

    Field Description
    etag
    string

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

    id
    string

    Id: Resource ID.

    name
    string

    Name: The name of private link service ip configuration.

    properties
    PrivateLinkServiceIpConfigurationProperties_STATUS_ARM

    Properties: Properties of the private link service ip configuration.

    type
    string

    Type: The resource type.

    PrivateLinkServiceOperatorConfigMaps

    (Appears on:PrivateLinkServiceOperatorSpec)

    Field Description
    alias
    genruntime.ConfigMapDestination

    Alias: indicates where the Alias config map should be placed. If omitted, no config map will be created.

    PrivateLinkServiceOperatorSpec

    (Appears on:PrivateLinkService_Spec)

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

    Field Description
    configMaps
    PrivateLinkServiceOperatorConfigMaps

    ConfigMaps: configures where to place operator written ConfigMaps.

    PrivateLinkServiceProperties_ARM

    (Appears on:PrivateLinkService_Spec_ARM)

    Properties of the private link service.

    Field Description
    autoApproval
    ResourceSet_ARM

    AutoApproval: The auto-approval list of the private link service.

    enableProxyProtocol
    bool

    EnableProxyProtocol: Whether the private link service is enabled for proxy protocol or not.

    fqdns
    []string

    Fqdns: The list of Fqdn.

    ipConfigurations
    []PrivateLinkServiceIpConfiguration_ARM

    IpConfigurations: An array of private link service IP configurations.

    loadBalancerFrontendIpConfigurations
    []FrontendIPConfiguration_PrivateLinkService_SubResourceEmbedded_ARM

    LoadBalancerFrontendIpConfigurations: An array of references to the load balancer IP configurations.

    visibility
    ResourceSet_ARM

    Visibility: The visibility list of the private link service.

    PrivateLinkServiceProperties_STATUS_ARM

    (Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded_ARM)

    Properties of the private link service.

    Field Description
    alias
    string

    Alias: The alias of the private link service.

    autoApproval
    ResourceSet_STATUS_ARM

    AutoApproval: The auto-approval list of the private link service.

    enableProxyProtocol
    bool

    EnableProxyProtocol: Whether the private link service is enabled for proxy protocol or not.

    fqdns
    []string

    Fqdns: The list of Fqdn.

    ipConfigurations
    []PrivateLinkServiceIpConfiguration_STATUS_ARM

    IpConfigurations: An array of private link service IP configurations.

    loadBalancerFrontendIpConfigurations
    []FrontendIPConfiguration_STATUS_PrivateLinkService_SubResourceEmbedded_ARM

    LoadBalancerFrontendIpConfigurations: An array of references to the load balancer IP configurations.

    networkInterfaces
    []NetworkInterface_STATUS_PrivateLinkService_SubResourceEmbedded_ARM

    NetworkInterfaces: An array of references to the network interfaces created for this private link service.

    privateEndpointConnections
    []PrivateEndpointConnection_STATUS_ARM

    PrivateEndpointConnections: An array of list about connections to the private endpoint.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

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

    visibility
    ResourceSet_STATUS_ARM

    Visibility: The visibility list of the private link service.

    PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded

    (Appears on:PrivateLinkService)

    Private link service resource.

    Field Description
    alias
    string

    Alias: The alias of the private link service.

    autoApproval
    ResourceSet_STATUS

    AutoApproval: The auto-approval list of the private link service.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    enableProxyProtocol
    bool

    EnableProxyProtocol: Whether the private link service is enabled for proxy protocol or not.

    etag
    string

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

    extendedLocation
    ExtendedLocation_STATUS

    ExtendedLocation: The extended location of the load balancer.

    fqdns
    []string

    Fqdns: The list of Fqdn.

    id
    string

    Id: Resource ID.

    ipConfigurations
    []PrivateLinkServiceIpConfiguration_STATUS

    IpConfigurations: An array of private link service IP configurations.

    loadBalancerFrontendIpConfigurations
    []FrontendIPConfiguration_STATUS_PrivateLinkService_SubResourceEmbedded

    LoadBalancerFrontendIpConfigurations: An array of references to the load balancer IP configurations.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    networkInterfaces
    []NetworkInterface_STATUS_PrivateLinkService_SubResourceEmbedded

    NetworkInterfaces: An array of references to the network interfaces created for this private link service.

    privateEndpointConnections
    []PrivateEndpointConnection_STATUS

    PrivateEndpointConnections: An array of list about connections to the private endpoint.

    provisioningState
    ApplicationGatewayProvisioningState_STATUS

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

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    visibility
    ResourceSet_STATUS

    Visibility: The visibility list of the private link service.

    PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded_ARM

    Private link service resource.

    Field Description
    etag
    string

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

    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of the load balancer.

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    PrivateLinkServiceProperties_STATUS_ARM

    Properties: Properties of the private link service.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    PrivateLinkService_Spec

    (Appears on:PrivateLinkService)

    Field Description
    autoApproval
    ResourceSet

    AutoApproval: The auto-approval list of the private link service.

    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    enableProxyProtocol
    bool

    EnableProxyProtocol: Whether the private link service is enabled for proxy protocol or not.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the load balancer.

    fqdns
    []string

    Fqdns: The list of Fqdn.

    ipConfigurations
    []PrivateLinkServiceIpConfiguration

    IpConfigurations: An array of private link service IP configurations.

    loadBalancerFrontendIpConfigurations
    []FrontendIPConfiguration_PrivateLinkService_SubResourceEmbedded

    LoadBalancerFrontendIpConfigurations: An array of references to the load balancer IP configurations.

    location
    string

    Location: Resource location.

    operatorSpec
    PrivateLinkServiceOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Resource tags.

    visibility
    ResourceSet

    Visibility: The visibility list of the private link service.

    PrivateLinkService_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of the load balancer.

    location
    string

    Location: Resource location.

    name
    string
    properties
    PrivateLinkServiceProperties_ARM

    Properties: Properties of the private link service.

    tags
    map[string]string

    Tags: Resource tags.

    ProtocolsEnum (string alias)

    (Appears on:ApplicationGatewaySslPolicy, ApplicationGatewaySslPolicy_ARM)

    Ssl protocol enums.

    Value Description

    "TLSv1_0"

    "TLSv1_1"

    "TLSv1_2"

    "TLSv1_3"

    ProtocolsEnum_STATUS (string alias)

    (Appears on:ApplicationGatewaySslPolicy_STATUS, ApplicationGatewaySslPolicy_STATUS_ARM)

    Ssl protocol enums.

    Value Description

    "TLSv1_0"

    "TLSv1_1"

    "TLSv1_2"

    "TLSv1_3"

    PublicIPPrefix

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

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

    customIPPrefix
    PublicIpPrefixSubResource

    CustomIPPrefix: The customIpPrefix that this prefix is associated with.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the public ip address.

    ipTags
    []IpTag

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

    location
    string

    Location: Resource location.

    natGateway
    NatGatewaySpec_PublicIPPrefix_SubResourceEmbedded

    NatGateway: NatGateway of Public IP Prefix.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    prefixLength
    int

    PrefixLength: The Length of the Public IP Prefix.

    publicIPAddressVersion
    IPVersion

    PublicIPAddressVersion: The public IP address version.

    sku
    PublicIPPrefixSku

    Sku: The public IP prefix SKU.

    tags
    map[string]string

    Tags: Resource tags.

    zones
    []string

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

    status
    PublicIPPrefix_STATUS

    PublicIPPrefixPropertiesFormat_ARM

    (Appears on:PublicIPPrefix_Spec_ARM)

    Public IP prefix properties.

    Field Description
    customIPPrefix
    PublicIpPrefixSubResource_ARM

    CustomIPPrefix: The customIpPrefix that this prefix is associated with.

    ipTags
    []IpTag_ARM

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

    natGateway
    NatGatewaySpec_PublicIPPrefix_SubResourceEmbedded_ARM

    NatGateway: NatGateway of Public IP Prefix.

    prefixLength
    int

    PrefixLength: The Length of the Public IP Prefix.

    publicIPAddressVersion
    IPVersion

    PublicIPAddressVersion: The public IP address version.

    PublicIPPrefixPropertiesFormat_STATUS_ARM

    (Appears on:PublicIPPrefix_STATUS_ARM)

    Public IP prefix properties.

    Field Description
    customIPPrefix
    PublicIpPrefixSubResource_STATUS_ARM

    CustomIPPrefix: The customIpPrefix that this prefix is associated with.

    ipPrefix
    string

    IpPrefix: The allocated Prefix.

    ipTags
    []IpTag_STATUS_ARM

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

    loadBalancerFrontendIpConfiguration
    PublicIpPrefixSubResource_STATUS_ARM

    LoadBalancerFrontendIpConfiguration: The reference to load balancer frontend IP configuration associated with the public IP prefix.

    natGateway
    NatGateway_STATUS_PublicIPPrefix_SubResourceEmbedded_ARM

    NatGateway: NatGateway of Public IP Prefix.

    prefixLength
    int

    PrefixLength: The Length of the Public IP Prefix.

    provisioningState
    PublicIpPrefixProvisioningState_STATUS

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

    publicIPAddressVersion
    IPVersion_STATUS

    PublicIPAddressVersion: The public IP address version.

    publicIPAddresses
    []ReferencedPublicIpAddress_STATUS_ARM

    PublicIPAddresses: The list of all referenced PublicIPAddresses.

    resourceGuid
    string

    ResourceGuid: The resource GUID property of the public IP prefix resource.

    PublicIPPrefixSku

    (Appears on:PublicIPPrefix_Spec)

    SKU of a public IP prefix.

    Field Description
    name
    PublicIPPrefixSku_Name

    Name: Name of a public IP prefix SKU.

    tier
    PublicIPPrefixSku_Tier

    Tier: Tier of a public IP prefix SKU.

    PublicIPPrefixSku_ARM

    (Appears on:PublicIPPrefix_Spec_ARM)

    SKU of a public IP prefix.

    Field Description
    name
    PublicIPPrefixSku_Name

    Name: Name of a public IP prefix SKU.

    tier
    PublicIPPrefixSku_Tier

    Tier: Tier of a public IP prefix SKU.

    PublicIPPrefixSku_Name (string alias)

    (Appears on:PublicIPPrefixSku, PublicIPPrefixSku_ARM)

    Value Description

    "Standard"

    PublicIPPrefixSku_Name_STATUS (string alias)

    (Appears on:PublicIPPrefixSku_STATUS, PublicIPPrefixSku_STATUS_ARM)

    Value Description

    "Standard"

    PublicIPPrefixSku_STATUS

    (Appears on:PublicIPPrefix_STATUS)

    SKU of a public IP prefix.

    Field Description
    name
    PublicIPPrefixSku_Name_STATUS

    Name: Name of a public IP prefix SKU.

    tier
    PublicIPPrefixSku_Tier_STATUS

    Tier: Tier of a public IP prefix SKU.

    PublicIPPrefixSku_STATUS_ARM

    (Appears on:PublicIPPrefix_STATUS_ARM)

    SKU of a public IP prefix.

    Field Description
    name
    PublicIPPrefixSku_Name_STATUS

    Name: Name of a public IP prefix SKU.

    tier
    PublicIPPrefixSku_Tier_STATUS

    Tier: Tier of a public IP prefix SKU.

    PublicIPPrefixSku_Tier (string alias)

    (Appears on:PublicIPPrefixSku, PublicIPPrefixSku_ARM)

    Value Description

    "Global"

    "Regional"

    PublicIPPrefixSku_Tier_STATUS (string alias)

    (Appears on:PublicIPPrefixSku_STATUS, PublicIPPrefixSku_STATUS_ARM)

    Value Description

    "Global"

    "Regional"

    PublicIPPrefix_STATUS

    (Appears on:PublicIPPrefix)

    Public IP prefix resource.

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    customIPPrefix
    PublicIpPrefixSubResource_STATUS

    CustomIPPrefix: The customIpPrefix that this prefix is associated with.

    etag
    string

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

    extendedLocation
    ExtendedLocation_STATUS

    ExtendedLocation: The extended location of the public ip address.

    id
    string

    Id: Resource ID.

    ipPrefix
    string

    IpPrefix: The allocated Prefix.

    ipTags
    []IpTag_STATUS

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

    loadBalancerFrontendIpConfiguration
    PublicIpPrefixSubResource_STATUS

    LoadBalancerFrontendIpConfiguration: The reference to load balancer frontend IP configuration associated with the public IP prefix.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    natGateway
    NatGateway_STATUS_PublicIPPrefix_SubResourceEmbedded

    NatGateway: NatGateway of Public IP Prefix.

    prefixLength
    int

    PrefixLength: The Length of the Public IP Prefix.

    provisioningState
    PublicIpPrefixProvisioningState_STATUS

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

    publicIPAddressVersion
    IPVersion_STATUS

    PublicIPAddressVersion: The public IP address version.

    publicIPAddresses
    []ReferencedPublicIpAddress_STATUS

    PublicIPAddresses: The list of all referenced PublicIPAddresses.

    resourceGuid
    string

    ResourceGuid: The resource GUID property of the public IP prefix resource.

    sku
    PublicIPPrefixSku_STATUS

    Sku: The public IP prefix SKU.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    zones
    []string

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

    PublicIPPrefix_STATUS_ARM

    Public IP prefix resource.

    Field Description
    etag
    string

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

    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: The extended location of the public ip address.

    id
    string

    Id: Resource ID.

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name.

    properties
    PublicIPPrefixPropertiesFormat_STATUS_ARM

    Properties: Public IP prefix properties.

    sku
    PublicIPPrefixSku_STATUS_ARM

    Sku: The public IP prefix SKU.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    zones
    []string

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

    PublicIPPrefix_Spec

    (Appears on:PublicIPPrefix)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    customIPPrefix
    PublicIpPrefixSubResource

    CustomIPPrefix: The customIpPrefix that this prefix is associated with.

    extendedLocation
    ExtendedLocation

    ExtendedLocation: The extended location of the public ip address.

    ipTags
    []IpTag

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

    location
    string

    Location: Resource location.

    natGateway
    NatGatewaySpec_PublicIPPrefix_SubResourceEmbedded

    NatGateway: NatGateway of Public IP Prefix.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    prefixLength
    int

    PrefixLength: The Length of the Public IP Prefix.

    publicIPAddressVersion
    IPVersion

    PublicIPAddressVersion: The public IP address version.

    sku
    PublicIPPrefixSku

    Sku: The public IP prefix SKU.

    tags
    map[string]string

    Tags: Resource tags.

    zones
    []string

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

    PublicIPPrefix_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: The extended location of the public ip address.

    location
    string

    Location: Resource location.

    name
    string
    properties
    PublicIPPrefixPropertiesFormat_ARM

    Properties: Public IP prefix properties.

    sku
    PublicIPPrefixSku_ARM

    Sku: The public IP prefix SKU.

    tags
    map[string]string

    Tags: Resource tags.

    zones
    []string

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

    PublicIpPrefixProvisioningState_STATUS (string alias)

    (Appears on:PublicIPPrefixPropertiesFormat_STATUS_ARM, PublicIPPrefix_STATUS)

    The current provisioning state.

    Value Description

    "Deleting"

    "Failed"

    "Succeeded"

    "Updating"

    PublicIpPrefixSubResource

    (Appears on:PublicIPPrefix_Spec)

    Reference to another subresource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    PublicIpPrefixSubResource_ARM

    (Appears on:PublicIPPrefixPropertiesFormat_ARM)

    Reference to another subresource.

    Field Description
    id
    string

    PublicIpPrefixSubResource_STATUS

    (Appears on:PublicIPPrefix_STATUS)

    Reference to another subresource.

    Field Description
    id
    string

    Id: Resource ID.

    PublicIpPrefixSubResource_STATUS_ARM

    (Appears on:PublicIPPrefixPropertiesFormat_STATUS_ARM)

    Reference to another subresource.

    Field Description
    id
    string

    Id: Resource ID.

    RecordSet_STATUS

    (Appears on:PrivateDnsZoneConfig_STATUS)

    A collective group of information about the record set information.

    Field Description
    fqdn
    string

    Fqdn: Fqdn that resolves to private endpoint ip address.

    ipAddresses
    []string

    IpAddresses: The private ip address of the private endpoint.

    provisioningState
    PrivateEndpointProvisioningState_STATUS

    ProvisioningState: The provisioning state of the recordset.

    recordSetName
    string

    RecordSetName: Recordset name.

    recordType
    string

    RecordType: Resource record type.

    ttl
    int

    Ttl: Recordset time to live.

    RecordSet_STATUS_ARM

    (Appears on:PrivateDnsZonePropertiesFormat_STATUS_ARM)

    A collective group of information about the record set information.

    Field Description
    fqdn
    string

    Fqdn: Fqdn that resolves to private endpoint ip address.

    ipAddresses
    []string

    IpAddresses: The private ip address of the private endpoint.

    provisioningState
    PrivateEndpointProvisioningState_STATUS

    ProvisioningState: The provisioning state of the recordset.

    recordSetName
    string

    RecordSetName: Recordset name.

    recordType
    string

    RecordType: Resource record type.

    ttl
    int

    Ttl: Recordset time to live.

    RedirectTypeEnum (string alias)

    (Appears on:ApplicationGatewayRedirectConfiguration, ApplicationGatewayRedirectConfigurationPropertiesFormat_ARM)

    Redirect type enum.

    Value Description

    "Found"

    "Permanent"

    "SeeOther"

    "Temporary"

    ReferencedPublicIpAddress_STATUS

    (Appears on:PublicIPPrefix_STATUS)

    Reference to a public IP address.

    Field Description
    id
    string

    Id: The PublicIPAddress Reference.

    ReferencedPublicIpAddress_STATUS_ARM

    (Appears on:PublicIPPrefixPropertiesFormat_STATUS_ARM)

    Reference to a public IP address.

    Field Description
    id
    string

    Id: The PublicIPAddress Reference.

    ResourceSet

    (Appears on:PrivateLinkService_Spec)

    The base resource set for visibility and auto-approval.

    Field Description
    subscriptions
    []string

    Subscriptions: The list of subscriptions.

    ResourceSet_ARM

    (Appears on:PrivateLinkServiceProperties_ARM)

    The base resource set for visibility and auto-approval.

    Field Description
    subscriptions
    []string

    Subscriptions: The list of subscriptions.

    ResourceSet_STATUS

    (Appears on:PrivateLinkService_STATUS_PrivateLinkService_SubResourceEmbedded)

    The base resource set for visibility and auto-approval.

    Field Description
    subscriptions
    []string

    Subscriptions: The list of subscriptions.

    ResourceSet_STATUS_ARM

    (Appears on:PrivateLinkServiceProperties_STATUS_ARM)

    The base resource set for visibility and auto-approval.

    Field Description
    subscriptions
    []string

    Subscriptions: The list of subscriptions.

    Sku

    (Appears on:BastionHost_Spec)

    The sku of this Bastion Host.

    Field Description
    name
    Sku_Name

    Name: The name of this Bastion Host.

    Sku_ARM

    (Appears on:BastionHost_Spec_ARM)

    The sku of this Bastion Host.

    Field Description
    name
    Sku_Name

    Name: The name of this Bastion Host.

    Sku_Name (string alias)

    (Appears on:Sku, Sku_ARM)

    Value Description

    "Basic"

    "Standard"

    Sku_Name_STATUS (string alias)

    (Appears on:Sku_STATUS, Sku_STATUS_ARM)

    Value Description

    "Basic"

    "Standard"

    Sku_STATUS

    (Appears on:BastionHost_STATUS)

    The sku of this Bastion Host.

    Field Description
    name
    Sku_Name_STATUS

    Name: The name of this Bastion Host.

    Sku_STATUS_ARM

    (Appears on:BastionHost_STATUS_ARM)

    The sku of this Bastion Host.

    Field Description
    name
    Sku_Name_STATUS

    Name: The name of this Bastion Host.

    Subnet_PrivateEndpoint_SubResourceEmbedded

    (Appears on:PrivateEndpoint_Spec)

    Subnet in a virtual network resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    Subnet_PrivateEndpoint_SubResourceEmbedded_ARM

    (Appears on:PrivateEndpointProperties_ARM)

    Subnet in a virtual network resource.

    Field Description
    id
    string

    Subnet_PrivateLinkService_SubResourceEmbedded

    (Appears on:PrivateLinkServiceIpConfiguration)

    Subnet in a virtual network resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID.

    Subnet_PrivateLinkService_SubResourceEmbedded_ARM

    (Appears on:PrivateLinkServiceIpConfigurationProperties_ARM)

    Subnet in a virtual network resource.

    Field Description
    id
    string

    Subnet_STATUS_PrivateEndpoint_SubResourceEmbedded

    (Appears on:PrivateEndpoint_STATUS_PrivateEndpoint_SubResourceEmbedded)

    Subnet in a virtual network resource.

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_STATUS_PrivateEndpoint_SubResourceEmbedded_ARM

    (Appears on:PrivateEndpointProperties_STATUS_ARM)

    Subnet in a virtual network resource.

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_STATUS_PrivateLinkService_SubResourceEmbedded

    (Appears on:PrivateLinkServiceIpConfiguration_STATUS)

    Subnet in a virtual network resource.

    Field Description
    id
    string

    Id: Resource ID.

    Subnet_STATUS_PrivateLinkService_SubResourceEmbedded_ARM

    (Appears on:PrivateLinkServiceIpConfigurationProperties_STATUS_ARM)

    Subnet in a virtual network resource.

    Field Description
    id
    string

    Id: Resource ID.

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:DnsForwardingRuleset_STATUS, DnsForwardingRulesets_ForwardingRule_STATUS, DnsResolver_STATUS, DnsResolvers_InboundEndpoint_STATUS, DnsResolvers_OutboundEndpoint_STATUS)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    SystemData_STATUS_ARM

    (Appears on:DnsForwardingRuleset_STATUS_ARM, DnsForwardingRulesets_ForwardingRule_STATUS_ARM, DnsResolver_STATUS_ARM, DnsResolvers_InboundEndpoint_STATUS_ARM, DnsResolvers_OutboundEndpoint_STATUS_ARM)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    TargetDnsServer

    (Appears on:DnsForwardingRulesets_ForwardingRule_Spec)

    Describes a server to forward the DNS queries to.

    Field Description
    ipAddress
    string

    IpAddress: DNS server IP address.

    ipAddressFromConfig
    genruntime.ConfigMapReference

    IpAddressFromConfig: DNS server IP address.

    port
    int

    Port: DNS server port.

    TargetDnsServer_ARM

    (Appears on:ForwardingRuleProperties_ARM)

    Describes a server to forward the DNS queries to.

    Field Description
    ipAddress
    string

    IpAddress: DNS server IP address.

    port
    int

    Port: DNS server port.

    TargetDnsServer_STATUS

    (Appears on:DnsForwardingRulesets_ForwardingRule_STATUS)

    Describes a server to forward the DNS queries to.

    Field Description
    ipAddress
    string

    IpAddress: DNS server IP address.

    port
    int

    Port: DNS server port.

    TargetDnsServer_STATUS_ARM

    (Appears on:ForwardingRuleProperties_STATUS_ARM)

    Describes a server to forward the DNS queries to.

    Field Description
    ipAddress
    string

    IpAddress: DNS server IP address.

    port
    int

    Port: DNS server port.

    UserAssignedIdentityDetails

    (Appears on:ManagedServiceIdentity)

    Information about the user assigned identity for the resource

    Field Description
    reference
    genruntime.ResourceReference

    UserAssignedIdentityDetails_ARM

    (Appears on:ManagedServiceIdentity_ARM)

    Information about the user assigned identity for the resource