OpenShiftClusters interface
Interface representing a OpenShiftClusters.
Methods
Method Details
beginCreateOrUpdate(string, string, OpenShiftCluster, OpenShiftClustersCreateOrUpdateOptionalParams)
The operation returns properties of a OpenShift cluster.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: OpenShiftCluster, options?: OpenShiftClustersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the OpenShift cluster resource.
- parameters
- OpenShiftCluster
The OpenShift cluster resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>>
beginCreateOrUpdateAndWait(string, string, OpenShiftCluster, OpenShiftClustersCreateOrUpdateOptionalParams)
The operation returns properties of a OpenShift cluster.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: OpenShiftCluster, options?: OpenShiftClustersCreateOrUpdateOptionalParams): Promise<OpenShiftCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the OpenShift cluster resource.
- parameters
- OpenShiftCluster
The OpenShift cluster resource.
The options parameters.
Returns
Promise<OpenShiftCluster>
beginDelete(string, string, OpenShiftClustersDeleteOptionalParams)
The operation returns nothing.
function beginDelete(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the OpenShift cluster resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, OpenShiftClustersDeleteOptionalParams)
The operation returns nothing.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the OpenShift cluster resource.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, OpenShiftClusterUpdate, OpenShiftClustersUpdateOptionalParams)
The operation returns properties of a OpenShift cluster.
function beginUpdate(resourceGroupName: string, resourceName: string, parameters: OpenShiftClusterUpdate, options?: OpenShiftClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the OpenShift cluster resource.
- parameters
- OpenShiftClusterUpdate
The OpenShift cluster resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OpenShiftCluster>, OpenShiftCluster>>
beginUpdateAndWait(string, string, OpenShiftClusterUpdate, OpenShiftClustersUpdateOptionalParams)
The operation returns properties of a OpenShift cluster.
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: OpenShiftClusterUpdate, options?: OpenShiftClustersUpdateOptionalParams): Promise<OpenShiftCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the OpenShift cluster resource.
- parameters
- OpenShiftClusterUpdate
The OpenShift cluster resource.
The options parameters.
Returns
Promise<OpenShiftCluster>
get(string, string, OpenShiftClustersGetOptionalParams)
The operation returns properties of a OpenShift cluster.
function get(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersGetOptionalParams): Promise<OpenShiftCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the OpenShift cluster resource.
The options parameters.
Returns
Promise<OpenShiftCluster>
list(OpenShiftClustersListOptionalParams)
The operation returns properties of each OpenShift cluster.
function list(options?: OpenShiftClustersListOptionalParams): PagedAsyncIterableIterator<OpenShiftCluster, OpenShiftCluster[], PageSettings>Parameters
The options parameters.
Returns
listAdminCredentials(string, string, OpenShiftClustersListAdminCredentialsOptionalParams)
The operation returns the admin kubeconfig.
function listAdminCredentials(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersListAdminCredentialsOptionalParams): Promise<OpenShiftClusterAdminKubeconfig>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the OpenShift cluster resource.
The options parameters.
Returns
Promise<OpenShiftClusterAdminKubeconfig>
listByResourceGroup(string, OpenShiftClustersListByResourceGroupOptionalParams)
The operation returns properties of each OpenShift cluster.
function listByResourceGroup(resourceGroupName: string, options?: OpenShiftClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<OpenShiftCluster, OpenShiftCluster[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listCredentials(string, string, OpenShiftClustersListCredentialsOptionalParams)
The operation returns the credentials.
function listCredentials(resourceGroupName: string, resourceName: string, options?: OpenShiftClustersListCredentialsOptionalParams): Promise<OpenShiftClusterCredentials>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the OpenShift cluster resource.
The options parameters.
Returns
Promise<OpenShiftClusterCredentials>
Azure SDK for JavaScript