Class NetworkLoadBalancerClient

Service client instance for NetworkLoadBalancer.

Inheritance

object

ClientBase

RegionalClientBase

NetworkLoadBalancerClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.NetworkloadbalancerService

Assembly: OCI.DotNetSDK.Networkloadbalancer.dll

Syntax

public class NetworkLoadBalancerClient : RegionalClientBase, IDisposable

Constructors

NetworkLoadBalancerClient(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 NetworkLoadBalancerClient(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 NetworkLoadBalancerPaginators Paginators { get; }

Property Value

Type	Description
NetworkLoadBalancerPaginators

Waiters

Declaration

public NetworkLoadBalancerWaiters Waiters { get; }

Property Value

Type	Description
NetworkLoadBalancerWaiters

Methods

ChangeNetworkLoadBalancerCompartment(ChangeNetworkLoadBalancerCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a network 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<ChangeNetworkLoadBalancerCompartmentResponse> ChangeNetworkLoadBalancerCompartment(ChangeNetworkLoadBalancerCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeNetworkLoadBalancerCompartmentRequest	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<ChangeNetworkLoadBalancerCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeNetworkLoadBalancerCompartment 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 network 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.

CreateListener(CreateListenerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a listener to a network 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.

CreateNetworkLoadBalancer(CreateNetworkLoadBalancerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a network load balancer.

Declaration

public Task<CreateNetworkLoadBalancerResponse> CreateNetworkLoadBalancer(CreateNetworkLoadBalancerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateNetworkLoadBalancerRequest	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<CreateNetworkLoadBalancerResponse>	A response object containing details about the completed operation

Examples

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

DeleteBackend(DeleteBackendRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a backend server from a given network 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 network 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.

DeleteListener(DeleteListenerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a listener from a network 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.

DeleteNetworkLoadBalancer(DeleteNetworkLoadBalancerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a network load balancer resource by identifier.

Declaration

public Task<DeleteNetworkLoadBalancerResponse> DeleteNetworkLoadBalancer(DeleteNetworkLoadBalancerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteNetworkLoadBalancerRequest	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<DeleteNetworkLoadBalancerResponse>	A response object containing details about the completed operation

Examples

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

GetBackend(GetBackendRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the configuration information for the specified backend server.

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)

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

GetBackendOperationalStatus(GetBackendOperationalStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the current operational status of the specified backend server.

Declaration

public Task<GetBackendOperationalStatusResponse> GetBackendOperationalStatus(GetBackendOperationalStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetBackendOperationalStatusRequest	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<GetBackendOperationalStatusResponse>	A response object containing details about the completed operation

Examples

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

GetBackendSet(GetBackendSetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the configuration information for the specified backend set.

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)

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

Retrieves the health check policy information for a given network 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.

GetListener(GetListenerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves listener properties associated with a given network load balancer and listener name.

Declaration

public Task<GetListenerResponse> GetListener(GetListenerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetListenerRequest	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<GetListenerResponse>	A response object containing details about the completed operation

Examples

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

GetNetworkLoadBalancer(GetNetworkLoadBalancerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves network load balancer configuration information by identifier.

Declaration

public Task<GetNetworkLoadBalancerResponse> GetNetworkLoadBalancer(GetNetworkLoadBalancerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetNetworkLoadBalancerRequest	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<GetNetworkLoadBalancerResponse>	A response object containing details about the completed operation

Examples

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

GetNetworkLoadBalancerHealth(GetNetworkLoadBalancerHealthRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the health status for the specified network load balancer.

Declaration

public Task<GetNetworkLoadBalancerHealthResponse> GetNetworkLoadBalancerHealth(GetNetworkLoadBalancerHealthRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetNetworkLoadBalancerHealthRequest	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<GetNetworkLoadBalancerHealthResponse>	A response object containing details about the completed operation

Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the details of the work request with the given identifier.

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

ListListeners(ListListenersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all listeners associated with a given network load balancer.

Declaration

public Task<ListListenersResponse> ListListeners(ListListenersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListListenersRequest	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<ListListenersResponse>	A response object containing details about the completed operation

Examples

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

ListNetworkLoadBalancerHealths(ListNetworkLoadBalancerHealthsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListNetworkLoadBalancerHealthsResponse> ListNetworkLoadBalancerHealths(ListNetworkLoadBalancerHealthsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListNetworkLoadBalancerHealthsRequest	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<ListNetworkLoadBalancerHealthsResponse>	A response object containing details about the completed operation

Examples

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

ListNetworkLoadBalancers(ListNetworkLoadBalancersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of network load balancers.

Declaration

public Task<ListNetworkLoadBalancersResponse> ListNetworkLoadBalancers(ListNetworkLoadBalancersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListNetworkLoadBalancersRequest	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<ListNetworkLoadBalancersResponse>	A response object containing details about the completed operation

Examples

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

ListNetworkLoadBalancersPolicies(ListNetworkLoadBalancersPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the available network load balancer policies.

Declaration

public Task<ListNetworkLoadBalancersPoliciesResponse> ListNetworkLoadBalancersPolicies(ListNetworkLoadBalancersPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListNetworkLoadBalancersPoliciesRequest	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<ListNetworkLoadBalancersPoliciesResponse>	A response object containing details about the completed operation

Examples

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

ListNetworkLoadBalancersProtocols(ListNetworkLoadBalancersProtocolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This API has been deprecated so it won't return the updated list of supported protocls. Lists all supported traffic protocols.

Declaration

public Task<ListNetworkLoadBalancersProtocolsResponse> ListNetworkLoadBalancersProtocols(ListNetworkLoadBalancersProtocolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListNetworkLoadBalancersProtocolsRequest	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<ListNetworkLoadBalancersProtocolsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return a (paginated) list of errors for a given work request.

Declaration

public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	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<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a (paginated) list of logs for a given work request.

Declaration

public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	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<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all work requests.

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

UpdateListener(UpdateListenerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a listener for a given network 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.

UpdateNetworkLoadBalancer(UpdateNetworkLoadBalancerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the network load balancer

Declaration

public Task<UpdateNetworkLoadBalancerResponse> UpdateNetworkLoadBalancer(UpdateNetworkLoadBalancerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateNetworkLoadBalancerRequest	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<UpdateNetworkLoadBalancerResponse>	A response object containing details about the completed operation

Examples

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

UpdateNetworkSecurityGroups(UpdateNetworkSecurityGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the network security groups associated with the specified network 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.

Implements

IDisposable