Primavera Lithium Provisioning Service (PCS) Client Library

Provisioning Lithium Resources.

REST Service Client

Class	Description
`ProvisioningClient`	The entry point of the Provisioning Service client library.

Client Controllers

Class	Description
`PostgreSQL`	Provides postgreSQL actions.
`ServiceBus`	Provides ServiceBus actions.

Models

Class	Description
`Parameter`	Parameter Model.
`ServiceBusInstanceCreated`	ServiceBusInstanceCreated Model.
`ServiceBusInstanceRequest`	Model to Service Bus instance.
`ServiceBusInstanceResponse`	ServiceBusInstance Response.

Enumerations

The client library has no enumerations.

Authorization Policies

Policy	Description	Scope
`DefaultScope`	Defines an authorization policy that requires the default scope.	`lithium-provisioningcenter`

Reference

REST Service Client Classes

`ProvisioningClient`

Namespace: Primavera.Lithium.Provisioning.Client.Rest
Inheritance: ProvisioningClientBase (RestServiceClient)

Constructors

`ProvisioningClient(Uri, BearerTokenCredential)`

Parameter	Type	Description
`serviceUri`	`Uri`	The service URI.
`credential`	`BearerTokenCredential`	The credential that should be used to access the service.

`ProvisioningClient(Uri, BearerTokenCredential, ProvisioningClientOptions)`

Parameter	Type	Description
`serviceUri`	`Uri`	The service URI.
`credential`	`BearerTokenCredential`	The credential that should be used to access the service.
`clientOptions`	`ProvisioningClientOptions`	The client options.

Example

Uri address = new Uri("[service-address]");
string clientId = "[client-id]"
string clientSecret = "[client-secret]"

ProvisioningClient client = new ProvisioningClient(
    new Uri(address),
    new ChallengeCredential(
        async (args, cancellationToken) =>
        {
            ClientSecretCredential innerCredential = new ClientSecretCredential(
                args.AuthorizationUri,
                clientId,
                clientSecret);

            return await innerCredential.GetTokenAsync(cancellationToken).ConfigureAwait(false);
        }));

^ Back to top

Client Controllers Classes

`PostgreSQLClientController`

Provides postgreSQL actions.

Namespace: Primavera.Lithium.Provisioning.Client.Rest
Inheritance: PostgreSQLClientControllerBase (IPostgreSQLClientController)

Methods

`CreateDatabaseAsync()`

Provision a new tenant in the postgreSQL database.

Authorization Policy: DefaultScope

public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> CreateDatabaseAsync(System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> parameters, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>> CreateDatabase(System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> parameters);

Parameters

Parameter	Type	Description	Rules
`parameters`	`System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>`	Parameters field.	Required.

Returns

Return Type	Description
`System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>`	Returns a Parameter List.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.Conflict`	Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with a RestServiceError depending on the status code.

^ Back to top

`ServiceBusClientController`

Provides ServiceBus actions.

Namespace: Primavera.Lithium.Provisioning.Client.Rest
Inheritance: ServiceBusClientControllerBase (IServiceBusClientController)

Methods

`CreateServiceBusInstanceAsync()`

Provision a new Service Bus instance.

Authorization Policy: DefaultScope

public async Task<RestServiceResult<Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceCreated>> CreateServiceBusInstanceAsync(string productName, Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceRequest body, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceCreated> CreateServiceBusInstance(string productName, Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceRequest body);

Parameters

Parameter	Type	Description	Rules
`body`	`Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceRequest`	The body of the request.	Required.

Returns

Return Type	Description
`Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceCreated`	Returns the ServiceBus ConnectionString created.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with a RestServiceError depending on the status code.

^ Back to top

`DeleteServiceBusInstanceAsync()`

Deletes the service bus instance.

Authorization Policy: DefaultScope

public async Task<RestServiceResult> DeleteServiceBusInstanceAsync(string productName, int serviceBusInstance, CancellationToken cancellationToken = default);

public RestServiceResult DeleteServiceBusInstance(string productName, int serviceBusInstance);

Parameters

Parameter	Type	Description	Rules
`serviceBusInstance`	`int`	The service bus instance.

Returns

Return Type	Description
None	The operation has no return value.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.
`HttpStatusCode.NotFound`	Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with a RestServiceError depending on the status code.

^ Back to top

`GetServiceBusInstancesAsync()`

Get ServiceBus instances by product name.

Authorization Policy: DefaultScope

public async Task<RestServiceResult<Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceResponse>> GetServiceBusInstancesAsync(string productName, , CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceResponse> GetServiceBusInstances(string productName, );

Parameters

The operation has no parameters.

Returns

Return Type	Description
`Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceResponse`	Returns the ServiceBus instances by product.

Status Codes

Status Code	Description
`HttpStatusCode.Ok`	Success.
`HttpStatusCode.BadRequest`	Failure: the request is invalid.

The operation will raise RestRequestException for any failure status code. The exception may include a body with a RestServiceError depending on the status code.

^ Back to top

Models Classes

`Parameter`

Parameter Model.

Namespace: Primavera.Lithium.Provisioning.Client.Rest.Models
Inheritance: ParameterBase

Properties

Property	Type	Description	Rules
`Parameter`	`string`	Parameter Field.	Required.
`Value`	`string`	Value Field.	Required.
`IsProtected`	`bool`	IsProtected Field.
`Key`	`string`	Key Field.	Required.

^ Back to top

`ServiceBusInstanceCreated`

ServiceBusInstanceCreated Model.

Namespace: Primavera.Lithium.Provisioning.Client.Rest.Models
Inheritance: ServiceBusInstanceCreatedBase

Properties

Property	Type	Description	Rules
`ConnectionString`	`string`	Represents the ServiceBus ConnectionString.	Required.
`Instance`	`int`	Represents the instance created.

^ Back to top

`ServiceBusInstanceRequest`

Model to Service Bus instance.

Namespace: Primavera.Lithium.Provisioning.Client.Rest.Models
Inheritance: ServiceBusInstanceRequestBase

Properties

Property	Type	Description	Rules
`Instance`	`int`	Service bus instance.

^ Back to top

`ServiceBusInstanceResponse`

ServiceBusInstance Response.

Namespace: Primavera.Lithium.Provisioning.Client.Rest.Models
Inheritance: ServiceBusInstanceResponseBase

Properties

Property	Type	Description	Rules
`Instances`	`System.Collections.Generic.IList<int>`	ServiceBus instances.	Required.

^ Back to top