Interface IEnvironmentAdminApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.Admin.Environment

Assembly: Unity.Services.Apis.dll

Syntax

public interface IEnvironmentAdminApi : IApiAccessor

Methods

CreateEnvironment(string, EnvironmentRequestBody, CancellationToken)

Create an Environment

Declaration

ApiOperation<EnvironmentResponse> CreateEnvironment(string projectId, EnvironmentRequestBody environmentRequestBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
EnvironmentRequestBody	environmentRequestBody	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<EnvironmentResponse>	The operation

DeleteEnvironment(string, string, CancellationToken)

Delete an Environment

Declaration

ApiOperation<object> DeleteEnvironment(string projectId, string environmentId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
string	environmentId	ID of the environment
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<object>	The operation

GetEnvironment(string, string, CancellationToken)

Get an Environment

Declaration

ApiOperation<EnvironmentResponse> GetEnvironment(string projectId, string environmentId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
string	environmentId	ID of the environment
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<EnvironmentResponse>	The operation

GetEnvironments(string, CancellationToken)

List Environments

Declaration

ApiOperation<ListEnvironmentsResponse> GetEnvironments(string projectId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ListEnvironmentsResponse>	The operation