CassandraClusterResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A class representing a CassandraCluster along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a CassandraClusterResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetCassandraClusters method.
public class CassandraClusterResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.CassandraClusterData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.CassandraClusterData>type CassandraClusterResource = class
inherit ArmResource
interface IJsonModel<CassandraClusterData>
interface IPersistableModel<CassandraClusterData>Public Class CassandraClusterResource
Inherits ArmResource
Implements IJsonModel(Of CassandraClusterData), IPersistableModel(Of CassandraClusterData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| CassandraClusterResource() |
Initializes a new instance of CassandraClusterResource for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
| Data |
Gets the data representing this Feature. |
| Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
| Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
| HasData |
Gets whether or not the current instance has data. |
| Id |
Gets the resource identifier. (Inherited from ArmResource) |
| Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
| Name | Description |
|---|---|
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource. |
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource. |
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier for this resource. |
| Deallocate(WaitUntil, String, CancellationToken) |
Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster.
|
| DeallocateAsync(WaitUntil, String, CancellationToken) |
Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster.
|
| Delete(WaitUntil, CancellationToken) |
Deletes a managed Cassandra cluster.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes a managed Cassandra cluster.
|
| Get(CancellationToken) |
Get the properties of a managed Cassandra cluster.
|
| GetAsync(CancellationToken) |
Get the properties of a managed Cassandra cluster.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetBackup(String, CancellationToken) |
Get the properties of an individual backup of this cluster that is available to restore.
|
| GetBackupAsync(String, CancellationToken) |
Get the properties of an individual backup of this cluster that is available to restore.
|
| GetBackups(CancellationToken) |
List the backups of this cluster that are available to restore.
|
| GetBackupsAsync(CancellationToken) |
List the backups of this cluster that are available to restore.
|
| GetCassandraDataCenter(String, CancellationToken) |
Get the properties of a managed Cassandra data center. |
| GetCassandraDataCenterAsync(String, CancellationToken) |
Get the properties of a managed Cassandra data center. |
| GetCassandraDataCenters() |
Gets a collection of CassandraDataCenters in the CassandraClusterResource. |
| GetCommand(CancellationToken) |
List all commands currently running on ring info
|
| GetCommandAsync(CancellationToken) |
List all commands currently running on ring info
|
| GetCommandAsync(String, CancellationToken) |
Get details about a specified command that was run asynchronously.
|
| GetCommandAsyncAsync(String, CancellationToken) |
Get details about a specified command that was run asynchronously.
|
| GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| InvokeCommand(WaitUntil, CassandraCommandPostBody, CancellationToken) |
Invoke a command like nodetool for cassandra maintenance
|
| InvokeCommandAsync(WaitUntil, CassandraCommandPostBody, CancellationToken) |
Invoke a command like nodetool for cassandra maintenance
|
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource. |
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource. |
| SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| Start(WaitUntil, CancellationToken) |
Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won't do anything on an already running cluster. Use Deallocate to deallocate the cluster.
|
| StartAsync(WaitUntil, CancellationToken) |
Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won't do anything on an already running cluster. Use Deallocate to deallocate the cluster.
|
| Status(CancellationToken) |
Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.
|
| StatusAsync(CancellationToken) |
Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.
|
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, CassandraClusterData, CancellationToken) |
Updates some of the properties of a managed Cassandra cluster.
|
| UpdateAsync(WaitUntil, CassandraClusterData, CancellationToken) |
Updates some of the properties of a managed Cassandra cluster.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<CassandraClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<CassandraClusterData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<CassandraClusterData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<CassandraClusterData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<CassandraClusterData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
