EventHubsClusterResource 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 EventHubsCluster along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a EventHubsClusterResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetEventHubsClusters method.
public class EventHubsClusterResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.EventHubs.EventHubsClusterData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.EventHubs.EventHubsClusterData>type EventHubsClusterResource = class
inherit ArmResource
interface IJsonModel<EventHubsClusterData>
interface IPersistableModel<EventHubsClusterData>Public Class EventHubsClusterResource
Inherits ArmResource
Implements IJsonModel(Of EventHubsClusterData), IPersistableModel(Of EventHubsClusterData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| EventHubsClusterResource() |
Initializes a new instance of EventHubsClusterResource 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 an existing Event Hubs Cluster. This operation is idempotent.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes an existing Event Hubs Cluster. This operation is idempotent.
|
| Get(CancellationToken) |
Gets the resource description of the specified Event Hubs Cluster.
|
| GetAsync(CancellationToken) |
Gets the resource description of the specified Event Hubs Cluster.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetConfiguration(CancellationToken) |
Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.
|
| GetConfigurationAsync(CancellationToken) |
Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on 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) |
| GetNamespaces(CancellationToken) |
List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.
|
| GetNamespacesAsync(CancellationToken) |
List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.
|
| 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) |
| PatchConfiguration(ClusterQuotaConfigurationProperties, CancellationToken) |
Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.
|
| PatchConfigurationAsync(ClusterQuotaConfigurationProperties, CancellationToken) |
Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.
|
| 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, EventHubsClusterData, CancellationToken) |
Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
|
| UpdateAsync(WaitUntil, EventHubsClusterData, CancellationToken) |
Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<EventHubsClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<EventHubsClusterData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<EventHubsClusterData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<EventHubsClusterData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<EventHubsClusterData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
