OpenShiftClustersOperations interface

Package:

@azure/arm-redhatopenshift

Interface representing a OpenShiftClusters operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate	The operation returns properties of a OpenShift cluster.
delete	The operation returns nothing.
get	The operation returns properties of a OpenShift cluster.
list	The operation returns properties of each OpenShift cluster.
listAdminCredentials	The operation returns the admin kubeconfig.
listByResourceGroup	The operation returns properties of each OpenShift cluster.
listCredentials	The operation returns the credentials.
update	The operation returns properties of a OpenShift cluster.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, resourceName: string, parameters: OpenShiftCluster, options?: OpenShiftClustersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>>

Property Value

(resourceGroupName: string, resourceName: string, parameters: OpenShiftCluster, options?: OpenShiftClustersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, resourceName: string, parameters: OpenShiftCluster, options?: OpenShiftClustersCreateOrUpdateOptionalParams) => Promise<OpenShiftCluster>

Property Value

(resourceGroupName: string, resourceName: string, parameters: OpenShiftCluster, options?: OpenShiftClustersCreateOrUpdateOptionalParams) => Promise<OpenShiftCluster>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, resourceName: string, options?: OpenShiftClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, resourceName: string, options?: OpenShiftClustersDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersDeleteOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, resourceName: string, parameters: OpenShiftClusterUpdate, options?: OpenShiftClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>>

Property Value

(resourceGroupName: string, resourceName: string, parameters: OpenShiftClusterUpdate, options?: OpenShiftClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, resourceName: string, parameters: OpenShiftClusterUpdate, options?: OpenShiftClustersUpdateOptionalParams) => Promise<OpenShiftCluster>

Property Value

(resourceGroupName: string, resourceName: string, parameters: OpenShiftClusterUpdate, options?: OpenShiftClustersUpdateOptionalParams) => Promise<OpenShiftCluster>

createOrUpdate

The operation returns properties of a OpenShift cluster.

createOrUpdate: (resourceGroupName: string, resourceName: string, parameters: OpenShiftCluster, options?: OpenShiftClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>

Property Value

(resourceGroupName: string, resourceName: string, parameters: OpenShiftCluster, options?: OpenShiftClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>

delete

The operation returns nothing.

delete: (resourceGroupName: string, resourceName: string, options?: OpenShiftClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

The operation returns properties of a OpenShift cluster.

get: (resourceGroupName: string, resourceName: string, options?: OpenShiftClustersGetOptionalParams) => Promise<OpenShiftCluster>

Property Value

(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersGetOptionalParams) => Promise<OpenShiftCluster>

list

The operation returns properties of each OpenShift cluster.

list: (options?: OpenShiftClustersListOptionalParams) => PagedAsyncIterableIterator<OpenShiftCluster, OpenShiftCluster[], PageSettings>

Property Value

(options?: OpenShiftClustersListOptionalParams) => PagedAsyncIterableIterator<OpenShiftCluster, OpenShiftCluster[], PageSettings>

listAdminCredentials

The operation returns the admin kubeconfig.

listAdminCredentials: (resourceGroupName: string, resourceName: string, options?: OpenShiftClustersListAdminCredentialsOptionalParams) => Promise<OpenShiftClusterAdminKubeconfig>

Property Value

(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersListAdminCredentialsOptionalParams) => Promise<OpenShiftClusterAdminKubeconfig>

listByResourceGroup

The operation returns properties of each OpenShift cluster.

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

Property Value

(resourceGroupName: string, options?: OpenShiftClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<OpenShiftCluster, OpenShiftCluster[], PageSettings>

listCredentials

The operation returns the credentials.

listCredentials: (resourceGroupName: string, resourceName: string, options?: OpenShiftClustersListCredentialsOptionalParams) => Promise<OpenShiftClusterCredentials>

Property Value

(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersListCredentialsOptionalParams) => Promise<OpenShiftClusterCredentials>

update

The operation returns properties of a OpenShift cluster.

update: (resourceGroupName: string, resourceName: string, parameters: OpenShiftClusterUpdate, options?: OpenShiftClustersUpdateOptionalParams) => PollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>

Property Value

(resourceGroupName: string, resourceName: string, parameters: OpenShiftClusterUpdate, options?: OpenShiftClustersUpdateOptionalParams) => PollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>