Class SubscriptionClient

Service client instance for Subscription.

Inheritance

object

ClientBase

RegionalClientBase

SubscriptionClient

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.TenantmanagercontrolplaneService

Assembly: OCI.DotNetSDK.Tenantmanagercontrolplane.dll

Syntax

public class SubscriptionClient : RegionalClientBase, IDisposable

Constructors

SubscriptionClient(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 SubscriptionClient(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 SubscriptionPaginators Paginators { get; }

Property Value

Type	Description
SubscriptionPaginators

Waiters

Declaration

public SubscriptionWaiters Waiters { get; }

Property Value

Type	Description
SubscriptionWaiters

Methods

CreateSubscriptionMapping(CreateSubscriptionMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Assign the tenancy record identified by the compartment ID to the given subscription ID.

Declaration

public Task<CreateSubscriptionMappingResponse> CreateSubscriptionMapping(CreateSubscriptionMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSubscriptionMappingRequest	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<CreateSubscriptionMappingResponse>	A response object containing details about the completed operation

Examples

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

DeleteSubscriptionMapping(DeleteSubscriptionMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete the subscription mapping details by subscription mapping ID.

Declaration

public Task<DeleteSubscriptionMappingResponse> DeleteSubscriptionMapping(DeleteSubscriptionMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSubscriptionMappingRequest	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<DeleteSubscriptionMappingResponse>	A response object containing details about the completed operation

Examples

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

GetAssignedSubscription(GetAssignedSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the assigned subscription details by assigned subscription ID.

Declaration

public Task<GetAssignedSubscriptionResponse> GetAssignedSubscription(GetAssignedSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAssignedSubscriptionRequest	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<GetAssignedSubscriptionResponse>	A response object containing details about the completed operation

Examples

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

GetSubscription(GetSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the subscription details by subscription ID.

Declaration

public Task<GetSubscriptionResponse> GetSubscription(GetSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSubscriptionRequest	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<GetSubscriptionResponse>	A response object containing details about the completed operation

Examples

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

GetSubscriptionMapping(GetSubscriptionMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the subscription mapping details by subscription mapping ID.

Declaration

public Task<GetSubscriptionMappingResponse> GetSubscriptionMapping(GetSubscriptionMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSubscriptionMappingRequest	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<GetSubscriptionMappingResponse>	A response object containing details about the completed operation

Examples

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

ListAssignedSubscriptionLineItems(ListAssignedSubscriptionLineItemsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List line item summaries that a assigned subscription owns.

Declaration

public Task<ListAssignedSubscriptionLineItemsResponse> ListAssignedSubscriptionLineItems(ListAssignedSubscriptionLineItemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAssignedSubscriptionLineItemsRequest	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<ListAssignedSubscriptionLineItemsResponse>	A response object containing details about the completed operation

Examples

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

ListAssignedSubscriptions(ListAssignedSubscriptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists subscriptions that are consumed by the compartment. Only the root compartment is allowed.

Declaration

public Task<ListAssignedSubscriptionsResponse> ListAssignedSubscriptions(ListAssignedSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAssignedSubscriptionsRequest	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<ListAssignedSubscriptionsResponse>	A response object containing details about the completed operation

Examples

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

ListAvailableRegions(ListAvailableRegionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List the available regions based on subscription ID.

Declaration

public Task<ListAvailableRegionsResponse> ListAvailableRegions(ListAvailableRegionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAvailableRegionsRequest	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<ListAvailableRegionsResponse>	A response object containing details about the completed operation

Examples

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

ListSubscriptionLineItems(ListSubscriptionLineItemsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the line items in a subscription.

Declaration

public Task<ListSubscriptionLineItemsResponse> ListSubscriptionLineItems(ListSubscriptionLineItemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSubscriptionLineItemsRequest	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<ListSubscriptionLineItemsResponse>	A response object containing details about the completed operation

Examples

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

ListSubscriptionMappings(ListSubscriptionMappingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the subscription mappings for all the subscriptions owned by a given compartmentId. Only the root compartment is allowed.

Declaration

public Task<ListSubscriptionMappingsResponse> ListSubscriptionMappings(ListSubscriptionMappingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSubscriptionMappingsRequest	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<ListSubscriptionMappingsResponse>	A response object containing details about the completed operation

Examples

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

ListSubscriptions(ListSubscriptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List the subscriptions that a compartment owns. Only the root compartment is allowed.

Declaration

public Task<ListSubscriptionsResponse> ListSubscriptions(ListSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSubscriptionsRequest	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<ListSubscriptionsResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable