Show / Hide Table of Contents

Class ManagementApplianceClient

Service client instance for ManagementAppliance.

Inheritance
object
ClientBase
RegionalClientBase
ManagementApplianceClient
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.OcvpService
Assembly: OCI.DotNetSDK.Ocvp.dll
Syntax
public class ManagementApplianceClient : RegionalClientBase, IDisposable

Constructors

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

Waiters

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

Methods

CreateManagementAppliance(CreateManagementApplianceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a management appliance.

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

A response object containing details about the completed operation

Examples

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

DeleteManagementAppliance(DeleteManagementApplianceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes management appliance specified.

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

A response object containing details about the completed operation

Examples

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

GetManagementAppliance(GetManagementApplianceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the specified management appliance information.

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

A response object containing details about the completed operation

Examples

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

ListManagementAppliances(ListManagementAppliancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists management appliances in compartment specified. List can be filtered by management appliance, compartment, name and lifecycle state.

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

A response object containing details about the completed operation

Examples

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

UpdateManagementAppliance(UpdateManagementApplianceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates management appliance specified.

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

A response object containing details about the completed operation

Examples

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

Implements

IDisposable
In this article
Back to top