Class LifecycleEnvironmentClient
Service client instance for LifecycleEnvironment.
Implements
Inherited Members
Namespace: Oci.OsmanagementhubService
Assembly: OCI.DotNetSDK.Osmanagementhub.dll
Syntax
public class LifecycleEnvironmentClient : RegionalClientBase, IDisposable
Constructors
LifecycleEnvironmentClient(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 LifecycleEnvironmentClient(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 LifecycleEnvironmentPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
LifecycleEnvironmentPaginators |
Waiters
Declaration
public LifecycleEnvironmentWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
LifecycleEnvironmentWaiters |
Methods
AttachManagedInstancesToLifecycleStage(AttachManagedInstancesToLifecycleStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Attaches (adds) managed instances to a lifecycle stage. Once added, you can apply operations to all managed instances in the lifecycle stage.
Declaration
public Task<AttachManagedInstancesToLifecycleStageResponse> AttachManagedInstancesToLifecycleStage(AttachManagedInstancesToLifecycleStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AttachManagedInstancesToLifecycleStageRequest | 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<AttachManagedInstancesToLifecycleStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AttachManagedInstancesToLifecycleStage API.
ChangeLifecycleEnvironmentCompartment(ChangeLifecycleEnvironmentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a lifecycle environment 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<ChangeLifecycleEnvironmentCompartmentResponse> ChangeLifecycleEnvironmentCompartment(ChangeLifecycleEnvironmentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeLifecycleEnvironmentCompartmentRequest | 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<ChangeLifecycleEnvironmentCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeLifecycleEnvironmentCompartment API.
CreateLifecycleEnvironment(CreateLifecycleEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a lifecycle environment. A lifecycle environment is a user-defined pipeline to deliver curated, versioned content in a prescribed, methodical manner.
Declaration
public Task<CreateLifecycleEnvironmentResponse> CreateLifecycleEnvironment(CreateLifecycleEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateLifecycleEnvironmentRequest | 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<CreateLifecycleEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateLifecycleEnvironment API.
DeleteLifecycleEnvironment(DeleteLifecycleEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified lifecycle environment.
Declaration
public Task<DeleteLifecycleEnvironmentResponse> DeleteLifecycleEnvironment(DeleteLifecycleEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteLifecycleEnvironmentRequest | 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<DeleteLifecycleEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteLifecycleEnvironment API.
DetachManagedInstancesFromLifecycleStage(DetachManagedInstancesFromLifecycleStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Detaches (removes) a managed instance from a lifecycle stage.
Declaration
public Task<DetachManagedInstancesFromLifecycleStageResponse> DetachManagedInstancesFromLifecycleStage(DetachManagedInstancesFromLifecycleStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetachManagedInstancesFromLifecycleStageRequest | 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<DetachManagedInstancesFromLifecycleStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetachManagedInstancesFromLifecycleStage API.
GetLifecycleEnvironment(GetLifecycleEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the specified lifecycle environment.
Declaration
public Task<GetLifecycleEnvironmentResponse> GetLifecycleEnvironment(GetLifecycleEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLifecycleEnvironmentRequest | 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<GetLifecycleEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLifecycleEnvironment API.
GetLifecycleStage(GetLifecycleStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns information about the specified lifecycle stage.
Declaration
public Task<GetLifecycleStageResponse> GetLifecycleStage(GetLifecycleStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLifecycleStageRequest | 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<GetLifecycleStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLifecycleStage API.
ListLifecycleEnvironments(ListLifecycleEnvironmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists lifecycle environments that match the specified compartment or lifecycle environment OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.
Declaration
public Task<ListLifecycleEnvironmentsResponse> ListLifecycleEnvironments(ListLifecycleEnvironmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLifecycleEnvironmentsRequest | 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<ListLifecycleEnvironmentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLifecycleEnvironments API.
ListLifecycleStageInstalledPackages(ListLifecycleStageInstalledPackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists installed packages on managed instances in a specified lifecycle stage. Filter the list against a variety of criteria including but not limited to the package name.
Declaration
public Task<ListLifecycleStageInstalledPackagesResponse> ListLifecycleStageInstalledPackages(ListLifecycleStageInstalledPackagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLifecycleStageInstalledPackagesRequest | 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<ListLifecycleStageInstalledPackagesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLifecycleStageInstalledPackages API.
ListLifecycleStages(ListLifecycleStagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists lifecycle stages that match the specified compartment or lifecycle stage OCID. Filter the list against
Declaration
public Task<ListLifecycleStagesResponse> ListLifecycleStages(ListLifecycleStagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLifecycleStagesRequest | 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<ListLifecycleStagesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLifecycleStages API.
PromoteSoftwareSourceToLifecycleStage(PromoteSoftwareSourceToLifecycleStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the versioned custom software source content to the specified lifecycle stage. A versioned custom software source OCID (softwareSourceId) is required when promoting content to the first lifecycle stage. You must promote content to the first stage before promoting to subsequent stages, otherwise the service returns an error. The softwareSourceId is optional when promoting content to the second, third, forth, or fifth stages. If you provide a softwareSourceId, the service validates that it matches the softwareSourceId of the previous stage. If it does not match, the service returns an error. If you don't provide a softwareSourceId, the service promotes the versioned software source from the previous lifecycle stage. If the previous lifecycle stage has no software source, the service returns an error.
Declaration
public Task<PromoteSoftwareSourceToLifecycleStageResponse> PromoteSoftwareSourceToLifecycleStage(PromoteSoftwareSourceToLifecycleStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PromoteSoftwareSourceToLifecycleStageRequest | 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<PromoteSoftwareSourceToLifecycleStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PromoteSoftwareSourceToLifecycleStage API.
UpdateLifecycleEnvironment(UpdateLifecycleEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified lifecycle environment's name, description, stages, or tags.
Declaration
public Task<UpdateLifecycleEnvironmentResponse> UpdateLifecycleEnvironment(UpdateLifecycleEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateLifecycleEnvironmentRequest | 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<UpdateLifecycleEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateLifecycleEnvironment API.