com.azure.resourcemanager.frontdoor.models.Backend.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.frontdoor.models.Backend"
fullName: "com.azure.resourcemanager.frontdoor.models.Backend"
name: "Backend"
nameWithType: "Backend"
summary: "Backend address of a front<wbr>Door load balancer."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **Backend**"
constructors:
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.Backend()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.Backend()"
  name: "Backend()"
  nameWithType: "Backend.Backend()"
  summary: "Creates an instance of Backend class."
  syntax: "public Backend()"
  desc: "Creates an instance of Backend class."
methods:
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.address()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.address()"
  name: "address()"
  nameWithType: "Backend.address()"
  summary: "Get the address property: Location of the backend (IP address or FQDN)."
  syntax: "public String address()"
  desc: "Get the address property: Location of the backend (IP address or FQDN)."
  returns:
    description: "the address value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.backendHostHeader()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.backendHostHeader()"
  name: "backendHostHeader()"
  nameWithType: "Backend.backendHostHeader()"
  summary: "Get the backend<wbr>Host<wbr>Header property: The value to use as the host header sent to the backend."
  syntax: "public String backendHostHeader()"
  desc: "Get the backendHostHeader property: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host."
  returns:
    description: "the backendHostHeader value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.enabledState()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.enabledState()"
  name: "enabledState()"
  nameWithType: "Backend.enabledState()"
  summary: "Get the enabled<wbr>State property: Whether to enable use of this backend."
  syntax: "public BackendEnabledState enabledState()"
  desc: "Get the enabledState property: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'."
  returns:
    description: "the enabledState value."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.BackendEnabledState?alt=com.azure.resourcemanager.frontdoor.models.BackendEnabledState&text=BackendEnabledState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.httpPort()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.httpPort()"
  name: "httpPort()"
  nameWithType: "Backend.httpPort()"
  summary: "Get the http<wbr>Port property: The HTTP TCP port number."
  syntax: "public Integer httpPort()"
  desc: "Get the httpPort property: The HTTP TCP port number. Must be between 1 and 65535."
  returns:
    description: "the httpPort value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.httpsPort()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.httpsPort()"
  name: "httpsPort()"
  nameWithType: "Backend.httpsPort()"
  summary: "Get the https<wbr>Port property: The HTTPS TCP port number."
  syntax: "public Integer httpsPort()"
  desc: "Get the httpsPort property: The HTTPS TCP port number. Must be between 1 and 65535."
  returns:
    description: "the httpsPort value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.priority()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.priority()"
  name: "priority()"
  nameWithType: "Backend.priority()"
  summary: "Get the priority property: Priority to use for load balancing."
  syntax: "public Integer priority()"
  desc: "Get the priority property: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy."
  returns:
    description: "the priority value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.privateEndpointStatus()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.privateEndpointStatus()"
  name: "privateEndpointStatus()"
  nameWithType: "Backend.privateEndpointStatus()"
  summary: "Get the private<wbr>Endpoint<wbr>Status property: The Approval status for the connection to the Private Link."
  syntax: "public PrivateEndpointStatus privateEndpointStatus()"
  desc: "Get the privateEndpointStatus property: The Approval status for the connection to the Private Link."
  returns:
    description: "the privateEndpointStatus value."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.PrivateEndpointStatus?alt=com.azure.resourcemanager.frontdoor.models.PrivateEndpointStatus&text=PrivateEndpointStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.privateLinkAlias()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.privateLinkAlias()"
  name: "privateLinkAlias()"
  nameWithType: "Backend.privateLinkAlias()"
  summary: "Get the private<wbr>Link<wbr>Alias property: The Alias of the Private Link resource."
  syntax: "public String privateLinkAlias()"
  desc: "Get the privateLinkAlias property: The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'."
  returns:
    description: "the privateLinkAlias value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.privateLinkApprovalMessage()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.privateLinkApprovalMessage()"
  name: "privateLinkApprovalMessage()"
  nameWithType: "Backend.privateLinkApprovalMessage()"
  summary: "Get the private<wbr>Link<wbr>Approval<wbr>Message property: A custom message to be included in the approval request to connect to the Private Link."
  syntax: "public String privateLinkApprovalMessage()"
  desc: "Get the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link."
  returns:
    description: "the privateLinkApprovalMessage value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.privateLinkLocation()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.privateLinkLocation()"
  name: "privateLinkLocation()"
  nameWithType: "Backend.privateLinkLocation()"
  summary: "Get the private<wbr>Link<wbr>Location property: The location of the Private Link resource."
  syntax: "public String privateLinkLocation()"
  desc: "Get the privateLinkLocation property: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated."
  returns:
    description: "the privateLinkLocation value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.privateLinkResourceId()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.privateLinkResourceId()"
  name: "privateLinkResourceId()"
  nameWithType: "Backend.privateLinkResourceId()"
  summary: "Get the private<wbr>Link<wbr>Resource<wbr>Id property: The Resource Id of the Private Link resource."
  syntax: "public String privateLinkResourceId()"
  desc: "Get the privateLinkResourceId property: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'."
  returns:
    description: "the privateLinkResourceId value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.validate()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.validate()"
  name: "validate()"
  nameWithType: "Backend.validate()"
  summary: "Validates the instance."
  syntax: "public void validate()"
  desc: "Validates the instance."
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.weight()"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.weight()"
  name: "weight()"
  nameWithType: "Backend.weight()"
  summary: "Get the weight property: Weight of this endpoint for load balancing purposes."
  syntax: "public Integer weight()"
  desc: "Get the weight property: Weight of this endpoint for load balancing purposes."
  returns:
    description: "the weight value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withAddress(java.lang.String)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withAddress(String address)"
  name: "withAddress(String address)"
  nameWithType: "Backend.withAddress(String address)"
  summary: "Set the address property: Location of the backend (IP address or FQDN)."
  parameters:
  - description: "the address value to set."
    name: "address"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Backend withAddress(String address)"
  desc: "Set the address property: Location of the backend (IP address or FQDN)."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withBackendHostHeader(java.lang.String)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withBackendHostHeader(String backendHostHeader)"
  name: "withBackendHostHeader(String backendHostHeader)"
  nameWithType: "Backend.withBackendHostHeader(String backendHostHeader)"
  summary: "Set the backend<wbr>Host<wbr>Header property: The value to use as the host header sent to the backend."
  parameters:
  - description: "the backendHostHeader value to set."
    name: "backendHostHeader"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Backend withBackendHostHeader(String backendHostHeader)"
  desc: "Set the backendHostHeader property: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withEnabledState(com.azure.resourcemanager.frontdoor.models.BackendEnabledState)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withEnabledState(BackendEnabledState enabledState)"
  name: "withEnabledState(BackendEnabledState enabledState)"
  nameWithType: "Backend.withEnabledState(BackendEnabledState enabledState)"
  summary: "Set the enabled<wbr>State property: Whether to enable use of this backend."
  parameters:
  - description: "the enabledState value to set."
    name: "enabledState"
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.BackendEnabledState?alt=com.azure.resourcemanager.frontdoor.models.BackendEnabledState&text=BackendEnabledState\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Backend withEnabledState(BackendEnabledState enabledState)"
  desc: "Set the enabledState property: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withHttpPort(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withHttpPort(Integer httpPort)"
  name: "withHttpPort(Integer httpPort)"
  nameWithType: "Backend.withHttpPort(Integer httpPort)"
  summary: "Set the http<wbr>Port property: The HTTP TCP port number."
  parameters:
  - description: "the httpPort value to set."
    name: "httpPort"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public Backend withHttpPort(Integer httpPort)"
  desc: "Set the httpPort property: The HTTP TCP port number. Must be between 1 and 65535."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withHttpsPort(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withHttpsPort(Integer httpsPort)"
  name: "withHttpsPort(Integer httpsPort)"
  nameWithType: "Backend.withHttpsPort(Integer httpsPort)"
  summary: "Set the https<wbr>Port property: The HTTPS TCP port number."
  parameters:
  - description: "the httpsPort value to set."
    name: "httpsPort"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public Backend withHttpsPort(Integer httpsPort)"
  desc: "Set the httpsPort property: The HTTPS TCP port number. Must be between 1 and 65535."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withPriority(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withPriority(Integer priority)"
  name: "withPriority(Integer priority)"
  nameWithType: "Backend.withPriority(Integer priority)"
  summary: "Set the priority property: Priority to use for load balancing."
  parameters:
  - description: "the priority value to set."
    name: "priority"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public Backend withPriority(Integer priority)"
  desc: "Set the priority property: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withPrivateLinkAlias(java.lang.String)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withPrivateLinkAlias(String privateLinkAlias)"
  name: "withPrivateLinkAlias(String privateLinkAlias)"
  nameWithType: "Backend.withPrivateLinkAlias(String privateLinkAlias)"
  summary: "Set the private<wbr>Link<wbr>Alias property: The Alias of the Private Link resource."
  parameters:
  - description: "the privateLinkAlias value to set."
    name: "privateLinkAlias"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Backend withPrivateLinkAlias(String privateLinkAlias)"
  desc: "Set the privateLinkAlias property: The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withPrivateLinkApprovalMessage(java.lang.String)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withPrivateLinkApprovalMessage(String privateLinkApprovalMessage)"
  name: "withPrivateLinkApprovalMessage(String privateLinkApprovalMessage)"
  nameWithType: "Backend.withPrivateLinkApprovalMessage(String privateLinkApprovalMessage)"
  summary: "Set the private<wbr>Link<wbr>Approval<wbr>Message property: A custom message to be included in the approval request to connect to the Private Link."
  parameters:
  - description: "the privateLinkApprovalMessage value to set."
    name: "privateLinkApprovalMessage"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Backend withPrivateLinkApprovalMessage(String privateLinkApprovalMessage)"
  desc: "Set the privateLinkApprovalMessage property: A custom message to be included in the approval request to connect to the Private Link."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withPrivateLinkLocation(java.lang.String)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withPrivateLinkLocation(String privateLinkLocation)"
  name: "withPrivateLinkLocation(String privateLinkLocation)"
  nameWithType: "Backend.withPrivateLinkLocation(String privateLinkLocation)"
  summary: "Set the private<wbr>Link<wbr>Location property: The location of the Private Link resource."
  parameters:
  - description: "the privateLinkLocation value to set."
    name: "privateLinkLocation"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Backend withPrivateLinkLocation(String privateLinkLocation)"
  desc: "Set the privateLinkLocation property: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withPrivateLinkResourceId(java.lang.String)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withPrivateLinkResourceId(String privateLinkResourceId)"
  name: "withPrivateLinkResourceId(String privateLinkResourceId)"
  nameWithType: "Backend.withPrivateLinkResourceId(String privateLinkResourceId)"
  summary: "Set the private<wbr>Link<wbr>Resource<wbr>Id property: The Resource Id of the Private Link resource."
  parameters:
  - description: "the privateLinkResourceId value to set."
    name: "privateLinkResourceId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Backend withPrivateLinkResourceId(String privateLinkResourceId)"
  desc: "Set the privateLinkResourceId property: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.Backend.withWeight(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.frontdoor.models.Backend.withWeight(Integer weight)"
  name: "withWeight(Integer weight)"
  nameWithType: "Backend.withWeight(Integer weight)"
  summary: "Set the weight property: Weight of this endpoint for load balancing purposes."
  parameters:
  - description: "the weight value to set."
    name: "weight"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public Backend withWeight(Integer weight)"
  desc: "Set the weight property: Weight of this endpoint for load balancing purposes."
  returns:
    description: "the Backend object itself."
    type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.Backend?alt=com.azure.resourcemanager.frontdoor.models.Backend&text=Backend\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Backend address of a frontDoor load balancer."
metadata: {}
package: "com.azure.resourcemanager.frontdoor.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-frontdoor:1.0.0-beta.3