Show / Hide Table of Contents

Class LicenseManagerClient

Service client instance for LicenseManager.

Inheritance
object
ClientBase
RegionalClientBase
LicenseManagerClient
Implements
IDisposable
Inherited Members
RegionalClientBase.logger
RegionalClientBase.SetRegion(Region)
RegionalClientBase.SetRegion(string)
RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)
RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)
RegionalClientBase.parseEndpointForParameters(string)
ClientBase.restClient
ClientBase.service
ClientBase.userAgent
ClientBase.Dispose()
ClientBase.Dispose(bool)
ClientBase.SetEndpoint(string)
ClientBase.GetEndpoint()
ClientBase.GetUserAgent()
ClientBase.SetRealmSpecificEndpointTemplate(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.LicensemanagerService
Assembly: OCI.DotNetSDK.Licensemanager.dll
Syntax
public class LicenseManagerClient : RegionalClientBase, IDisposable

Constructors

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

Waiters

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

Methods

BulkUploadLicenseRecords(BulkUploadLicenseRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Bulk upload the product licenses and license records for a given compartment.

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

A response object containing details about the completed operation

Examples

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

CreateLicenseRecord(CreateLicenseRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new license record for the given product license ID.

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

A response object containing details about the completed operation

Examples

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

CreateProductLicense(CreateProductLicenseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new product license.

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

A response object containing details about the completed operation

Examples

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

DeleteLicenseRecord(DeleteLicenseRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a license record.

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

A response object containing details about the completed operation

Examples

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

DeleteProductLicense(DeleteProductLicenseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a product license.

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

A response object containing details about the completed operation

Examples

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

GetBulkUploadTemplate(GetBulkUploadTemplateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Provides the bulk upload file template.

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

A response object containing details about the completed operation

Examples

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

GetConfiguration(GetConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves configuration for a compartment.

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

A response object containing details about the completed operation

Examples

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

GetLicenseMetric(GetLicenseMetricRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the license metrics for a given compartment.

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

A response object containing details about the completed operation

Examples

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

GetLicenseRecord(GetLicenseRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves license record details by the license record ID in a given compartment.

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

A response object containing details about the completed operation

Examples

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

GetProductLicense(GetProductLicenseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves product license details by product license ID in a given compartment.

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

A response object containing details about the completed operation

Examples

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

ListLicenseRecords(ListLicenseRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves all license records for a given product license ID.

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

A response object containing details about the completed operation

Examples

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

ListProductLicenseConsumers(ListProductLicenseConsumersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the product license consumers for a particular product license ID.

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

A response object containing details about the completed operation

Examples

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

ListProductLicenses(ListProductLicensesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves all the product licenses from a given compartment.

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

A response object containing details about the completed operation

Examples

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

ListTopUtilizedProductLicenses(ListTopUtilizedProductLicensesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the top utilized product licenses for a given compartment.

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

A response object containing details about the completed operation

Examples

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

ListTopUtilizedResources(ListTopUtilizedResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the top utilized resources for a given compartment.

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

A response object containing details about the completed operation

Examples

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

UpdateConfiguration(UpdateConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the configuration for the compartment.

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

A response object containing details about the completed operation

Examples

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

UpdateLicenseRecord(UpdateLicenseRecordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates license record entity details.

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

A response object containing details about the completed operation

Examples

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

UpdateProductLicense(UpdateProductLicenseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the list of images for a product license.

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

A response object containing details about the completed operation

Examples

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

Implements

IDisposable
In this article
Back to top