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. |
Sql |
Provides SQL Server actions. |
Models
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<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceResponse>>> GetServiceBusInstancesAsync(string productName, , CancellationToken cancellationToken = default);
public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.ServiceBusInstanceResponse>> GetServiceBusInstances(string productName, );
Parameters
The operation has no parameters.
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<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
SqlClientController
Provides SQL Server actions.
- Namespace:
Primavera.Lithium.Provisioning.Client.Rest
- Inheritance:
SqlClientControllerBase (ISqlClientController)
Methods
ActivateDatabaseGeoReplicationAsync()
Activates the geo replication for database.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> ActivateDatabaseGeoReplicationAsync(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>> ActivateDatabaseGeoReplication(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> |
Parameter list. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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
CreateDatabaseAsync()
Create Admin User For 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> |
Parameter list. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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
CreateDatabaseFromSubscriptionAsync()
Create Database From Subscription Database.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult> CreateDatabaseFromSubscriptionAsync(System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> parameters, CancellationToken cancellationToken = default);
public RestServiceResult CreateDatabaseFromSubscription(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> |
Parameter list. |
Required. |
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. |
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
CreateDatabaseFromTemplateAsync()
Create Database From Template.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> CreateDatabaseFromTemplateAsync(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>> CreateDatabaseFromTemplate(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> |
Parameter list. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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
CreateDatabaseReaderAccessAsync()
Create Database Reader Access.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult> CreateDatabaseReaderAccessAsync(System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> parameters, string product, CancellationToken cancellationToken = default);
public RestServiceResult CreateDatabaseReaderAccess(System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> parameters, string product);
Parameters
| Parameter |
Type |
Description |
Rules |
parameters |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter list. |
Required. |
product |
string |
Product Name. |
Required. |
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. |
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
CreateMainDatabaseForTemplateAsync()
Create Main Database For Template.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> CreateMainDatabaseForTemplateAsync(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>> CreateMainDatabaseForTemplate(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> |
Parameter list. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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
CreateSqlServerAsync()
Create SQL Server.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> CreateSqlServerAsync(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>> CreateSqlServer(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> |
Parameter list. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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
DeployDatabaseTemplateAsync()
Deploy Database Template.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> DeployDatabaseTemplateAsync(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>> DeployDatabaseTemplate(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> |
Parameter list. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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
ExecuteSqlQueryAsync()
Execute SQL query.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> ExecuteSqlQueryAsync(System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> parameters, string path, CancellationToken cancellationToken = default);
public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>> ExecuteSqlQuery(System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> parameters, string path);
Parameters
| Parameter |
Type |
Description |
Rules |
parameters |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter list. |
Required. |
path |
string |
Path of queries. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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
PublishDatabaseTemplateAsync()
Publish database template.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> PublishDatabaseTemplateAsync(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>> PublishDatabaseTemplate(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> |
Parameter list. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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
PublishDatabaseTemplateStatusAsync()
Publish database template status.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> PublishDatabaseTemplateStatusAsync(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>> PublishDatabaseTemplateStatus(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> |
Parameter list. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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
RemoveDatabaseAsync()
Remove and export database to a container.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult> RemoveDatabaseAsync(System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> parameters, bool force, CancellationToken cancellationToken = default);
public RestServiceResult RemoveDatabase(System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> parameters, bool force);
Parameters
| Parameter |
Type |
Description |
Rules |
parameters |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter list. |
Required. |
force |
bool |
Force delete database. |
|
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. |
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
RemoveTaggedDatabasesAsync()
Remove all tagged databases.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> RemoveTaggedDatabasesAsync(CancellationToken cancellationToken = default);
public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>> RemoveTaggedDatabases();
Parameters
The operation has no parameters.
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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
StatsAsync()
Statistics about SQL.
- Authorization Policy:
DefaultScope
public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>>> StatsAsync(string line, CancellationToken cancellationToken = default);
public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter>> Stats(string line);
Parameters
| Parameter |
Type |
Description |
Rules |
line |
string |
Line field. |
Required. |
Returns
| Return Type |
Description |
System.Collections.Generic.IEnumerable<Primavera.Lithium.Provisioning.Client.Rest.Models.Parameter> |
Parameter List. |
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. |
|
IsProtected |
bool |
IsProtected Field. |
|
Key |
string? |
Key Field. |
|
^ 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. |
|
Name |
string |
ServiceBus Instance Name. |
Required. |
^ 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
ServiceBus Instance Response.
- Namespace:
Primavera.Lithium.Provisioning.Client.Rest.Models
- Inheritance:
ServiceBusInstanceResponseBase
Properties
| Property |
Type |
Description |
Rules |
Instance |
int |
Service Bus Instance Index. |
|
Name |
string? |
Service Bus Instance Name. |
|
^ Back to top