Class ServiceMeshClient

Service client instance for ServiceMesh.

Inheritance
object
ClientBase
RegionalClientBase
ServiceMeshClient
Implements
Inherited Members
Namespace: Oci.ServicemeshService
Assembly: OCI.DotNetSDK.Servicemesh.dll
Syntax
public class ServiceMeshClient : RegionalClientBase, IDisposable

Constructors

ServiceMeshClient(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 ServiceMeshClient(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 ServiceMeshPaginators Paginators { get; }
Property Value
Type Description
ServiceMeshPaginators

Waiters

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

Methods

CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels the work request with the given ID.

Declaration
public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelWorkRequestRequest 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<CancelWorkRequestResponse>

A response object containing details about the completed operation
Examples

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

ChangeAccessPolicyCompartment(ChangeAccessPolicyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an AccessPolicy resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeAccessPolicyCompartmentResponse> ChangeAccessPolicyCompartment(ChangeAccessPolicyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeAccessPolicyCompartmentRequest 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<ChangeAccessPolicyCompartmentResponse>

A response object containing details about the completed operation
Examples

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

ChangeIngressGatewayCompartment(ChangeIngressGatewayCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a IngressGateway resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeIngressGatewayCompartmentResponse> ChangeIngressGatewayCompartment(ChangeIngressGatewayCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeIngressGatewayCompartmentRequest 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<ChangeIngressGatewayCompartmentResponse>

A response object containing details about the completed operation
Examples

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

ChangeIngressGatewayRouteTableCompartment(ChangeIngressGatewayRouteTableCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a IngressGatewayRouteTable resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeIngressGatewayRouteTableCompartmentResponse> ChangeIngressGatewayRouteTableCompartment(ChangeIngressGatewayRouteTableCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeIngressGatewayRouteTableCompartmentRequest 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<ChangeIngressGatewayRouteTableCompartmentResponse>

A response object containing details about the completed operation
Examples

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

ChangeMeshCompartment(ChangeMeshCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a Mesh resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeMeshCompartmentResponse> ChangeMeshCompartment(ChangeMeshCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeMeshCompartmentRequest 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<ChangeMeshCompartmentResponse>

A response object containing details about the completed operation
Examples

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

ChangeVirtualDeploymentCompartment(ChangeVirtualDeploymentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a VirtualDeployment resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeVirtualDeploymentCompartmentResponse> ChangeVirtualDeploymentCompartment(ChangeVirtualDeploymentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeVirtualDeploymentCompartmentRequest 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<ChangeVirtualDeploymentCompartmentResponse>

A response object containing details about the completed operation
Examples

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

ChangeVirtualServiceCompartment(ChangeVirtualServiceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a VirtualService resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeVirtualServiceCompartmentResponse> ChangeVirtualServiceCompartment(ChangeVirtualServiceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeVirtualServiceCompartmentRequest 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<ChangeVirtualServiceCompartmentResponse>

A response object containing details about the completed operation
Examples

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

ChangeVirtualServiceRouteTableCompartment(ChangeVirtualServiceRouteTableCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a VirtualServiceRouteTable resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeVirtualServiceRouteTableCompartmentResponse> ChangeVirtualServiceRouteTableCompartment(ChangeVirtualServiceRouteTableCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeVirtualServiceRouteTableCompartmentRequest 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<ChangeVirtualServiceRouteTableCompartmentResponse>

A response object containing details about the completed operation
Examples

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

CreateAccessPolicy(CreateAccessPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new AccessPolicy.

Declaration
public Task<CreateAccessPolicyResponse> CreateAccessPolicy(CreateAccessPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateAccessPolicyRequest 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<CreateAccessPolicyResponse>

A response object containing details about the completed operation
Examples

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

CreateIngressGateway(CreateIngressGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new IngressGateway.

Declaration
public Task<CreateIngressGatewayResponse> CreateIngressGateway(CreateIngressGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateIngressGatewayRequest 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<CreateIngressGatewayResponse>

A response object containing details about the completed operation
Examples

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

CreateIngressGatewayRouteTable(CreateIngressGatewayRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new IngressGatewayRouteTable.

Declaration
public Task<CreateIngressGatewayRouteTableResponse> CreateIngressGatewayRouteTable(CreateIngressGatewayRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateIngressGatewayRouteTableRequest 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<CreateIngressGatewayRouteTableResponse>

A response object containing details about the completed operation
Examples

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

CreateMesh(CreateMeshRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Mesh.

Declaration
public Task<CreateMeshResponse> CreateMesh(CreateMeshRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateMeshRequest 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<CreateMeshResponse>

A response object containing details about the completed operation
Examples

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

CreateVirtualDeployment(CreateVirtualDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new VirtualDeployment.

Declaration
public Task<CreateVirtualDeploymentResponse> CreateVirtualDeployment(CreateVirtualDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVirtualDeploymentRequest 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<CreateVirtualDeploymentResponse>

A response object containing details about the completed operation
Examples

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

CreateVirtualService(CreateVirtualServiceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new VirtualService.

Declaration
public Task<CreateVirtualServiceResponse> CreateVirtualService(CreateVirtualServiceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVirtualServiceRequest 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<CreateVirtualServiceResponse>

A response object containing details about the completed operation
Examples

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

CreateVirtualServiceRouteTable(CreateVirtualServiceRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new VirtualServiceRouteTable.

Declaration
public Task<CreateVirtualServiceRouteTableResponse> CreateVirtualServiceRouteTable(CreateVirtualServiceRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVirtualServiceRouteTableRequest 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<CreateVirtualServiceRouteTableResponse>

A response object containing details about the completed operation
Examples

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

DeleteAccessPolicy(DeleteAccessPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an AccessPolicy resource by identifier.

Declaration
public Task<DeleteAccessPolicyResponse> DeleteAccessPolicy(DeleteAccessPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteAccessPolicyRequest 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<DeleteAccessPolicyResponse>

A response object containing details about the completed operation
Examples

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

DeleteIngressGateway(DeleteIngressGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an IngressGateway resource by identifier.

Declaration
public Task<DeleteIngressGatewayResponse> DeleteIngressGateway(DeleteIngressGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteIngressGatewayRequest 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<DeleteIngressGatewayResponse>

A response object containing details about the completed operation
Examples

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

DeleteIngressGatewayRouteTable(DeleteIngressGatewayRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a IngressGatewayRouteTable resource by identifier.

Declaration
public Task<DeleteIngressGatewayRouteTableResponse> DeleteIngressGatewayRouteTable(DeleteIngressGatewayRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteIngressGatewayRouteTableRequest 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<DeleteIngressGatewayRouteTableResponse>

A response object containing details about the completed operation
Examples

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

DeleteMesh(DeleteMeshRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Mesh resource by identifier.

Declaration
public Task<DeleteMeshResponse> DeleteMesh(DeleteMeshRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteMeshRequest 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<DeleteMeshResponse>

A response object containing details about the completed operation
Examples

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

DeleteVirtualDeployment(DeleteVirtualDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a VirtualDeployment resource by identifier.

Declaration
public Task<DeleteVirtualDeploymentResponse> DeleteVirtualDeployment(DeleteVirtualDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVirtualDeploymentRequest 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<DeleteVirtualDeploymentResponse>

A response object containing details about the completed operation
Examples

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

DeleteVirtualService(DeleteVirtualServiceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a VirtualService resource by identifier

Declaration
public Task<DeleteVirtualServiceResponse> DeleteVirtualService(DeleteVirtualServiceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVirtualServiceRequest 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<DeleteVirtualServiceResponse>

A response object containing details about the completed operation
Examples

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

DeleteVirtualServiceRouteTable(DeleteVirtualServiceRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a VirtualServiceRouteTable resource by identifier.

Declaration
public Task<DeleteVirtualServiceRouteTableResponse> DeleteVirtualServiceRouteTable(DeleteVirtualServiceRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVirtualServiceRouteTableRequest 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<DeleteVirtualServiceRouteTableResponse>

A response object containing details about the completed operation
Examples

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

GetAccessPolicy(GetAccessPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get an AccessPolicy by identifier.

Declaration
public Task<GetAccessPolicyResponse> GetAccessPolicy(GetAccessPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetAccessPolicyRequest 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<GetAccessPolicyResponse>

A response object containing details about the completed operation
Examples

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

GetIngressGateway(GetIngressGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an IngressGateway by identifier.

Declaration
public Task<GetIngressGatewayResponse> GetIngressGateway(GetIngressGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetIngressGatewayRequest 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<GetIngressGatewayResponse>

A response object containing details about the completed operation
Examples

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

GetIngressGatewayRouteTable(GetIngressGatewayRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a IngressGatewayRouteTable by identifier.

Declaration
public Task<GetIngressGatewayRouteTableResponse> GetIngressGatewayRouteTable(GetIngressGatewayRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetIngressGatewayRouteTableRequest 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<GetIngressGatewayRouteTableResponse>

A response object containing details about the completed operation
Examples

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

GetMesh(GetMeshRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a Mesh by identifier.

Declaration
public Task<GetMeshResponse> GetMesh(GetMeshRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetMeshRequest 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<GetMeshResponse>

A response object containing details about the completed operation
Examples

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

GetProxyDetails(GetProxyDetailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the attributes of the Proxy such as proxy image version.

Declaration
public Task<GetProxyDetailsResponse> GetProxyDetails(GetProxyDetailsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetProxyDetailsRequest 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<GetProxyDetailsResponse>

A response object containing details about the completed operation
Examples

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

GetVirtualDeployment(GetVirtualDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a VirtualDeployment by identifier.

Declaration
public Task<GetVirtualDeploymentResponse> GetVirtualDeployment(GetVirtualDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVirtualDeploymentRequest 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<GetVirtualDeploymentResponse>

A response object containing details about the completed operation
Examples

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

GetVirtualService(GetVirtualServiceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a VirtualService by identifier.

Declaration
public Task<GetVirtualServiceResponse> GetVirtualService(GetVirtualServiceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVirtualServiceRequest 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<GetVirtualServiceResponse>

A response object containing details about the completed operation
Examples

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

GetVirtualServiceRouteTable(GetVirtualServiceRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a VirtualServiceRouteTable by identifier.

Declaration
public Task<GetVirtualServiceRouteTableResponse> GetVirtualServiceRouteTable(GetVirtualServiceRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVirtualServiceRouteTableRequest 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<GetVirtualServiceRouteTableResponse>

A response object containing details about the completed operation
Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the status of the work request with the given ID.

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.

ListAccessPolicies(ListAccessPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of AccessPolicy objects.

Declaration
public Task<ListAccessPoliciesResponse> ListAccessPolicies(ListAccessPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListAccessPoliciesRequest 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<ListAccessPoliciesResponse>

A response object containing details about the completed operation
Examples

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

ListIngressGatewayRouteTables(ListIngressGatewayRouteTablesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of IngressGatewayRouteTable objects.

Declaration
public Task<ListIngressGatewayRouteTablesResponse> ListIngressGatewayRouteTables(ListIngressGatewayRouteTablesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListIngressGatewayRouteTablesRequest 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<ListIngressGatewayRouteTablesResponse>

A response object containing details about the completed operation
Examples

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

ListIngressGateways(ListIngressGatewaysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of IngressGateway objects.

Declaration
public Task<ListIngressGatewaysResponse> ListIngressGateways(ListIngressGatewaysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListIngressGatewaysRequest 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<ListIngressGatewaysResponse>

A response object containing details about the completed operation
Examples

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

ListMeshes(ListMeshesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Mesh objects.

Declaration
public Task<ListMeshesResponse> ListMeshes(ListMeshesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListMeshesRequest 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<ListMeshesResponse>

A response object containing details about the completed operation
Examples

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

ListVirtualDeployments(ListVirtualDeploymentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of VirtualDeployments.

Declaration
public Task<ListVirtualDeploymentsResponse> ListVirtualDeployments(ListVirtualDeploymentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVirtualDeploymentsRequest 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<ListVirtualDeploymentsResponse>

A response object containing details about the completed operation
Examples

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

ListVirtualServiceRouteTables(ListVirtualServiceRouteTablesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of VirtualServiceRouteTable objects.

Declaration
public Task<ListVirtualServiceRouteTablesResponse> ListVirtualServiceRouteTables(ListVirtualServiceRouteTablesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVirtualServiceRouteTablesRequest 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<ListVirtualServiceRouteTablesResponse>

A response object containing details about the completed operation
Examples

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

ListVirtualServices(ListVirtualServicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of VirtualService objects.

Declaration
public Task<ListVirtualServicesResponse> ListVirtualServices(ListVirtualServicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVirtualServicesRequest 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<ListVirtualServicesResponse>

A response object containing details about the completed operation
Examples

Click here to see an example of how to use ListVirtualServices 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)

Return 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 the work requests in a compartment.

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.

UpdateAccessPolicy(UpdateAccessPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the AccessPolicy.

Declaration
public Task<UpdateAccessPolicyResponse> UpdateAccessPolicy(UpdateAccessPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateAccessPolicyRequest 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<UpdateAccessPolicyResponse>

A response object containing details about the completed operation
Examples

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

UpdateIngressGateway(UpdateIngressGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the IngressGateway.

Declaration
public Task<UpdateIngressGatewayResponse> UpdateIngressGateway(UpdateIngressGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateIngressGatewayRequest 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<UpdateIngressGatewayResponse>

A response object containing details about the completed operation
Examples

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

UpdateIngressGatewayRouteTable(UpdateIngressGatewayRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the IngressGatewayRouteTable.

Declaration
public Task<UpdateIngressGatewayRouteTableResponse> UpdateIngressGatewayRouteTable(UpdateIngressGatewayRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateIngressGatewayRouteTableRequest 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<UpdateIngressGatewayRouteTableResponse>

A response object containing details about the completed operation
Examples

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

UpdateMesh(UpdateMeshRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the Mesh.

Declaration
public Task<UpdateMeshResponse> UpdateMesh(UpdateMeshRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateMeshRequest 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<UpdateMeshResponse>

A response object containing details about the completed operation
Examples

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

UpdateVirtualDeployment(UpdateVirtualDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the VirtualDeployment.

Declaration
public Task<UpdateVirtualDeploymentResponse> UpdateVirtualDeployment(UpdateVirtualDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVirtualDeploymentRequest 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<UpdateVirtualDeploymentResponse>

A response object containing details about the completed operation
Examples

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

UpdateVirtualService(UpdateVirtualServiceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the VirtualService.

Declaration
public Task<UpdateVirtualServiceResponse> UpdateVirtualService(UpdateVirtualServiceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVirtualServiceRequest 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<UpdateVirtualServiceResponse>

A response object containing details about the completed operation
Examples

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

UpdateVirtualServiceRouteTable(UpdateVirtualServiceRouteTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the VirtualServiceRouteTable.

Declaration
public Task<UpdateVirtualServiceRouteTableResponse> UpdateVirtualServiceRouteTable(UpdateVirtualServiceRouteTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVirtualServiceRouteTableRequest 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<UpdateVirtualServiceRouteTableResponse>

A response object containing details about the completed operation
Examples

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

Implements