Class LoadBalancerClient

Service client instance for LoadBalancer.

Inheritance
object
ClientBase
RegionalClientBase
LoadBalancerClient
Implements
Inherited Members
Namespace: Oci.LoadbalancerService
Assembly: OCI.DotNetSDK.Loadbalancer.dll
Syntax
public class LoadBalancerClient : RegionalClientBase, IDisposable

Constructors

LoadBalancerClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration
public LoadBalancerClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type Name Description
IBasicAuthenticationDetailsProvider authenticationDetailsProvider

The authentication details provider. Required.
ClientConfiguration clientConfiguration

The client configuration that contains settings to adjust REST client behaviors. Optional.
string endpoint

The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration
public LoadBalancerPaginators Paginators { get; }
Property Value
Type Description
LoadBalancerPaginators

Waiters

Declaration
public LoadBalancerWaiters Waiters { get; }
Property Value
Type Description
LoadBalancerWaiters

Methods

ChangeLoadBalancerCompartment(ChangeLoadBalancerCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a load balancer into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeLoadBalancerCompartmentResponse> ChangeLoadBalancerCompartment(ChangeLoadBalancerCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeLoadBalancerCompartmentRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ChangeLoadBalancerCompartmentResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ChangeLoadBalancerCompartment API.

CreateBackend(CreateBackendRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a backend server to a backend set.

Declaration
public Task<CreateBackendResponse> CreateBackend(CreateBackendRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateBackendRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateBackendResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateBackend API.

CreateBackendSet(CreateBackendSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a backend set to a load balancer.

Declaration
public Task<CreateBackendSetResponse> CreateBackendSet(CreateBackendSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateBackendSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateBackendSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateBackendSet API.

CreateCertificate(CreateCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an asynchronous request to add an SSL certificate bundle.

Declaration
public Task<CreateCertificateResponse> CreateCertificate(CreateCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateCertificateRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateCertificateResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateCertificate API.

CreateHostname(CreateHostnameRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a hostname resource to the specified load balancer. For more information, see Managing Request Routing.

Declaration
public Task<CreateHostnameResponse> CreateHostname(CreateHostnameRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateHostnameRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateHostnameResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateHostname API.

CreateListener(CreateListenerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a listener to a load balancer.

Declaration
public Task<CreateListenerResponse> CreateListener(CreateListenerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateListenerRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateListenerResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateListener API.

CreateLoadBalancer(CreateLoadBalancerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new load balancer in the specified compartment. For general information about load balancers, see Overview of the Load Balancing Service. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the load balancer to reside. Notice that the load balancer doesn't have to be in the same compartment as the VCN or backend set. If you're not sure which compartment to use, put the load balancer in the same compartment as the VCN. For information about access control and compartments, see Overview of the IAM Service. <br/> You must specify a display name for the load balancer. It does not have to be unique, and you can change it. <br/> For information about Availability Domains, see Regions and Availability Domains. To get a list of Availability Domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API. <br/> All Oracle Cloud Infrastructure resources, including load balancers, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. Fore more information, see Resource Identifiers. <br/> After you send your request, the new object's state will temporarily be PROVISIONING. Before using the object, first make sure its state has changed to RUNNING. <br/> When you create a load balancer, the system assigns an IP address. To get the IP address, use the {@link #getLoadBalancer(GetLoadBalancerRequest) getLoadBalancer} operation.

Declaration
public Task<CreateLoadBalancerResponse> CreateLoadBalancer(CreateLoadBalancerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateLoadBalancerRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateLoadBalancerResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateLoadBalancer API.

CreatePathRouteSet(CreatePathRouteSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a path route set to a load balancer. For more information, see Managing Request Routing.

Declaration
public Task<CreatePathRouteSetResponse> CreatePathRouteSet(CreatePathRouteSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreatePathRouteSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreatePathRouteSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreatePathRouteSet API.

CreateRoutingPolicy(CreateRoutingPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a routing policy to a load balancer. For more information, see Managing Request Routing.

Declaration
public Task<CreateRoutingPolicyResponse> CreateRoutingPolicy(CreateRoutingPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateRoutingPolicyRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateRoutingPolicyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateRoutingPolicy API.

CreateRuleSet(CreateRuleSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new rule set associated with the specified load balancer. For more information, see Managing Rule Sets.

Declaration
public Task<CreateRuleSetResponse> CreateRuleSet(CreateRuleSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateRuleSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateRuleSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateRuleSet API.

CreateSSLCipherSuite(CreateSSLCipherSuiteRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a custom SSL cipher suite.

Declaration
public Task<CreateSSLCipherSuiteResponse> CreateSSLCipherSuite(CreateSSLCipherSuiteRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateSSLCipherSuiteRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<CreateSSLCipherSuiteResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use CreateSSLCipherSuite API.

DeleteBackend(DeleteBackendRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a backend server from a given load balancer and backend set.

Declaration
public Task<DeleteBackendResponse> DeleteBackend(DeleteBackendRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteBackendRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteBackendResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteBackend API.

DeleteBackendSet(DeleteBackendSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified backend set. Note that deleting a backend set removes its backend servers from the load balancer. <br/> Before you can delete a backend set, you must remove it from any active listeners.

Declaration
public Task<DeleteBackendSetResponse> DeleteBackendSet(DeleteBackendSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteBackendSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteBackendSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteBackendSet API.

DeleteCertificate(DeleteCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an SSL certificate bundle from a load balancer.

Declaration
public Task<DeleteCertificateResponse> DeleteCertificate(DeleteCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteCertificateRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteCertificateResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteCertificate API.

DeleteHostname(DeleteHostnameRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a hostname resource from the specified load balancer.

Declaration
public Task<DeleteHostnameResponse> DeleteHostname(DeleteHostnameRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteHostnameRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteHostnameResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteHostname API.

DeleteListener(DeleteListenerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a listener from a load balancer.

Declaration
public Task<DeleteListenerResponse> DeleteListener(DeleteListenerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteListenerRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteListenerResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteListener API.

DeleteLoadBalancer(DeleteLoadBalancerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops a load balancer and removes it from service.

Declaration
public Task<DeleteLoadBalancerResponse> DeleteLoadBalancer(DeleteLoadBalancerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteLoadBalancerRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteLoadBalancerResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteLoadBalancer API.

DeletePathRouteSet(DeletePathRouteSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a path route set from the specified load balancer. <br/> To delete a path route rule from a path route set, use the {@link #updatePathRouteSet(UpdatePathRouteSetRequest) updatePathRouteSet} operation.

Declaration
public Task<DeletePathRouteSetResponse> DeletePathRouteSet(DeletePathRouteSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeletePathRouteSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeletePathRouteSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeletePathRouteSet API.

DeleteRoutingPolicy(DeleteRoutingPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a routing policy from the specified load balancer. <br/> To delete a routing rule from a routing policy, use the {@link #updateRoutingPolicy(UpdateRoutingPolicyRequest) updateRoutingPolicy} operation.

Declaration
public Task<DeleteRoutingPolicyResponse> DeleteRoutingPolicy(DeleteRoutingPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteRoutingPolicyRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteRoutingPolicyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteRoutingPolicy API.

DeleteRuleSet(DeleteRuleSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a rule set from the specified load balancer. <br/> To delete a rule from a rule set, use the {@link #updateRuleSet(UpdateRuleSetRequest) updateRuleSet} operation.

Declaration
public Task<DeleteRuleSetResponse> DeleteRuleSet(DeleteRuleSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteRuleSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteRuleSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteRuleSet API.

DeleteSSLCipherSuite(DeleteSSLCipherSuiteRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an SSL cipher suite from a load balancer.

Declaration
public Task<DeleteSSLCipherSuiteResponse> DeleteSSLCipherSuite(DeleteSSLCipherSuiteRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteSSLCipherSuiteRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<DeleteSSLCipherSuiteResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use DeleteSSLCipherSuite API.

GetBackend(GetBackendRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified backend server's configuration information.

Declaration
public Task<GetBackendResponse> GetBackend(GetBackendRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBackendRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetBackendResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetBackend API.

GetBackendHealth(GetBackendHealthRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the current health status of the specified backend server.

Declaration
public Task<GetBackendHealthResponse> GetBackendHealth(GetBackendHealthRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBackendHealthRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetBackendHealthResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetBackendHealth API.

GetBackendSet(GetBackendSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified backend set's configuration information.

Declaration
public Task<GetBackendSetResponse> GetBackendSet(GetBackendSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBackendSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetBackendSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetBackendSet API.

GetBackendSetHealth(GetBackendSetHealthRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the health status for the specified backend set.

Declaration
public Task<GetBackendSetHealthResponse> GetBackendSetHealth(GetBackendSetHealthRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetBackendSetHealthRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetBackendSetHealthResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetBackendSetHealth API.

GetHealthChecker(GetHealthCheckerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the health check policy information for a given load balancer and backend set.

Declaration
public Task<GetHealthCheckerResponse> GetHealthChecker(GetHealthCheckerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetHealthCheckerRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetHealthCheckerResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetHealthChecker API.

GetHostname(GetHostnameRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified hostname resource's configuration information.

Declaration
public Task<GetHostnameResponse> GetHostname(GetHostnameRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetHostnameRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetHostnameResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetHostname API.

GetLoadBalancer(GetLoadBalancerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified load balancer's configuration information.

Declaration
public Task<GetLoadBalancerResponse> GetLoadBalancer(GetLoadBalancerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetLoadBalancerRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetLoadBalancerResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetLoadBalancer API.

GetLoadBalancerHealth(GetLoadBalancerHealthRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the health status for the specified load balancer.

Declaration
public Task<GetLoadBalancerHealthResponse> GetLoadBalancerHealth(GetLoadBalancerHealthRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetLoadBalancerHealthRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetLoadBalancerHealthResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetLoadBalancerHealth API.

GetPathRouteSet(GetPathRouteSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified path route set's configuration information.

Declaration
public Task<GetPathRouteSetResponse> GetPathRouteSet(GetPathRouteSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetPathRouteSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetPathRouteSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetPathRouteSet API.

GetRoutingPolicy(GetRoutingPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified routing policy.

Declaration
public Task<GetRoutingPolicyResponse> GetRoutingPolicy(GetRoutingPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetRoutingPolicyRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetRoutingPolicyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetRoutingPolicy API.

GetRuleSet(GetRuleSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified set of rules.

Declaration
public Task<GetRuleSetResponse> GetRuleSet(GetRuleSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetRuleSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetRuleSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetRuleSet API.

GetSSLCipherSuite(GetSSLCipherSuiteRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified SSL cipher suite's configuration information.

Declaration
public Task<GetSSLCipherSuiteResponse> GetSSLCipherSuite(GetSSLCipherSuiteRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetSSLCipherSuiteRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetSSLCipherSuiteResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetSSLCipherSuite API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a work request.

Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetWorkRequestRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<GetWorkRequestResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use GetWorkRequest API.

ListBackendSets(ListBackendSetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all backend sets associated with a given load balancer.

Declaration
public Task<ListBackendSetsResponse> ListBackendSets(ListBackendSetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBackendSetsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListBackendSetsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListBackendSets API.

ListBackends(ListBackendsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the backend servers for a given load balancer and backend set.

Declaration
public Task<ListBackendsResponse> ListBackends(ListBackendsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListBackendsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListBackendsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListBackends API.

ListCertificates(ListCertificatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all SSL certificates bundles associated with a given load balancer.

Declaration
public Task<ListCertificatesResponse> ListCertificates(ListCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListCertificatesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListCertificatesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListCertificates API.

ListHostnames(ListHostnamesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all hostname resources associated with the specified load balancer.

Declaration
public Task<ListHostnamesResponse> ListHostnames(ListHostnamesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListHostnamesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListHostnamesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListHostnames API.

ListListenerRules(ListListenerRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all of the rules from all of the rule sets associated with the specified listener. The response organizes the rules in the following order: <br/>

  • Access control rules
  • Allow method rules
  • Request header rules
  • Response header rules
Declaration
public Task<ListListenerRulesResponse> ListListenerRules(ListListenerRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListListenerRulesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListListenerRulesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListListenerRules API.

ListLoadBalancerHealths(ListLoadBalancerHealthsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the summary health statuses for all load balancers in the specified compartment.

Declaration
public Task<ListLoadBalancerHealthsResponse> ListLoadBalancerHealths(ListLoadBalancerHealthsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListLoadBalancerHealthsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListLoadBalancerHealthsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListLoadBalancerHealths API.

ListLoadBalancers(ListLoadBalancersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all load balancers in the specified compartment.

Declaration
public Task<ListLoadBalancersResponse> ListLoadBalancers(ListLoadBalancersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListLoadBalancersRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListLoadBalancersResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListLoadBalancers API.

ListPathRouteSets(ListPathRouteSetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all path route sets associated with the specified load balancer.

Declaration
public Task<ListPathRouteSetsResponse> ListPathRouteSets(ListPathRouteSetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListPathRouteSetsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListPathRouteSetsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListPathRouteSets API.

ListPolicies(ListPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the available load balancer policies.

Declaration
public Task<ListPoliciesResponse> ListPolicies(ListPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListPoliciesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListPoliciesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListPolicies API.

ListProtocols(ListProtocolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all supported traffic protocols.

Declaration
public Task<ListProtocolsResponse> ListProtocols(ListProtocolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListProtocolsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListProtocolsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListProtocols API.

ListRoutingPolicies(ListRoutingPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all routing policies associated with the specified load balancer.

Declaration
public Task<ListRoutingPoliciesResponse> ListRoutingPolicies(ListRoutingPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListRoutingPoliciesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListRoutingPoliciesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListRoutingPolicies API.

ListRuleSets(ListRuleSetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all rule sets associated with the specified load balancer.

Declaration
public Task<ListRuleSetsResponse> ListRuleSets(ListRuleSetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListRuleSetsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListRuleSetsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListRuleSets API.

ListSSLCipherSuites(ListSSLCipherSuitesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all SSL cipher suites associated with the specified load balancer.

Declaration
public Task<ListSSLCipherSuitesResponse> ListSSLCipherSuites(ListSSLCipherSuitesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListSSLCipherSuitesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListSSLCipherSuitesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListSSLCipherSuites API.

ListShapes(ListShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the valid load balancer shapes.

Declaration
public Task<ListShapesResponse> ListShapes(ListShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListShapesRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListShapesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListShapes API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests for a given load balancer.

Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<ListWorkRequestsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListWorkRequests API.

UpdateBackend(UpdateBackendRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the configuration of a backend server within the specified backend set.

Declaration
public Task<UpdateBackendResponse> UpdateBackend(UpdateBackendRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateBackendRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateBackendResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateBackend API.

UpdateBackendSet(UpdateBackendSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a backend set.

Declaration
public Task<UpdateBackendSetResponse> UpdateBackendSet(UpdateBackendSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateBackendSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateBackendSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateBackendSet API.

UpdateHealthChecker(UpdateHealthCheckerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the health check policy for a given load balancer and backend set.

Declaration
public Task<UpdateHealthCheckerResponse> UpdateHealthChecker(UpdateHealthCheckerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateHealthCheckerRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateHealthCheckerResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateHealthChecker API.

UpdateHostname(UpdateHostnameRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Overwrites an existing hostname resource on the specified load balancer. Use this operation to change a virtual hostname.

Declaration
public Task<UpdateHostnameResponse> UpdateHostname(UpdateHostnameRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateHostnameRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateHostnameResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateHostname API.

UpdateListener(UpdateListenerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a listener for a given load balancer.

Declaration
public Task<UpdateListenerResponse> UpdateListener(UpdateListenerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateListenerRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateListenerResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateListener API.

UpdateLoadBalancer(UpdateLoadBalancerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a load balancer's configuration.

Declaration
public Task<UpdateLoadBalancerResponse> UpdateLoadBalancer(UpdateLoadBalancerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateLoadBalancerRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateLoadBalancerResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateLoadBalancer API.

UpdateLoadBalancerShape(UpdateLoadBalancerShapeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the shape of a load balancer. The new shape can be larger or smaller compared to existing shape of the LB. The service will try to perform this operation in the least disruptive way to existing connections, but there is a possibility that they might be lost during the LB resizing process. The new shape becomes effective as soon as the related work request completes successfully, i.e. when reshaping to a larger shape, the LB will start accepting larger bandwidth and when reshaping to a smaller one, the LB will be accepting smaller bandwidth.

Declaration
public Task<UpdateLoadBalancerShapeResponse> UpdateLoadBalancerShape(UpdateLoadBalancerShapeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateLoadBalancerShapeRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateLoadBalancerShapeResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateLoadBalancerShape API.

UpdateNetworkSecurityGroups(UpdateNetworkSecurityGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the network security groups associated with the specified load balancer.

Declaration
public Task<UpdateNetworkSecurityGroupsResponse> UpdateNetworkSecurityGroups(UpdateNetworkSecurityGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateNetworkSecurityGroupsRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateNetworkSecurityGroupsResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateNetworkSecurityGroups API.

UpdatePathRouteSet(UpdatePathRouteSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Overwrites an existing path route set on the specified load balancer. Use this operation to add, delete, or alter path route rules in a path route set. <br/> To add a new path route rule to a path route set, the pathRoutes in the {@link #updatePathRouteSetDetails(UpdatePathRouteSetDetailsRequest) updatePathRouteSetDetails} object must include both the new path route rule to add and the existing path route rules to retain.

Declaration
public Task<UpdatePathRouteSetResponse> UpdatePathRouteSet(UpdatePathRouteSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdatePathRouteSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdatePathRouteSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdatePathRouteSet API.

UpdateRoutingPolicy(UpdateRoutingPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Overwrites an existing routing policy on the specified load balancer. Use this operation to add, delete, or alter routing policy rules in a routing policy. <br/> To add a new routing rule to a routing policy, the body must include both the new routing rule to add and the existing rules to retain.

Declaration
public Task<UpdateRoutingPolicyResponse> UpdateRoutingPolicy(UpdateRoutingPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateRoutingPolicyRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateRoutingPolicyResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateRoutingPolicy API.

UpdateRuleSet(UpdateRuleSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Overwrites an existing set of rules on the specified load balancer. Use this operation to add or alter the rules in a rule set. <br/> To add a new rule to a set, the body must include both the new rule to add and the existing rules to retain.

Declaration
public Task<UpdateRuleSetResponse> UpdateRuleSet(UpdateRuleSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateRuleSetRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateRuleSetResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateRuleSet API.

UpdateSSLCipherSuite(UpdateSSLCipherSuiteRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates an existing SSL cipher suite for the specified load balancer.

Declaration
public Task<UpdateSSLCipherSuiteResponse> UpdateSSLCipherSuite(UpdateSSLCipherSuiteRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateSSLCipherSuiteRequest request

The request object containing the details to send. Required.
RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.
CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.
HttpCompletionOption completionOption

The completion option for this operation. Optional.
Returns
Type Description
Task<UpdateSSLCipherSuiteResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use UpdateSSLCipherSuite API.

Implements