ConnectedClusterResource 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 ConnectedCluster along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a ConnectedClusterResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetConnectedClusters method.
public class ConnectedClusterResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Kubernetes.ConnectedClusterData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Kubernetes.ConnectedClusterData>type ConnectedClusterResource = class
inherit ArmResource
interface IJsonModel<ConnectedClusterData>
interface IPersistableModel<ConnectedClusterData>Public Class ConnectedClusterResource
Inherits ArmResource
Implements IJsonModel(Of ConnectedClusterData), IPersistableModel(Of ConnectedClusterData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| ConnectedClusterResource() |
Initializes a new instance of ConnectedClusterResource 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) |
Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
|
| DeleteAsync(WaitUntil, CancellationToken) |
Delete a connected cluster, removing the tracked resource in Azure Resource Manager (ARM).
|
| Get(CancellationToken) |
Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
|
| GetAsync(CancellationToken) |
Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetClusterUserCredential(ListClusterUserCredentialProperties, CancellationToken) |
Gets cluster user credentials of the connected cluster with a specified resource group and name.
|
| GetClusterUserCredentialAsync(ListClusterUserCredentialProperties, CancellationToken) |
Gets cluster user credentials of the connected cluster with a specified resource group and name.
|
| 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) |
| 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(ConnectedClusterPatch, CancellationToken) |
API to update certain properties of the connected cluster resource
|
| UpdateAsync(ConnectedClusterPatch, CancellationToken) |
API to update certain properties of the connected cluster resource
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<ConnectedClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ConnectedClusterData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ConnectedClusterData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ConnectedClusterData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ConnectedClusterData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
