Show / Hide Table of Contents

Class ResourceManagerClient

Service client instance for ResourceManager.

Inheritance
object
ClientBase
RegionalClientBase
ResourceManagerClient
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.ResourcemanagerService
Assembly: OCI.DotNetSDK.Resourcemanager.dll
Syntax
public class ResourceManagerClient : RegionalClientBase, IDisposable

Constructors

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

Waiters

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

Methods

CancelJob(CancelJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Indicates the intention to cancel the specified job. Cancellation of the job is not immediate, and may be delayed, or may not happen at all. You can optionally choose forced cancellation by setting isForced to true. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources.

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

A response object containing details about the completed operation

Examples

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

ChangeConfigurationSourceProviderCompartment(ChangeConfigurationSourceProviderCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a configuration source provider 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<ChangeConfigurationSourceProviderCompartmentResponse> ChangeConfigurationSourceProviderCompartment(ChangeConfigurationSourceProviderCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeConfigurationSourceProviderCompartmentRequest 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<ChangeConfigurationSourceProviderCompartmentResponse>

A response object containing details about the completed operation

Examples

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

ChangePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a private endpoint to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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

A response object containing details about the completed operation

Examples

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

ChangeStackCompartment(ChangeStackCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a stack (and its associated jobs) 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<ChangeStackCompartmentResponse> ChangeStackCompartment(ChangeStackCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeStackCompartmentRequest 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<ChangeStackCompartmentResponse>

A response object containing details about the completed operation

Examples

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

ChangeTemplateCompartment(ChangeTemplateCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a template 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<ChangeTemplateCompartmentResponse> ChangeTemplateCompartment(ChangeTemplateCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeTemplateCompartmentRequest 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<ChangeTemplateCompartmentResponse>

A response object containing details about the completed operation

Examples

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

CreateConfigurationSourceProvider(CreateConfigurationSourceProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a configuration source provider in the specified compartment. For more information, see To create a configuration source provider.

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

A response object containing details about the completed operation

Examples

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

CreateJob(CreateJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a job.

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

A response object containing details about the completed operation

Examples

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

CreatePrivateEndpoint(CreatePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a private endpoint in the specified compartment.

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

A response object containing details about the completed operation

Examples

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

CreateStack(CreateStackRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a stack in the specified compartment. You can create a stack from a Terraform configuration. The Terraform configuration can be directly uploaded or referenced from a source code control system. You can also create a stack from an existing compartment, which generates a Terraform configuration. You can also upload the Terraform configuration from an Object Storage bucket. For more information, see Creating Stacks.

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

A response object containing details about the completed operation

Examples

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

CreateTemplate(CreateTemplateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a private template in the specified compartment.

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

A response object containing details about the completed operation

Examples

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

DeleteConfigurationSourceProvider(DeleteConfigurationSourceProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified configuration source provider.

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

A response object containing details about the completed operation

Examples

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

DeletePrivateEndpoint(DeletePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified private endpoint.

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

A response object containing details about the completed operation

Examples

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

DeleteStack(DeleteStackRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified stack.

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

A response object containing details about the completed operation

Examples

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

DeleteTemplate(DeleteTemplateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified template.

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

A response object containing details about the completed operation

Examples

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

DetectStackDrift(DetectStackDriftRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Checks drift status for the specified stack.

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

A response object containing details about the completed operation

Examples

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

GetConfigurationSourceProvider(GetConfigurationSourceProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the properties of the specified configuration source provider.

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

A response object containing details about the completed operation

Examples

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

GetJob(GetJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the properties of the specified job.

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

A response object containing details about the completed operation

Examples

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

GetJobDetailedLogContent(GetJobDetailedLogContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the Terraform detailed log content for the specified job in plain text. Learn about Terraform detailed log.

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

A response object containing details about the completed operation

Examples

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

GetJobLogs(GetJobLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns console log entries for the specified job in JSON format.

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

A response object containing details about the completed operation

Examples

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

GetJobLogsContent(GetJobLogsContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the raw log file for the specified job in text format. The file includes a maximum of 100,000 log entries.

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

A response object containing details about the completed operation

Examples

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

GetJobTfConfig(GetJobTfConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the Terraform configuration for the specified job in zip format. If no zip file is found, returns an error.

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

A response object containing details about the completed operation

Examples

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

GetJobTfPlan(GetJobTfPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the output of the specified Terraform plan job in binary or JSON format. For information about running Terraform plan jobs, see Creating Plan Jobs.

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

A response object containing details about the completed operation

Examples

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

GetJobTfState(GetJobTfStateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the Terraform state for the specified job.

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

A response object containing details about the completed operation

Examples

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

GetPrivateEndpoint(GetPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified private endpoint.

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

A response object containing details about the completed operation

Examples

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

GetReachableIp(GetReachableIpRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint. Resource Manager uses this IP address to connect to nonpublic resources through the associated private endpoint.

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

A response object containing details about the completed operation

Examples

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

GetStack(GetStackRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified stack.

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

A response object containing details about the completed operation

Examples

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

GetStackTfConfig(GetStackTfConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the Terraform configuration file for the specified stack in zip format. Returns an error if no zip file is found.

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

A response object containing details about the completed operation

Examples

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

GetStackTfState(GetStackTfStateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the Terraform state for the specified stack.

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

A response object containing details about the completed operation

Examples

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

GetTemplate(GetTemplateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified template.

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

A response object containing details about the completed operation

Examples

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

GetTemplateLogo(GetTemplateLogoRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the Terraform logo file in .logo format for the specified template. Returns an error if no logo file is found.

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

A response object containing details about the completed operation

Examples

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

GetTemplateTfConfig(GetTemplateTfConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the Terraform configuration file in zip format for the specified template. Returns an error if no zip file is found.

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

A response object containing details about the completed operation

Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the specified work request.

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.

ListConfigurationSourceProviders(ListConfigurationSourceProvidersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists configuration source providers according to the specified filter.

  • For compartmentId, lists all configuration source providers in the matching compartment.
  • For configurationSourceProviderId, lists the matching configuration source provider.
Declaration
public Task<ListConfigurationSourceProvidersResponse> ListConfigurationSourceProviders(ListConfigurationSourceProvidersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListConfigurationSourceProvidersRequest 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<ListConfigurationSourceProvidersResponse>

A response object containing details about the completed operation

Examples

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

ListJobAssociatedResources(ListJobAssociatedResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the list of resources associated with the specified job.

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

A response object containing details about the completed operation

Examples

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

ListJobOutputs(ListJobOutputsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the list of outputs associated with the specified job.

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

A response object containing details about the completed operation

Examples

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

ListJobs(ListJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists jobs according to the specified filter. By default, the list is ordered by time created. <br/>

  • To list all jobs in a stack, provide the stack OCID.
  • To list all jobs in a compartment, provide the compartment OCID.
  • To return a specific job, provide the job OCID. (Equivalent to {@link #getStack(GetStackRequest) getStack}.)
Declaration
public Task<ListJobsResponse> ListJobs(ListJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListJobsRequest 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<ListJobsResponse>

A response object containing details about the completed operation

Examples

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

ListPrivateEndpoints(ListPrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists private endpoints according to the specified filter.

  • For compartmentId, lists all private endpoints in the matching compartment.
  • For privateEndpointId, lists the matching private endpoint.
Declaration
public Task<ListPrivateEndpointsResponse> ListPrivateEndpoints(ListPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListPrivateEndpointsRequest 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<ListPrivateEndpointsResponse>

A response object containing details about the completed operation

Examples

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

ListResourceDiscoveryServices(ListResourceDiscoveryServicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of supported services for Resource Discovery. For reference on service names, see the Terraform provider documentation.

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

A response object containing details about the completed operation

Examples

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

ListStackAssociatedResources(ListStackAssociatedResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the list of resources associated with the specified stack.

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

A response object containing details about the completed operation

Examples

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

ListStackResourceDriftDetails(ListStackResourceDriftDetailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists drift status details for each resource defined in the specified stack. The drift status details for a given resource indicate differences, if any, between the actual state and the expected (defined) state for that resource. The drift status details correspond to the specified work request (workRequestId). If no work request is specified, then the drift status details correspond to the latest completed work request for the stack.

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

A response object containing details about the completed operation

Examples

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

ListStacks(ListStacksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists stacks according to the specified filter.

  • If called using the compartment ID, returns all stacks in the specified compartment.
  • If called using the stack ID, returns the specified stack. (See also {@link #getStack(GetStackRequest) getStack}.)
Declaration
public Task<ListStacksResponse> ListStacks(ListStacksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListStacksRequest 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<ListStacksResponse>

A response object containing details about the completed operation

Examples

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

ListTemplateCategories(ListTemplateCategoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists template categories.

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

A response object containing details about the completed operation

Examples

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

ListTemplates(ListTemplatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists templates according to the specified filter. The attributes compartmentId and templateCategoryId are required unless templateId is specified.

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

A response object containing details about the completed operation

Examples

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

ListTerraformVersions(ListTerraformVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of supported Terraform versions for use with stacks.

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

A response object containing details about the completed operation

Examples

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

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a paginated list of errors for the specified work request.

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

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkRequestErrorsResponse>

A response object containing details about the completed operation

Examples

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

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a paginated list of logs for the specified 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 the specified compartment or for the specified resource.

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.

UpdateConfigurationSourceProvider(UpdateConfigurationSourceProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the properties of the specified configuration source provider. For more information, see To edit a configuration source provider.

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

A response object containing details about the completed operation

Examples

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

UpdateJob(UpdateJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified job.

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

A response object containing details about the completed operation

Examples

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

UpdatePrivateEndpoint(UpdatePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified private endpoint.

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

A response object containing details about the completed operation

Examples

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

UpdateStack(UpdateStackRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified stack. Use UpdateStack when you update your Terraform configuration and want your changes to be reflected in the execution plan. For more information, see Updating Stacks.

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

A response object containing details about the completed operation

Examples

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

UpdateTemplate(UpdateTemplateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified template.

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

A response object containing details about the completed operation

Examples

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

Implements

IDisposable
In this article
Back to top