Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Commands/aro/hcp/_get-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp get-versions_

List Azure Red Hat OpenShift with hosted control plane versions

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvbG9jYXRpb25zL3t9L2hjcG9wZW5zaGlmdHZlcnNpb25z/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.redhatopenshift/locations/{}/hcpopenshiftversions 2026-09-01-preview -->

#### examples

- List available OpenShift versions in a location
```bash
aro hcp get-versions --location eastus
```
21 changes: 21 additions & 0 deletions Commands/aro/hcp/cluster/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _aro hcp cluster create_

Create an Azure Red Hat OpenShift with hosted control plane cluster

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30=/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{} 2026-09-01-preview -->

#### examples

- Create a cluster
```bash
aro hcp cluster create --resource-group MyResourceGroup --name MyCluster --location eastus --version 4.19.0 --channel-group stable --network-type OVNKubernetes --managed-resource-group-name MyManagedRG --subnet-id <subnet-id> --mi-user-assigned <identity-id> --service-managed-identity <smi-id> --control-plane-operators "{cluster-api-azure:<cp-id>}" --data-plane-operators "{cloud-network-config:<dp-id>}"
```

- Create a cluster with customer-managed ETCD encryption
```bash
aro hcp cluster create --resource-group MyResourceGroup --name MyCluster --location eastus --version 4.19.0 --channel-group stable --network-type OVNKubernetes --subnet-id <subnet-id> --etcd-encryption-type KMS --key-management-mode CustomerManaged --kms-vault-name MyKeyVault --kms-active-key "{name:MyKey,version:<key-version>}" --mi-user-assigned <identity-id> --service-managed-identity <smi-id> --control-plane-operators "{cluster-api-azure:<cp-id>}" --data-plane-operators "{cloud-network-config:<dp-id>}"
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster delete_

Delete an Azure Red Hat OpenShift with hosted control plane cluster

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30=/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{} 2026-09-01-preview -->

#### examples

- Delete a cluster
```bash
aro hcp cluster delete --resource-group MyResourceGroup --name MyCluster --yes
```
22 changes: 22 additions & 0 deletions Commands/aro/hcp/cluster/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# [Command] _aro hcp cluster list_

List Azure Red Hat OpenShift with hosted control plane clusters

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnM=/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters 2026-09-01-preview -->
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters 2026-09-01-preview -->

#### examples

- List clusters in a resource group
```bash
aro hcp cluster list --resource-group MyResourceGroup
```

- List clusters in the subscription
```bash
aro hcp cluster list
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/_request-credential.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster request-credential_

Request a temporary credential for your Azure Red Hat OpenShift with hosted control plane cluster

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vcmVxdWVzdGFkbWluY3JlZGVudGlhbA==/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/requestadmincredential 2026-09-01-preview -->

#### examples

- Request a temporary admin credential
```bash
aro hcp cluster request-credential --resource-group MyResourceGroup --name MyCluster
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/_revoke-credential.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster revoke-credential_

Revoke all credentials for your Azure Red Hat OpenShift with hosted control plane cluster

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vcmV2b2tlY3JlZGVudGlhbHM=/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/revokecredentials 2026-09-01-preview -->

#### examples

- Revoke all admin credentials
```bash
aro hcp cluster revoke-credential --resource-group MyResourceGroup --name MyCluster
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster show_

Get an Azure Red Hat OpenShift with hosted control plane cluster

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30=/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{} 2026-09-01-preview -->

#### examples

- Show a cluster
```bash
aro hcp cluster show --resource-group MyResourceGroup --name MyCluster
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster update_

Update an Azure Red Hat OpenShift with hosted control plane cluster

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30=/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{} 2026-09-01-preview -->

#### examples

- Update cluster tags
```bash
aro hcp cluster update --resource-group MyResourceGroup --name MyCluster --tags env=prod team=platform
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/external-auth/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster external-auth create_

Create an Azure Red Hat OpenShift with hosted control plane external authentication instance

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vZXh0ZXJuYWxhdXRocy97fQ==/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/externalauths/{} 2026-09-01-preview -->

#### examples

- Create an external authentication provider
```bash
aro hcp cluster external-auth create --resource-group MyResourceGroup --cluster-name MyCluster --name MyExternalAuth --issuer-url https://login.microsoftonline.com/<tenant-id>/v2.0 --issuer-audience <audience> --username-claim email --client client-id=<client-id> component-name=console auth-client-namespace=openshift-console type=Confidential
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/external-auth/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster external-auth delete_

Delete an Azure Red Hat OpenShift with hosted control plane external authentication instance

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vZXh0ZXJuYWxhdXRocy97fQ==/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/externalauths/{} 2026-09-01-preview -->

#### examples

- Delete an external authentication provider
```bash
aro hcp cluster external-auth delete --resource-group MyResourceGroup --cluster-name MyCluster --name MyExternalAuth --yes
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/external-auth/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster external-auth list_

List Azure Red Hat OpenShift with hosted control plane external authentication instances

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vZXh0ZXJuYWxhdXRocw==/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/externalauths 2026-09-01-preview -->

#### examples

- List external authentication providers of a cluster
```bash
aro hcp cluster external-auth list --resource-group MyResourceGroup --cluster-name MyCluster
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/external-auth/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster external-auth show_

Get an Azure Red Hat OpenShift with hosted control plane external authentication instance

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vZXh0ZXJuYWxhdXRocy97fQ==/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/externalauths/{} 2026-09-01-preview -->

#### examples

- Show an external authentication provider
```bash
aro hcp cluster external-auth show --resource-group MyResourceGroup --cluster-name MyCluster --name MyExternalAuth
```
21 changes: 21 additions & 0 deletions Commands/aro/hcp/cluster/external-auth/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _aro hcp cluster external-auth update_

Update an Azure Red Hat OpenShift with hosted control plane external authentication instance

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vZXh0ZXJuYWxhdXRocy97fQ==/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/externalauths/{} 2026-09-01-preview -->

#### examples

- Update the username claim of an external authentication provider
```bash
aro hcp cluster external-auth update --resource-group MyResourceGroup --cluster-name MyCluster --name MyExternalAuth --username-claim sub
```

- Update an external authentication provider to remove any existing clients
```bash
aro hcp cluster external-auth update --resource-group MyResourceGroup --cluster-name MyCluster --name MyExternalAuth --clients "[]"
```
20 changes: 20 additions & 0 deletions Commands/aro/hcp/cluster/external-auth/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# [Group] _aro hcp cluster external-auth_

Manage Azure Red Hat OpenShift with hosted control plane external authentication

## Commands

- [create](/Commands/aro/hcp/cluster/external-auth/_create.md)
: Create an Azure Red Hat OpenShift with hosted control plane external authentication instance

- [delete](/Commands/aro/hcp/cluster/external-auth/_delete.md)
: Delete an Azure Red Hat OpenShift with hosted control plane external authentication instance

- [list](/Commands/aro/hcp/cluster/external-auth/_list.md)
: List Azure Red Hat OpenShift with hosted control plane external authentication instances

- [show](/Commands/aro/hcp/cluster/external-auth/_show.md)
: Get an Azure Red Hat OpenShift with hosted control plane external authentication instance

- [update](/Commands/aro/hcp/cluster/external-auth/_update.md)
: Update an Azure Red Hat OpenShift with hosted control plane external authentication instance
21 changes: 21 additions & 0 deletions Commands/aro/hcp/cluster/nodepool/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _aro hcp cluster nodepool create_

Create an Azure Red Hat OpenShift with hosted control plane node pool

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vbm9kZXBvb2xzL3t9/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/nodepools/{} 2026-09-01-preview -->

#### examples

- Create a node pool
```bash
aro hcp cluster nodepool create --resource-group MyResourceGroup --cluster-name MyCluster --name MyNodePool --location eastus --replicas 3 --vm-size Standard_D8s_v3 --version 4.19.0 --channel-group stable
```

- Create an autoscaling node pool with labels, taints and disk config
```bash
aro hcp cluster nodepool create --resource-group MyResourceGroup --cluster-name MyCluster --name MyNodePool --location eastus --vm-size Standard_D8s_v3 --version 4.19.0 --channel-group stable --min-replicas 1 --max-replicas 5 --disk-size 128 --disk-storage-account-type Premium_LRS --auto-repair true --labels "[{key:tier,value:frontend}]" --taints "[{key:dedicated,value:gpu,effect:NoSchedule}]"
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/nodepool/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster nodepool delete_

Delete an Azure Red Hat OpenShift with hosted control plane node pool

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vbm9kZXBvb2xzL3t9/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/nodepools/{} 2026-09-01-preview -->

#### examples

- Delete a node pool
```bash
aro hcp cluster nodepool delete --resource-group MyResourceGroup --cluster-name MyCluster --name MyNodePool --yes
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/nodepool/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster nodepool list_

List Azure Red Hat OpenShift with hosted control plane node pools

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vbm9kZXBvb2xz/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/nodepools 2026-09-01-preview -->

#### examples

- List node pools of a cluster
```bash
aro hcp cluster nodepool list --resource-group MyResourceGroup --cluster-name MyCluster
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/nodepool/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster nodepool show_

Get an Azure Red Hat OpenShift with hosted control plane node pool

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vbm9kZXBvb2xzL3t9/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/nodepools/{} 2026-09-01-preview -->

#### examples

- Show a node pool
```bash
aro hcp cluster nodepool show --resource-group MyResourceGroup --cluster-name MyCluster --name MyNodePool
```
16 changes: 16 additions & 0 deletions Commands/aro/hcp/cluster/nodepool/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _aro hcp cluster nodepool update_

Update an Azure Red Hat OpenShift with hosted control plane node pool

## Versions

### [2026-09-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5yZWRoYXRvcGVuc2hpZnQvaGNwb3BlbnNoaWZ0Y2x1c3RlcnMve30vbm9kZXBvb2xzL3t9/2026-09-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.redhatopenshift/hcpopenshiftclusters/{}/nodepools/{} 2026-09-01-preview -->

#### examples

- Scale a node pool
```bash
aro hcp cluster nodepool update --resource-group MyResourceGroup --cluster-name MyCluster --name MyNodePool --replicas 5
```
20 changes: 20 additions & 0 deletions Commands/aro/hcp/cluster/nodepool/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# [Group] _aro hcp cluster nodepool_

Manage Azure Red Hat OpenShift with hosted control plane node pools

## Commands

- [create](/Commands/aro/hcp/cluster/nodepool/_create.md)
: Create an Azure Red Hat OpenShift with hosted control plane node pool

- [delete](/Commands/aro/hcp/cluster/nodepool/_delete.md)
: Delete an Azure Red Hat OpenShift with hosted control plane node pool

- [list](/Commands/aro/hcp/cluster/nodepool/_list.md)
: List Azure Red Hat OpenShift with hosted control plane node pools

- [show](/Commands/aro/hcp/cluster/nodepool/_show.md)
: Get an Azure Red Hat OpenShift with hosted control plane node pool

- [update](/Commands/aro/hcp/cluster/nodepool/_update.md)
: Update an Azure Red Hat OpenShift with hosted control plane node pool
Loading
Loading