Class OnboardingClient

Service client instance for Onboarding.

Inheritance

object

ClientBase

RegionalClientBase

OnboardingClient

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

Assembly: OCI.DotNetSDK.Osmanagementhub.dll

Syntax

public class OnboardingClient : RegionalClientBase, IDisposable

Constructors

OnboardingClient(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 OnboardingClient(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 OnboardingPaginators Paginators { get; }

Property Value

Type	Description
OnboardingPaginators

Waiters

Declaration

public OnboardingWaiters Waiters { get; }

Property Value

Type	Description
OnboardingWaiters

Methods

AttachLifecycleStageToProfile(AttachLifecycleStageToProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Attaches the specified lifecycle stage to a profile.

Declaration

public Task<AttachLifecycleStageToProfileResponse> AttachLifecycleStageToProfile(AttachLifecycleStageToProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

AttachManagedInstanceGroupToProfile(AttachManagedInstanceGroupToProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Attaches the specified managed instance group to a profile.

Declaration

public Task<AttachManagedInstanceGroupToProfileResponse> AttachManagedInstanceGroupToProfile(AttachManagedInstanceGroupToProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

AttachManagementStationToProfile(AttachManagementStationToProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Attaches the specified management station to a profile.

Declaration

public Task<AttachManagementStationToProfileResponse> AttachManagementStationToProfile(AttachManagementStationToProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

AttachSoftwareSourcesToProfile(AttachSoftwareSourcesToProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Attaches the specified software sources to a profile.

Declaration

public Task<AttachSoftwareSourcesToProfileResponse> AttachSoftwareSourcesToProfile(AttachSoftwareSourcesToProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ChangeProfileCompartment(ChangeProfileCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the profile to a different compartment.

Declaration

public Task<ChangeProfileCompartmentResponse> ChangeProfileCompartment(ChangeProfileCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateProfile(CreateProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a registration profile. A profile defines the content applied to the instance when registering it with the service.

Declaration

public Task<CreateProfileResponse> CreateProfile(CreateProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteProfile(DeleteProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a specified registration profile.

Declaration

public Task<DeleteProfileResponse> DeleteProfile(DeleteProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DetachSoftwareSourcesFromProfile(DetachSoftwareSourcesFromProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Detaches the specified software sources from a profile.

Declaration

public Task<DetachSoftwareSourcesFromProfileResponse> DetachSoftwareSourcesFromProfile(DetachSoftwareSourcesFromProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetProfile(GetProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns information about the specified registration profile.

Declaration

public Task<GetProfileResponse> GetProfile(GetProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetProfileVersion(GetProfileVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns information about the version of the specified registration profile.

Declaration

public Task<GetProfileVersionResponse> GetProfileVersion(GetProfileVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListProfileAvailableSoftwareSources(ListProfileAvailableSoftwareSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists available software sources for a specified profile. Filter the list against a variety of criteria including but not limited to the software source name. The results list only software sources that have not already been added to the profile.

Declaration

public Task<ListProfileAvailableSoftwareSourcesResponse> ListProfileAvailableSoftwareSources(ListProfileAvailableSoftwareSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListProfiles(ListProfilesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists registration profiles that match the specified compartment or profile OCID. Filter the list against a variety of criteria including but not limited to its name, status, vendor name, and architecture type.

Declaration

public Task<ListProfilesResponse> ListProfiles(ListProfilesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateProfile(UpdateProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified profile's name, description, and tags.

Declaration

public Task<UpdateProfileResponse> UpdateProfile(UpdateProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable