Class DevopsClient
Service client instance for Devops.
Implements
Inherited Members
Namespace: Oci.DevopsService
Assembly: OCI.DotNetSDK.Devops.dll
Syntax
public class DevopsClient : RegionalClientBase, IDisposable
Constructors
DevopsClient(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 DevopsClient(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 DevopsPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
DevopsPaginators |
Waiters
Declaration
public DevopsWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
DevopsWaiters |
Methods
ApproveDeployment(ApproveDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Submit stage approval.
Declaration
public Task<ApproveDeploymentResponse> ApproveDeployment(ApproveDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ApproveDeploymentRequest | 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<ApproveDeploymentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ApproveDeployment API.
CancelBuildRun(CancelBuildRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancels the build run based on the build run ID provided in the request.
Declaration
public Task<CancelBuildRunResponse> CancelBuildRun(CancelBuildRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelBuildRunRequest | 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<CancelBuildRunResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelBuildRun API.
CancelDeployment(CancelDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancels a deployment resource by identifier.
Declaration
public Task<CancelDeploymentResponse> CancelDeployment(CancelDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelDeploymentRequest | 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<CancelDeploymentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelDeployment API.
CancelScheduledCascadingProjectDeletion(CancelScheduledCascadingProjectDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cascading operation that restores Project and child resources from a DELETING state to an active state
Declaration
public Task<CancelScheduledCascadingProjectDeletionResponse> CancelScheduledCascadingProjectDeletion(CancelScheduledCascadingProjectDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelScheduledCascadingProjectDeletionRequest | 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<CancelScheduledCascadingProjectDeletionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelScheduledCascadingProjectDeletion API.
ChangeProjectCompartment(ChangeProjectCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a project resource from one compartment OCID to another.
Declaration
public Task<ChangeProjectCompartmentResponse> ChangeProjectCompartment(ChangeProjectCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeProjectCompartmentRequest | 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<ChangeProjectCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeProjectCompartment API.
CreateBuildPipeline(CreateBuildPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new build pipeline.
Declaration
public Task<CreateBuildPipelineResponse> CreateBuildPipeline(CreateBuildPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateBuildPipelineRequest | 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<CreateBuildPipelineResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateBuildPipeline API.
CreateBuildPipelineStage(CreateBuildPipelineStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new stage.
Declaration
public Task<CreateBuildPipelineStageResponse> CreateBuildPipelineStage(CreateBuildPipelineStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateBuildPipelineStageRequest | 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<CreateBuildPipelineStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateBuildPipelineStage API.
CreateBuildRun(CreateBuildRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts a build pipeline run for a predefined build pipeline. Please ensure the completion of any work request for creation/updation of Build Pipeline before starting a Build Run.
Declaration
public Task<CreateBuildRunResponse> CreateBuildRun(CreateBuildRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateBuildRunRequest | 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<CreateBuildRunResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateBuildRun API.
CreateConnection(CreateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new connection.
Declaration
public Task<CreateConnectionResponse> CreateConnection(CreateConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateConnectionRequest | 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<CreateConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateConnection API.
CreateDeployArtifact(CreateDeployArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new deployment artifact.
Declaration
public Task<CreateDeployArtifactResponse> CreateDeployArtifact(CreateDeployArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDeployArtifactRequest | 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<CreateDeployArtifactResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDeployArtifact API.
CreateDeployEnvironment(CreateDeployEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new deployment environment.
Declaration
public Task<CreateDeployEnvironmentResponse> CreateDeployEnvironment(CreateDeployEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDeployEnvironmentRequest | 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<CreateDeployEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDeployEnvironment API.
CreateDeployPipeline(CreateDeployPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new deployment pipeline.
Declaration
public Task<CreateDeployPipelineResponse> CreateDeployPipeline(CreateDeployPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDeployPipelineRequest | 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<CreateDeployPipelineResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDeployPipeline API.
CreateDeployStage(CreateDeployStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new deployment stage.
Declaration
public Task<CreateDeployStageResponse> CreateDeployStage(CreateDeployStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDeployStageRequest | 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<CreateDeployStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDeployStage API.
CreateDeployment(CreateDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new deployment.
Declaration
public Task<CreateDeploymentResponse> CreateDeployment(CreateDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDeploymentRequest | 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<CreateDeploymentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDeployment API.
CreateProject(CreateProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new project.
Declaration
public Task<CreateProjectResponse> CreateProject(CreateProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateProjectRequest | 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<CreateProjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateProject API.
CreateRepository(CreateRepositoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new repository.
Declaration
public Task<CreateRepositoryResponse> CreateRepository(CreateRepositoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateRepositoryRequest | 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<CreateRepositoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateRepository API.
CreateTrigger(CreateTriggerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new trigger.
Declaration
public Task<CreateTriggerResponse> CreateTrigger(CreateTriggerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTriggerRequest | 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<CreateTriggerResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTrigger API.
DeleteBuildPipeline(DeleteBuildPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a build pipeline resource by identifier.
Declaration
public Task<DeleteBuildPipelineResponse> DeleteBuildPipeline(DeleteBuildPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteBuildPipelineRequest | 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<DeleteBuildPipelineResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteBuildPipeline API.
DeleteBuildPipelineStage(DeleteBuildPipelineStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a stage based on the stage ID provided in the request.
Declaration
public Task<DeleteBuildPipelineStageResponse> DeleteBuildPipelineStage(DeleteBuildPipelineStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteBuildPipelineStageRequest | 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<DeleteBuildPipelineStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteBuildPipelineStage API.
DeleteConnection(DeleteConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a connection resource by identifier.
Declaration
public Task<DeleteConnectionResponse> DeleteConnection(DeleteConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteConnectionRequest | 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<DeleteConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteConnection API.
DeleteDeployArtifact(DeleteDeployArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a deployment artifact resource by identifier.
Declaration
public Task<DeleteDeployArtifactResponse> DeleteDeployArtifact(DeleteDeployArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDeployArtifactRequest | 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<DeleteDeployArtifactResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDeployArtifact API.
DeleteDeployEnvironment(DeleteDeployEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a deployment environment resource by identifier.
Declaration
public Task<DeleteDeployEnvironmentResponse> DeleteDeployEnvironment(DeleteDeployEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDeployEnvironmentRequest | 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<DeleteDeployEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDeployEnvironment API.
DeleteDeployPipeline(DeleteDeployPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a deployment pipeline resource by identifier.
Declaration
public Task<DeleteDeployPipelineResponse> DeleteDeployPipeline(DeleteDeployPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDeployPipelineRequest | 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<DeleteDeployPipelineResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDeployPipeline API.
DeleteDeployStage(DeleteDeployStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a deployment stage resource by identifier.
Declaration
public Task<DeleteDeployStageResponse> DeleteDeployStage(DeleteDeployStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDeployStageRequest | 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<DeleteDeployStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDeployStage API.
DeleteProject(DeleteProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a project resource by identifier
Declaration
public Task<DeleteProjectResponse> DeleteProject(DeleteProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteProjectRequest | 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<DeleteProjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteProject API.
DeleteRef(DeleteRefRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a Repository's Ref by its name. Returns an error if the name is ambiguous. Can be disambiguated by using full names like "heads/<name>" or "tags/<name>". This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/actions/deleteGitRef".
Declaration
public Task<DeleteRefResponse> DeleteRef(DeleteRefRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteRefRequest | 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<DeleteRefResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteRef API.
DeleteRepository(DeleteRepositoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a repository resource by identifier.
Declaration
public Task<DeleteRepositoryResponse> DeleteRepository(DeleteRepositoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteRepositoryRequest | 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<DeleteRepositoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteRepository API.
DeleteTrigger(DeleteTriggerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a trigger resource by identifier.
Declaration
public Task<DeleteTriggerResponse> DeleteTrigger(DeleteTriggerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTriggerRequest | 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<DeleteTriggerResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTrigger API.
GetBuildPipeline(GetBuildPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a build pipeline by identifier.
Declaration
public Task<GetBuildPipelineResponse> GetBuildPipeline(GetBuildPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetBuildPipelineRequest | 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<GetBuildPipelineResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetBuildPipeline API.
GetBuildPipelineStage(GetBuildPipelineStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a stage based on the stage ID provided in the request.
Declaration
public Task<GetBuildPipelineStageResponse> GetBuildPipelineStage(GetBuildPipelineStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetBuildPipelineStageRequest | 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<GetBuildPipelineStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetBuildPipelineStage API.
GetBuildRun(GetBuildRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the details of a build run for a given build run ID.
Declaration
public Task<GetBuildRunResponse> GetBuildRun(GetBuildRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetBuildRunRequest | 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<GetBuildRunResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetBuildRun API.
GetCommit(GetCommitRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a repository's commit by commit ID.
Declaration
public Task<GetCommitResponse> GetCommit(GetCommitRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCommitRequest | 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<GetCommitResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCommit API.
GetCommitDiff(GetCommitDiffRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Compares two revisions for their differences. Supports comparison between two references or commits.
Declaration
public Task<GetCommitDiffResponse> GetCommitDiff(GetCommitDiffRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCommitDiffRequest | 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<GetCommitDiffResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCommitDiff API.
GetConnection(GetConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a connection by identifier.
Declaration
public Task<GetConnectionResponse> GetConnection(GetConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetConnectionRequest | 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<GetConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetConnection API.
GetDeployArtifact(GetDeployArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a deployment artifact by identifier.
Declaration
public Task<GetDeployArtifactResponse> GetDeployArtifact(GetDeployArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDeployArtifactRequest | 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<GetDeployArtifactResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDeployArtifact API.
GetDeployEnvironment(GetDeployEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a deployment environment by identifier.
Declaration
public Task<GetDeployEnvironmentResponse> GetDeployEnvironment(GetDeployEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDeployEnvironmentRequest | 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<GetDeployEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDeployEnvironment API.
GetDeployPipeline(GetDeployPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a deployment pipeline by identifier.
Declaration
public Task<GetDeployPipelineResponse> GetDeployPipeline(GetDeployPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDeployPipelineRequest | 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<GetDeployPipelineResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDeployPipeline API.
GetDeployStage(GetDeployStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a deployment stage by identifier.
Declaration
public Task<GetDeployStageResponse> GetDeployStage(GetDeployStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDeployStageRequest | 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<GetDeployStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDeployStage API.
GetDeployment(GetDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a deployment by identifier.
Declaration
public Task<GetDeploymentResponse> GetDeployment(GetDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDeploymentRequest | 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<GetDeploymentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDeployment API.
GetFileDiff(GetFileDiffRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the line-by-line difference between file on different commits. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has '/'. This will be replaced by "/repositories/{repositoryId}/file/diffs"
Declaration
public Task<GetFileDiffResponse> GetFileDiff(GetFileDiffRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetFileDiffRequest | 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<GetFileDiffResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetFileDiff API.
GetMirrorRecord(GetMirrorRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns either current mirror record or last successful mirror record for a specific mirror repository.
Declaration
public Task<GetMirrorRecordResponse> GetMirrorRecord(GetMirrorRecordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetMirrorRecordRequest | 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<GetMirrorRecordResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetMirrorRecord API.
GetObject(GetObjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves blob of specific branch name/commit ID and file path.
Declaration
public Task<GetObjectResponse> GetObject(GetObjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetObjectRequest | 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<GetObjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetObject API.
GetObjectContent(GetObjectContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve contents of a specified object.
Declaration
public Task<GetObjectContentResponse> GetObjectContent(GetObjectContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetObjectContentRequest | 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<GetObjectContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetObjectContent API.
GetProject(GetProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a project by identifier.
Declaration
public Task<GetProjectResponse> GetProject(GetProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetProjectRequest | 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<GetProjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetProject API.
GetRef(GetRefRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/refs". Retrieves a repository's reference by its name with preference for branches over tags if the name is ambiguous. This can be disambiguated by using full names like "heads/<name>" or "tags/<name>".
Declaration
public Task<GetRefResponse> GetRef(GetRefRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRefRequest | 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<GetRefResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRef API.
GetRepoFileDiff(GetRepoFileDiffRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the line-by-line difference between file on different commits.
Declaration
public Task<GetRepoFileDiffResponse> GetRepoFileDiff(GetRepoFileDiffRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRepoFileDiffRequest | 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<GetRepoFileDiffResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRepoFileDiff API.
GetRepoFileLines(GetRepoFileLinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve lines of a specified file. Supports starting line number and limit.
Declaration
public Task<GetRepoFileLinesResponse> GetRepoFileLines(GetRepoFileLinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRepoFileLinesRequest | 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<GetRepoFileLinesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRepoFileLines API.
GetRepository(GetRepositoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a repository by identifier.
Declaration
public Task<GetRepositoryResponse> GetRepository(GetRepositoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRepositoryRequest | 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<GetRepositoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRepository API.
GetRepositoryArchiveContent(GetRepositoryArchiveContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the archived repository information.
Declaration
public Task<GetRepositoryArchiveContentResponse> GetRepositoryArchiveContent(GetRepositoryArchiveContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRepositoryArchiveContentRequest | 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<GetRepositoryArchiveContentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRepositoryArchiveContent API.
GetRepositoryFileLines(GetRepositoryFileLinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve lines of a specified file. Supports starting line number and limit. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has '/'. This will be replaced by "/repositories/{repositoryId}/file/lines"
Declaration
public Task<GetRepositoryFileLinesResponse> GetRepositoryFileLines(GetRepositoryFileLinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRepositoryFileLinesRequest | 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<GetRepositoryFileLinesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRepositoryFileLines API.
GetTrigger(GetTriggerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a trigger by identifier.
Declaration
public Task<GetTriggerResponse> GetTrigger(GetTriggerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTriggerRequest | 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<GetTriggerResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTrigger API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves the status of the work request with the given ID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ListAuthors(ListAuthorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve a list of all the authors.
Declaration
public Task<ListAuthorsResponse> ListAuthors(ListAuthorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAuthorsRequest | 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<ListAuthorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAuthors API.
ListBuildPipelineStages(ListBuildPipelineStagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all stages in a compartment or build pipeline.
Declaration
public Task<ListBuildPipelineStagesResponse> ListBuildPipelineStages(ListBuildPipelineStagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListBuildPipelineStagesRequest | 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<ListBuildPipelineStagesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListBuildPipelineStages API.
ListBuildPipelines(ListBuildPipelinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of build pipelines.
Declaration
public Task<ListBuildPipelinesResponse> ListBuildPipelines(ListBuildPipelinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListBuildPipelinesRequest | 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<ListBuildPipelinesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListBuildPipelines API.
ListBuildRuns(ListBuildRunsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of build run summary.
Declaration
public Task<ListBuildRunsResponse> ListBuildRuns(ListBuildRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListBuildRunsRequest | 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<ListBuildRunsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListBuildRuns API.
ListCommitDiffs(ListCommitDiffsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Compares two revisions and lists the differences. Supports comparison between two references or commits.
Declaration
public Task<ListCommitDiffsResponse> ListCommitDiffs(ListCommitDiffsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCommitDiffsRequest | 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<ListCommitDiffsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCommitDiffs API.
ListCommits(ListCommitsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of commits.
Declaration
public Task<ListCommitsResponse> ListCommits(ListCommitsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCommitsRequest | 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<ListCommitsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCommits API.
ListConnections(ListConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of connections.
Declaration
public Task<ListConnectionsResponse> ListConnections(ListConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListConnectionsRequest | 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<ListConnectionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListConnections API.
ListDeployArtifacts(ListDeployArtifactsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of deployment artifacts.
Declaration
public Task<ListDeployArtifactsResponse> ListDeployArtifacts(ListDeployArtifactsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDeployArtifactsRequest | 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<ListDeployArtifactsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDeployArtifacts API.
ListDeployEnvironments(ListDeployEnvironmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of deployment environments.
Declaration
public Task<ListDeployEnvironmentsResponse> ListDeployEnvironments(ListDeployEnvironmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDeployEnvironmentsRequest | 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<ListDeployEnvironmentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDeployEnvironments API.
ListDeployPipelines(ListDeployPipelinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of deployment pipelines.
Declaration
public Task<ListDeployPipelinesResponse> ListDeployPipelines(ListDeployPipelinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDeployPipelinesRequest | 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<ListDeployPipelinesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDeployPipelines API.
ListDeployStages(ListDeployStagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a list of deployment stages.
Declaration
public Task<ListDeployStagesResponse> ListDeployStages(ListDeployStagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDeployStagesRequest | 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<ListDeployStagesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDeployStages API.
ListDeployments(ListDeploymentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of deployments.
Declaration
public Task<ListDeploymentsResponse> ListDeployments(ListDeploymentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDeploymentsRequest | 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<ListDeploymentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDeployments API.
ListMirrorRecords(ListMirrorRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of mirror entry in history within 30 days.
Declaration
public Task<ListMirrorRecordsResponse> ListMirrorRecords(ListMirrorRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListMirrorRecordsRequest | 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<ListMirrorRecordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListMirrorRecords API.
ListPaths(ListPathsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a list of files and directories in a repository.
Declaration
public Task<ListPathsResponse> ListPaths(ListPathsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPathsRequest | 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<ListPathsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPaths API.
ListProjects(ListProjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of projects.
Declaration
public Task<ListProjectsResponse> ListProjects(ListProjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListProjectsRequest | 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<ListProjectsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListProjects API.
ListRefs(ListRefsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of references.
Declaration
public Task<ListRefsResponse> ListRefs(ListRefsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRefsRequest | 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<ListRefsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRefs API.
ListRepositories(ListRepositoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of repositories given a compartment ID or a project ID.
Declaration
public Task<ListRepositoriesResponse> ListRepositories(ListRepositoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRepositoriesRequest | 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<ListRepositoriesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRepositories API.
ListTriggers(ListTriggersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of triggers.
Declaration
public Task<ListTriggersResponse> ListTriggers(ListTriggersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTriggersRequest | 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<ListTriggersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTriggers API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of errors for a given work request.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of logs for a given work request.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
MirrorRepository(MirrorRepositoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Synchronize a mirrored repository to the latest version from external providers.
Declaration
public Task<MirrorRepositoryResponse> MirrorRepository(MirrorRepositoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
MirrorRepositoryRequest | 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<MirrorRepositoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use MirrorRepository API.
PutRepositoryRef(PutRepositoryRefRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new reference or updates an existing one. This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/actions/createOrUpdateGitRef".
Declaration
public Task<PutRepositoryRefResponse> PutRepositoryRef(PutRepositoryRefRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PutRepositoryRefRequest | 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<PutRepositoryRefResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PutRepositoryRef API.
ScheduleCascadingProjectDeletion(ScheduleCascadingProjectDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cascading operation that marks Project and child DevOps resources in a DELETING state for a retention period
Declaration
public Task<ScheduleCascadingProjectDeletionResponse> ScheduleCascadingProjectDeletion(ScheduleCascadingProjectDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ScheduleCascadingProjectDeletionRequest | 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<ScheduleCascadingProjectDeletionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ScheduleCascadingProjectDeletion API.
UpdateBuildPipeline(UpdateBuildPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the build pipeline.
Declaration
public Task<UpdateBuildPipelineResponse> UpdateBuildPipeline(UpdateBuildPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateBuildPipelineRequest | 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<UpdateBuildPipelineResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateBuildPipeline API.
UpdateBuildPipelineStage(UpdateBuildPipelineStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the stage based on the stage ID provided in the request.
Declaration
public Task<UpdateBuildPipelineStageResponse> UpdateBuildPipelineStage(UpdateBuildPipelineStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateBuildPipelineStageRequest | 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<UpdateBuildPipelineStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateBuildPipelineStage API.
UpdateBuildRun(UpdateBuildRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the build run.
Declaration
public Task<UpdateBuildRunResponse> UpdateBuildRun(UpdateBuildRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateBuildRunRequest | 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<UpdateBuildRunResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateBuildRun API.
UpdateConnection(UpdateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the connection.
Declaration
public Task<UpdateConnectionResponse> UpdateConnection(UpdateConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateConnectionRequest | 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<UpdateConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateConnection API.
UpdateDeployArtifact(UpdateDeployArtifactRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the deployment artifact.
Declaration
public Task<UpdateDeployArtifactResponse> UpdateDeployArtifact(UpdateDeployArtifactRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDeployArtifactRequest | 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<UpdateDeployArtifactResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDeployArtifact API.
UpdateDeployEnvironment(UpdateDeployEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the deployment environment.
Declaration
public Task<UpdateDeployEnvironmentResponse> UpdateDeployEnvironment(UpdateDeployEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDeployEnvironmentRequest | 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<UpdateDeployEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDeployEnvironment API.
UpdateDeployPipeline(UpdateDeployPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the deployment pipeline.
Declaration
public Task<UpdateDeployPipelineResponse> UpdateDeployPipeline(UpdateDeployPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDeployPipelineRequest | 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<UpdateDeployPipelineResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDeployPipeline API.
UpdateDeployStage(UpdateDeployStageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the deployment stage.
Declaration
public Task<UpdateDeployStageResponse> UpdateDeployStage(UpdateDeployStageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDeployStageRequest | 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<UpdateDeployStageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDeployStage API.
UpdateDeployment(UpdateDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the deployment.
Declaration
public Task<UpdateDeploymentResponse> UpdateDeployment(UpdateDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDeploymentRequest | 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<UpdateDeploymentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDeployment API.
UpdateProject(UpdateProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the project.
Declaration
public Task<UpdateProjectResponse> UpdateProject(UpdateProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateProjectRequest | 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<UpdateProjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateProject API.
UpdateRepository(UpdateRepositoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the repository.
Declaration
public Task<UpdateRepositoryResponse> UpdateRepository(UpdateRepositoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateRepositoryRequest | 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<UpdateRepositoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateRepository API.
UpdateTrigger(UpdateTriggerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the trigger.
Declaration
public Task<UpdateTriggerResponse> UpdateTrigger(UpdateTriggerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTriggerRequest | 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<UpdateTriggerResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTrigger API.
ValidateConnection(ValidateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return whether the credentials of the connection are valid.
Declaration
public Task<ValidateConnectionResponse> ValidateConnection(ValidateConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateConnectionRequest | 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<ValidateConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateConnection API.