az aro

  • Referenz

Verwalten von Azure Red Hat OpenShift-Clustern.

Befehle

Name Beschreibung Typ Status
az aro create

Erstellen eines Clusters.

 Core Allgemein verfügbar
az aro delete

Löschen eines Clusters.

 Core Allgemein verfügbar
az aro get-admin-kubeconfig

List admin kubeconfig of a cluster.

 Core Allgemein verfügbar
az aro get-versions

Listet versionen auf, die für die Installation verfügbar sind.

 Core Allgemein verfügbar
az aro list

Auflisten von Clustern.

 Core Allgemein verfügbar
az aro list-credentials

Auflisten der Anmeldeinformationen eines Clusters.

 Core Allgemein verfügbar
az aro show

Rufen Sie die Details eines Clusters ab.

 Core Allgemein verfügbar
az aro update

Aktualisieren eines Clusters.

 Core Allgemein verfügbar
az aro validate

Überprüfen Sie die zum Erstellen eines Clusters erforderlichen Berechtigungen.

 Core Allgemein verfügbar
az aro wait

Warten Sie, bis ein Cluster einen gewünschten Zustand erreicht.

 Core Allgemein verfügbar

az aro create

Bearbeiten

Erstellen eines Clusters.

az aro create --master-subnet
              --name
              --resource-group
              --worker-subnet
              [--apiserver-visibility {Private, Public}]
              [--client-id]
              [--client-secret]
              [--cluster-resource-group]
              [--disk-encryption-set]
              [--domain]
              [--enable-preconfigured-nsg {false, true}]
              [--fips {false, true}]
              [--ingress-visibility {Private, Public}]
              [--location]
              [--master-enc-host {false, true}]
              [--master-vm-size]
              [--no-wait]
              [--outbound-type]
              [--pod-cidr]
              [--pull-secret]
              [--service-cidr]
              [--tags]
              [--version]
              [--vnet]
              [--vnet-resource-group]
              [--worker-count]
              [--worker-enc-host {false, true}]
              [--worker-vm-disk-size-gb]
              [--worker-vm-size]

Beispiele

Erstellen eines Clusters.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

Erstellen Sie einen Cluster mit einer unterstützten OpenShift-Version.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

Erstellen Sie einen Cluster mit 5 Computeknoten und Red Hat Pull Secret.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --worker-count 5 --pull-secret pullsecret.txt

Erstellen Sie einen privaten Cluster.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --apiserver-visibility Private --ingress-visibility Private

Erforderliche Parameter

--master-subnet

Name oder ID des Master vnet-Subnetzes. Wenn der Name angegeben wird, --vnet muss angegeben werden.

--name -n

Name des Clusters.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--worker-subnet

Name oder ID des vnet-Subnetzes des Workers. Wenn der Name angegeben wird, --vnet muss angegeben werden.

Optionale Parameter

--apiserver-visibility

Sichtbarkeit des API-Servers.

Zulässige Werte: Private, Public
Standardwert: Public
--client-id

Client-ID des Clusterdienstprinzipals.

--client-secret

Clientschlüssel des Clusterdienstprinzipals.

--cluster-resource-group

Ressourcengruppe des Clusters.

--disk-encryption-set

ResourceID des DiskEncryptionSets, das für Master- und Worker-VMs verwendet werden soll.

--domain

Führen Sie Standard des Clusters aus.

--enable-preconfigured-nsg

Verwenden Sie vorkonfigurierte NSGs. Standardwert: False.

Zulässige Werte: false, true
Standardwert: False
--fips --fips-validated-modules

Verwenden Sie FIPS-validierte Kryptografiemodule. Standardwert: False.

Zulässige Werte: false, true
Standardwert: False
--ingress-visibility

Ein- und Ausstiegssichtbarkeit.

Zulässige Werte: Private, Public
Standardwert: Public
--location -l

Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

--master-enc-host --master-encryption-at-host

Verschlüsselung bei Hostkennzeichnung für Master-VMs. Standardwert: False.

Zulässige Werte: false, true
Standardwert: False
--master-vm-size

Größe von Master-VMs.

Standardwert: Standard_D8s_v3
--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--outbound-type

Ausgehender Clustertyp. Muss "Loadbalancer" oder "UserDefinedRouting" sein.

Standardwert: Loadbalancer
--pod-cidr

CIDR des Pod-Netzwerks. Muss mindestens /18 oder größer sein.

Standardwert: 10.128.0.0/14
--pull-secret

Ziehen Sie das Geheimnis des Clusters.

--service-cidr

CIDR des Dienstnetzwerks. Muss mindestens /18 oder größer sein.

Standardwert: 172.30.0.0/16
--tags

Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--version

OpenShift-Version, die für die Clustererstellung verwendet werden soll.

--vnet

Name oder ID von vnet. Wenn der Name angegeben wird, --vnet-resource-group muss angegeben werden.

--vnet-resource-group

Name der vnet-Ressourcengruppe.

--worker-count

Anzahl der Arbeits-VMs.

Standardwert: 3
--worker-enc-host --worker-encryption-at-host

Verschlüsselung bei Hostkennzeichnung für Arbeits-VMs. Standardwert: False.

Zulässige Werte: false, true
Standardwert: False
--worker-vm-disk-size-gb

Datenträgergröße in GB von Arbeits-VMs.

Standardwert: 128
--worker-vm-size

Größe von Arbeits-VMs.

Standardwert: Standard_D4s_v3
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az aro delete

Bearbeiten

Löschen eines Clusters.

az aro delete --name
              --resource-group
              [--no-wait]
              [--yes]

Beispiele

Löschen eines Clusters.

az aro delete --name MyCluster --resource-group MyResourceGroup

Erforderliche Parameter

--name -n

Name des Clusters.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--yes -y

Nicht zur Bestätigung auffordern

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az aro get-admin-kubeconfig

Bearbeiten

List admin kubeconfig of a cluster.

az aro get-admin-kubeconfig --name
                            --resource-group
                            [--file]

Beispiele

List admin kubeconfig of a cluster. Standardmäßig wird sie in einer Datei namens "kubeconfig" gespeichert.

az aro get-admin-kubeconfig --name MyCluster --resource-group MyResourceGroup

Erforderliche Parameter

--name -n

Name des Clusters.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--file -f

Pfad zur Datei, in der kubeconfig gespeichert werden soll. Standard: kubeconfig im lokalen Verzeichnis.

Standardwert: kubeconfig
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az aro get-versions

Bearbeiten

Listet versionen auf, die für die Installation verfügbar sind.

az aro get-versions --location

Beispiele

Auflisten von Installationsversionen, die für die Region Ost-USA verfügbar sind.

az aro get-versions --location eastus

Auflisten der installationsversionen, die für die Region Ost-USA mit tabellenformatierter Ausgabe verfügbar sind.

az aro get-versions --location eastus -o table

Erforderliche Parameter

--location -l

Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az aro list

Bearbeiten

Auflisten von Clustern.

az aro list [--resource-group]

Beispiele

Auflisten von Clustern.

az aro list

Listencluster mit Tabellenansicht.

az aro list -o table

Optionale Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az aro list-credentials

Bearbeiten

Auflisten der Anmeldeinformationen eines Clusters.

az aro list-credentials --name
                        --resource-group

Beispiele

Auflisten der Anmeldeinformationen eines Clusters.

az aro list-credentials --name MyCluster --resource-group MyResourceGroup

Erforderliche Parameter

--name -n

Name des Clusters.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az aro show

Bearbeiten

Rufen Sie die Details eines Clusters ab.

az aro show --name
            --resource-group

Beispiele

Rufen Sie die Details eines Clusters ab.

az aro show --name MyCluster --resource-group MyResourceGroup

Erforderliche Parameter

--name -n

Name des Clusters.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az aro update

Bearbeiten

Aktualisieren eines Clusters.

az aro update --name
              --resource-group
              [--client-id]
              [--client-secret]
              [--no-wait]
              [--refresh-credentials {false, true}]

Beispiele

Aktualisieren eines Clusters.

az aro update --name MyCluster --resource-group MyResourceGroup

Erforderliche Parameter

--name -n

Name des Clusters.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--client-id

Client-ID des Clusterdienstprinzipals.

--client-secret

Clientschlüssel des Clusterdienstprinzipals.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

Standardwert: False
--refresh-credentials

Aktualisieren sie Die Anmeldeinformationen der Clusteranwendung.

Zulässige Werte: false, true
Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az aro validate

Bearbeiten

Überprüfen Sie die zum Erstellen eines Clusters erforderlichen Berechtigungen.

az aro validate --master-subnet
                --name
                --resource-group
                --worker-subnet
                [--client-id]
                [--client-secret]
                [--cluster-resource-group]
                [--disk-encryption-set]
                [--location]
                [--pod-cidr]
                [--service-cidr]
                [--version]
                [--vnet]
                [--vnet-resource-group]

Beispiele

Überprüfen von Berechtigungen.

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

Überprüfen von Berechtigungen und OpenShift-Version

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

Erforderliche Parameter

--master-subnet

Name oder ID des Master vnet-Subnetzes. Wenn der Name angegeben wird, --vnet muss angegeben werden.

--name -n

Name des Clusters.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--worker-subnet

Name oder ID des vnet-Subnetzes des Workers. Wenn der Name angegeben wird, --vnet muss angegeben werden.

Optionale Parameter

--client-id

Client-ID des Clusterdienstprinzipals.

--client-secret

Clientschlüssel des Clusterdienstprinzipals.

--cluster-resource-group

Ressourcengruppe des Clusters.

--disk-encryption-set

ResourceID des DiskEncryptionSets, das für Master- und Worker-VMs verwendet werden soll.

--location -l

Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

--pod-cidr

CIDR des Pod-Netzwerks. Muss mindestens /18 oder größer sein.

--service-cidr

CIDR des Dienstnetzwerks. Muss mindestens /18 oder größer sein.

--version

OpenShift-Version, die für die Clustererstellung verwendet werden soll.

--vnet

Name oder ID von vnet. Wenn der Name angegeben wird, --vnet-resource-group muss angegeben werden.

--vnet-resource-group

Name der vnet-Ressourcengruppe.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az aro wait

Bearbeiten

Warten Sie, bis ein Cluster einen gewünschten Zustand erreicht.

Wenn ein Vorgang auf einem Cluster unterbrochen oder mit --no-waitdiesem gestartet wurde, verwenden Sie diesen Befehl, um darauf zu warten, bis er abgeschlossen ist.

az aro wait --name
            --resource-group
            [--created]
            [--custom]
            [--deleted]
            [--exists]
            [--interval]
            [--timeout]
            [--updated]

Erforderliche Parameter

--name -n

Name des Clusters.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--created

Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.

Standardwert: False
--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

Standardwert: False
--exists

Warten Sie, bis die Ressource vorhanden ist.

Standardwert: False
--interval

Abrufintervall in Sekunden.

Standardwert: 30
--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.