MongoClusterResource 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 MongoCluster along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a MongoClusterResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetMongoClusters method.
public class MongoClusterResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.MongoCluster.MongoClusterData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.MongoCluster.MongoClusterData>type MongoClusterResource = class
inherit ArmResource
interface IJsonModel<MongoClusterData>
interface IPersistableModel<MongoClusterData>Public Class MongoClusterResource
Inherits ArmResource
Implements IJsonModel(Of MongoClusterData), IPersistableModel(Of MongoClusterData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| MongoClusterResource() |
Initializes a new instance of MongoClusterResource 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. |
| Delete(WaitUntil, CancellationToken) |
Deletes a mongo cluster.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes a mongo cluster.
|
| Get(CancellationToken) |
Gets information about a mongo cluster.
|
| GetAsync(CancellationToken) |
Gets information about a mongo cluster.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetConnectionStrings(CancellationToken) |
List mongo cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster.
|
| GetConnectionStringsAsync(CancellationToken) |
List mongo cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster.
|
| 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) |
| GetMongoClusterFirewallRule(String, CancellationToken) |
Gets information about a mongo cluster firewall rule. |
| GetMongoClusterFirewallRuleAsync(String, CancellationToken) |
Gets information about a mongo cluster firewall rule. |
| GetMongoClusterFirewallRules() |
Gets a collection of MongoClusterFirewallRules in the MongoClusterResource. |
| GetMongoClusterPrivateEndpointConnectionResource(String, CancellationToken) |
Get a specific private connection. |
| GetMongoClusterPrivateEndpointConnectionResourceAsync(String, CancellationToken) |
Get a specific private connection. |
| GetMongoClusterPrivateEndpointConnectionResources() |
Gets a collection of MongoClusterPrivateEndpointConnectionResources in the MongoClusterResource. |
| GetMongoClusterUser(String, CancellationToken) |
Gets the defintion of a Mongo cluster user. |
| GetMongoClusterUserAsync(String, CancellationToken) |
Gets the defintion of a Mongo cluster user. |
| GetMongoClusterUsers() |
Gets a collection of MongoClusterUsers in the MongoClusterResource. |
| 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) |
| GetPrivateLinks(CancellationToken) |
list private links on the given resource
|
| GetPrivateLinksAsync(CancellationToken) |
list private links on the given resource
|
| GetReplicasByParent(CancellationToken) |
List all the replicas for the mongo cluster.
|
| GetReplicasByParentAsync(CancellationToken) |
List all the replicas for the mongo cluster.
|
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| Promote(WaitUntil, PromoteReplicaContent, CancellationToken) |
Promotes a replica mongo cluster to a primary role.
|
| PromoteAsync(WaitUntil, PromoteReplicaContent, CancellationToken) |
Promotes a replica mongo cluster to a primary role.
|
| 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. |
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, MongoClusterPatch, CancellationToken) |
Updates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition.
|
| UpdateAsync(WaitUntil, MongoClusterPatch, CancellationToken) |
Updates an existing mongo cluster. The request body can contain one to many of the properties present in the normal mongo cluster definition.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<MongoClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<MongoClusterData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<MongoClusterData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<MongoClusterData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<MongoClusterData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
