OperationalizationClusters interface

Interface representing a OperationalizationClusters.

Methods

beginCreateOrUpdate(string, string, OperationalizationCluster, OperationalizationClustersCreateOrUpdateOptionalParams)

Create or update an operationalization cluster.

beginCreateOrUpdateAndWait(string, string, OperationalizationCluster, OperationalizationClustersCreateOrUpdateOptionalParams)

Create or update an operationalization cluster.

beginDelete(string, string, OperationalizationClustersDeleteOptionalParams)

Deletes the specified cluster.

beginDeleteAndWait(string, string, OperationalizationClustersDeleteOptionalParams)

Deletes the specified cluster.

beginUpdateSystemServices(string, string, OperationalizationClustersUpdateSystemServicesOptionalParams)

Updates system services in a cluster.

beginUpdateSystemServicesAndWait(string, string, OperationalizationClustersUpdateSystemServicesOptionalParams)

Updates system services in a cluster.

checkSystemServicesUpdatesAvailable(string, string, OperationalizationClustersCheckSystemServicesUpdatesAvailableOptionalParams)

Checks if updates are available for system services in the cluster.

get(string, string, OperationalizationClustersGetOptionalParams)

Gets the operationalization cluster resource view. Note that the credentials are not returned by this call. Call ListKeys to get them.

listByResourceGroup(string, OperationalizationClustersListByResourceGroupOptionalParams)

Gets the clusters in the specified resource group.

listBySubscriptionId(OperationalizationClustersListBySubscriptionIdOptionalParams)

Gets the operationalization clusters in the specified subscription.

listKeys(string, string, OperationalizationClustersListKeysOptionalParams)

Gets the credentials for the specified cluster such as Storage, ACR and ACS credentials. This is a long running operation because it fetches keys from dependencies.

update(string, string, OperationalizationClusterUpdateParameters, OperationalizationClustersUpdateOptionalParams)

The PATCH operation can be used to update only the tags for a cluster. Use PUT operation to update other properties.

Method Details

beginCreateOrUpdate(string, string, OperationalizationCluster, OperationalizationClustersCreateOrUpdateOptionalParams)

Create or update an operationalization cluster.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, parameters: OperationalizationCluster, options?: OperationalizationClustersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<OperationalizationCluster>, OperationalizationCluster>>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

clusterName

string

The name of the cluster.

parameters
OperationalizationCluster

Parameters supplied to create or update an Operationalization cluster.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<OperationalizationCluster>, OperationalizationCluster>>

beginCreateOrUpdateAndWait(string, string, OperationalizationCluster, OperationalizationClustersCreateOrUpdateOptionalParams)

Create or update an operationalization cluster.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: OperationalizationCluster, options?: OperationalizationClustersCreateOrUpdateOptionalParams): Promise<OperationalizationCluster>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

clusterName

string

The name of the cluster.

parameters
OperationalizationCluster

Parameters supplied to create or update an Operationalization cluster.

Returns

beginDelete(string, string, OperationalizationClustersDeleteOptionalParams)

Deletes the specified cluster.

function beginDelete(resourceGroupName: string, clusterName: string, options?: OperationalizationClustersDeleteOptionalParams): Promise<PollerLike<PollOperationState<OperationalizationClustersDeleteHeaders>, OperationalizationClustersDeleteHeaders>>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

clusterName

string

The name of the cluster.

options
OperationalizationClustersDeleteOptionalParams

The options parameters.

Returns

beginDeleteAndWait(string, string, OperationalizationClustersDeleteOptionalParams)

Deletes the specified cluster.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: OperationalizationClustersDeleteOptionalParams): Promise<OperationalizationClustersDeleteHeaders>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

clusterName

string

The name of the cluster.

options
OperationalizationClustersDeleteOptionalParams

The options parameters.

Returns

beginUpdateSystemServices(string, string, OperationalizationClustersUpdateSystemServicesOptionalParams)

Updates system services in a cluster.

function beginUpdateSystemServices(resourceGroupName: string, clusterName: string, options?: OperationalizationClustersUpdateSystemServicesOptionalParams): Promise<PollerLike<PollOperationState<UpdateSystemServicesResponse>, UpdateSystemServicesResponse>>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

clusterName

string

The name of the cluster.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<UpdateSystemServicesResponse>, UpdateSystemServicesResponse>>

beginUpdateSystemServicesAndWait(string, string, OperationalizationClustersUpdateSystemServicesOptionalParams)

Updates system services in a cluster.

function beginUpdateSystemServicesAndWait(resourceGroupName: string, clusterName: string, options?: OperationalizationClustersUpdateSystemServicesOptionalParams): Promise<UpdateSystemServicesResponse>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

clusterName

string

The name of the cluster.

Returns

checkSystemServicesUpdatesAvailable(string, string, OperationalizationClustersCheckSystemServicesUpdatesAvailableOptionalParams)

Checks if updates are available for system services in the cluster.

function checkSystemServicesUpdatesAvailable(resourceGroupName: string, clusterName: string, options?: OperationalizationClustersCheckSystemServicesUpdatesAvailableOptionalParams): Promise<CheckSystemServicesUpdatesAvailableResponse>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

clusterName

string

The name of the cluster.

Returns

get(string, string, OperationalizationClustersGetOptionalParams)

Gets the operationalization cluster resource view. Note that the credentials are not returned by this call. Call ListKeys to get them.

function get(resourceGroupName: string, clusterName: string, options?: OperationalizationClustersGetOptionalParams): Promise<OperationalizationCluster>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

clusterName

string

The name of the cluster.

options
OperationalizationClustersGetOptionalParams

The options parameters.

Returns

listByResourceGroup(string, OperationalizationClustersListByResourceGroupOptionalParams)

Gets the clusters in the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: OperationalizationClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<OperationalizationCluster, OperationalizationCluster[], PageSettings>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

Returns

listBySubscriptionId(OperationalizationClustersListBySubscriptionIdOptionalParams)

Gets the operationalization clusters in the specified subscription.

function listBySubscriptionId(options?: OperationalizationClustersListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<OperationalizationCluster, OperationalizationCluster[], PageSettings>

Parameters

Returns

listKeys(string, string, OperationalizationClustersListKeysOptionalParams)

Gets the credentials for the specified cluster such as Storage, ACR and ACS credentials. This is a long running operation because it fetches keys from dependencies.

function listKeys(resourceGroupName: string, clusterName: string, options?: OperationalizationClustersListKeysOptionalParams): Promise<OperationalizationClusterCredentials>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

clusterName

string

The name of the cluster.

options
OperationalizationClustersListKeysOptionalParams

The options parameters.

Returns

update(string, string, OperationalizationClusterUpdateParameters, OperationalizationClustersUpdateOptionalParams)

The PATCH operation can be used to update only the tags for a cluster. Use PUT operation to update other properties.

function update(resourceGroupName: string, clusterName: string, parameters: OperationalizationClusterUpdateParameters, options?: OperationalizationClustersUpdateOptionalParams): Promise<OperationalizationCluster>

Parameters

resourceGroupName

string

Name of the resource group in which the cluster is located.

clusterName

string

The name of the cluster.

parameters
OperationalizationClusterUpdateParameters

The parameters supplied to patch the cluster.

options
OperationalizationClustersUpdateOptionalParams

The options parameters.

Returns