HcpOpenShiftClustersOperations interface

Package:

@azure/arm-redhatopenshifthcp

Interface representing a HcpOpenShiftClusters operations.

Properties

createOrUpdate	Create a HcpOpenShiftCluster
delete	Delete a HcpOpenShiftCluster
get	Get a HcpOpenShiftCluster
listByResourceGroup	List HcpOpenShiftCluster resources by resource group
listBySubscription	List HcpOpenShiftCluster resources by subscription ID
requestAdminCredential	Request a temporary admin kubeconfig for the cluster
revokeCredentials	Revoke all credentials issued by requestAdminCredential
update	Update a HcpOpenShiftCluster

Property Details

createOrUpdate

Create a HcpOpenShiftCluster

createOrUpdate: (resourceGroupName: string, hcpOpenShiftClusterName: string, resource: HcpOpenShiftClusterResourceCreate, options?: HcpOpenShiftClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<HcpOpenShiftCluster>, HcpOpenShiftCluster>

Property Value

(resourceGroupName: string, hcpOpenShiftClusterName: string, resource: HcpOpenShiftClusterResourceCreate, options?: HcpOpenShiftClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<HcpOpenShiftCluster>, HcpOpenShiftCluster>

delete

Delete a HcpOpenShiftCluster

delete: (resourceGroupName: string, hcpOpenShiftClusterName: string, options?: HcpOpenShiftClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, hcpOpenShiftClusterName: string, options?: HcpOpenShiftClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get a HcpOpenShiftCluster

get: (resourceGroupName: string, hcpOpenShiftClusterName: string, options?: HcpOpenShiftClustersGetOptionalParams) => Promise<HcpOpenShiftCluster>

Property Value

(resourceGroupName: string, hcpOpenShiftClusterName: string, options?: HcpOpenShiftClustersGetOptionalParams) => Promise<HcpOpenShiftCluster>

listByResourceGroup

List HcpOpenShiftCluster resources by resource group

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

Property Value

(resourceGroupName: string, options?: HcpOpenShiftClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<HcpOpenShiftCluster, HcpOpenShiftCluster[], PageSettings>

listBySubscription

List HcpOpenShiftCluster resources by subscription ID

listBySubscription: (options?: HcpOpenShiftClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<HcpOpenShiftCluster, HcpOpenShiftCluster[], PageSettings>

Property Value

(options?: HcpOpenShiftClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<HcpOpenShiftCluster, HcpOpenShiftCluster[], PageSettings>

requestAdminCredential

Request a temporary admin kubeconfig for the cluster

requestAdminCredential: (resourceGroupName: string, hcpOpenShiftClusterName: string, body: HcpOpenShiftClusterAdminCredentialRequest, options?: HcpOpenShiftClustersRequestAdminCredentialOptionalParams) => PollerLike<OperationState<HcpOpenShiftClusterAdminCredential>, HcpOpenShiftClusterAdminCredential>

Property Value

(resourceGroupName: string, hcpOpenShiftClusterName: string, body: HcpOpenShiftClusterAdminCredentialRequest, options?: HcpOpenShiftClustersRequestAdminCredentialOptionalParams) => PollerLike<OperationState<HcpOpenShiftClusterAdminCredential>, HcpOpenShiftClusterAdminCredential>

revokeCredentials

Revoke all credentials issued by requestAdminCredential

revokeCredentials: (resourceGroupName: string, hcpOpenShiftClusterName: string, options?: HcpOpenShiftClustersRevokeCredentialsOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, hcpOpenShiftClusterName: string, options?: HcpOpenShiftClustersRevokeCredentialsOptionalParams) => PollerLike<OperationState<void>, void>

update

Update a HcpOpenShiftCluster

update: (resourceGroupName: string, hcpOpenShiftClusterName: string, properties: HcpOpenShiftClusterUpdate, options?: HcpOpenShiftClustersUpdateOptionalParams) => PollerLike<OperationState<HcpOpenShiftCluster>, HcpOpenShiftCluster>

Property Value

(resourceGroupName: string, hcpOpenShiftClusterName: string, properties: HcpOpenShiftClusterUpdate, options?: HcpOpenShiftClustersUpdateOptionalParams) => PollerLike<OperationState<HcpOpenShiftCluster>, HcpOpenShiftCluster>