ClusterManagersOperations interface

Interface representing a ClusterManagers operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdateRelayPrivateEndpointConnection
beginUpdateRelayPrivateEndpointConnectionAndWait
createOrUpdate

Create a new cluster manager or update properties of the cluster manager if it exists.

delete

Delete the provided cluster manager.

get

Get the properties of the provided cluster manager.

listByResourceGroup

Get a list of cluster managers in the provided resource group.

listBySubscription

Get a list of cluster managers in the provided subscription.

update

Patch properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.

updateRelayPrivateEndpointConnection

Update the private endpoint connection for the Azure Relay namespace managed by the specified cluster manager. Use this operation to approve or reject a pending private endpoint connection request for the relay namespace managed by the cluster manager.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, clusterManagerName: string, clusterManagerParameters: ClusterManager, options?: ClusterManagersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ClusterManager>, ClusterManager>>

Property Value

(resourceGroupName: string, clusterManagerName: string, clusterManagerParameters: ClusterManager, options?: ClusterManagersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ClusterManager>, ClusterManager>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, clusterManagerName: string, clusterManagerParameters: ClusterManager, options?: ClusterManagersCreateOrUpdateOptionalParams) => Promise<ClusterManager>

Property Value

(resourceGroupName: string, clusterManagerName: string, clusterManagerParameters: ClusterManager, options?: ClusterManagersCreateOrUpdateOptionalParams) => Promise<ClusterManager>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Property Value

(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersDeleteOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersDeleteOptionalParams) => Promise<OperationStatusResult>

beginUpdateRelayPrivateEndpointConnection

Warning

This API is now deprecated.

use updateRelayPrivateEndpointConnection instead

beginUpdateRelayPrivateEndpointConnection: (resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersUpdateRelayPrivateEndpointConnectionOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

Property Value

(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersUpdateRelayPrivateEndpointConnectionOptionalParams) => Promise<SimplePollerLike<OperationState<OperationStatusResult>, OperationStatusResult>>

beginUpdateRelayPrivateEndpointConnectionAndWait

Warning

This API is now deprecated.

use updateRelayPrivateEndpointConnection instead

beginUpdateRelayPrivateEndpointConnectionAndWait: (resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersUpdateRelayPrivateEndpointConnectionOptionalParams) => Promise<OperationStatusResult>

Property Value

(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersUpdateRelayPrivateEndpointConnectionOptionalParams) => Promise<OperationStatusResult>

createOrUpdate

Create a new cluster manager or update properties of the cluster manager if it exists.

createOrUpdate: (resourceGroupName: string, clusterManagerName: string, clusterManagerParameters: ClusterManager, options?: ClusterManagersCreateOrUpdateOptionalParams) => PollerLike<OperationState<ClusterManager>, ClusterManager>

Property Value

(resourceGroupName: string, clusterManagerName: string, clusterManagerParameters: ClusterManager, options?: ClusterManagersCreateOrUpdateOptionalParams) => PollerLike<OperationState<ClusterManager>, ClusterManager>

delete

Delete the provided cluster manager.

delete: (resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersDeleteOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersDeleteOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

get

Get the properties of the provided cluster manager.

get: (resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersGetOptionalParams) => Promise<ClusterManager>

Property Value

(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersGetOptionalParams) => Promise<ClusterManager>

listByResourceGroup

Get a list of cluster managers in the provided resource group.

listByResourceGroup: (resourceGroupName: string, options?: ClusterManagersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ClusterManager, ClusterManager[], PageSettings>

Property Value

(resourceGroupName: string, options?: ClusterManagersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ClusterManager, ClusterManager[], PageSettings>

listBySubscription

Get a list of cluster managers in the provided subscription.

listBySubscription: (options?: ClusterManagersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ClusterManager, ClusterManager[], PageSettings>

Property Value

(options?: ClusterManagersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ClusterManager, ClusterManager[], PageSettings>

update

Patch properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.

update: (resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersUpdateOptionalParams) => Promise<ClusterManager>

Property Value

(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersUpdateOptionalParams) => Promise<ClusterManager>

updateRelayPrivateEndpointConnection

Update the private endpoint connection for the Azure Relay namespace managed by the specified cluster manager. Use this operation to approve or reject a pending private endpoint connection request for the relay namespace managed by the cluster manager.

updateRelayPrivateEndpointConnection: (resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersUpdateRelayPrivateEndpointConnectionOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>

Property Value

(resourceGroupName: string, clusterManagerName: string, options?: ClusterManagersUpdateRelayPrivateEndpointConnectionOptionalParams) => PollerLike<OperationState<OperationStatusResult>, OperationStatusResult>