Omówienie: terminologia interfejsu wiersza polecenia platformy Azure i poziomy pomocy technicznej
W tym artykule opisano terminologie interfejsu wiersza polecenia platformy Azure. Istnieją składniki składni, typy referencyjne i stany.
Składniki składni interfejsu wiersza polecenia platformy Azure
Składnia interfejsu wiersza polecenia platformy Azure to kombinacja grup, odwołań, poleceń i parametrów. Często pełne polecenie odwołania jest określane jako polecenie.
Usługa platformy Azure | Grupa odwołań | Podgrupy referencyjne | Polecenie | Pełne odwołanie — polecenie | Przykłady parametrów |
---|---|---|---|---|---|
Interfejs wiersza polecenia platformy Azure | az config | az config | --local, --output -o | ||
Sieć platformy Azure | az network | application-gateway | create | az network application-gateway create | --name, --resource-group, --capacity |
Azure DevOps | az pipelines | agent | lista | az pipelines agent list | --pool-id, --agent-name, --demands |
Podgrupa referencyjna może mieć wiele poziomów, takich jakaz network application-gateway private-link ip-config add
Grupa referencyjna | Podgrupa 1 | Podgrupa 2 | Podgrupa 3 | Polecenie |
---|---|---|---|---|
network | application-gateway | private-link | ip-config | add |
Aby uzyskać pełną listę poleceń referencyjnych, zobacz Lista odwołań od A do Z .
Co to jest typ odwołania?
Polecenia interfejsu wiersza polecenia platformy Azure są częścią podstawowej usługi interfejsu wiersza polecenia platformy Azure lub są rozszerzeniem. Rozszerzenia są opcjonalnymi dodatkami. Typ odwołania określa harmonogram wydania, stan i metodę instalacji zgodnie z opisem w tym miejscu:
Termin | Podstawowe funkcje | Numer wewnętrzny |
---|---|---|
Dokumentacja | Jest częścią podstawowej usługi interfejsu wiersza polecenia platformy Azure | To opcjonalne polecenia referencyjne, które muszą być zainstalowane |
Instalowanie | Wspólnie z instalatorem MSI | Indywidualnie za pomocą polecenia az extension add |
Wydano | Zgodnie z harmonogramem | W miarę udostępniania nowych funkcji lub aktualizacji |
Stan | Może być ogólnie dostępna, wersja zapoznawcza lub przestarzała | Może również być ogólnie dostępna, wersja zapoznawcza lub przestarzała |
Aby uzyskać listę grup poleceń, uruchom polecenie az
. Aby uzyskać listę rozszerzeń, użyj polecenia az extension list-available --output table .
# Get list of all command groups
az
# Get list of extensions
az extension list-available --output table
Podstawowe funkcje
Odwołania interfejsu wiersza polecenia platformy Azure, które zostały opublikowane jako stała część interfejsu wiersza polecenia, są nazywane odwołaniami podstawowymi. Wszystkie podstawowe odwołania są instalowane za pomocą interfejsu wiersza polecenia platformy Azure i nie można wybrać podzestawu odwołań. Jeśli uruchamiasz interfejs wiersza polecenia za pośrednictwem usługi Azure Cloud Shell, podstawowe odwołania są zawsze aktualne.
Numer wewnętrzny
Rozszerzenia nie są dostarczane jako część interfejsu wiersza polecenia, ale są uruchamiane jako polecenia interfejsu wiersza polecenia. Niektóre rozszerzenia są stałym elementem interfejsu wiersza polecenia platformy Azure, ale często rozszerzenie zapewnia dostęp do poleceń w wersji zapoznawczej i eksperymentalnych. Pojedyncza grupa odwołań, taka jak az iot hub, może mieć zarówno polecenia podstawowe, jak i rozszerzenia. Oto dwa przykłady:
Pełne odwołanie — polecenie | Jest rdzeniem | Jest rozszerzeniem |
---|---|---|
az iot hub list | tak | |
az iot hub job list | tak |
Podczas pierwszego użycia zostanie wyświetlony monit o zainstalowanie rozszerzenia. Możesz również zainstalować rozszerzenie, uruchamiając polecenie az extension add .
Więcej informacji na temat odwołań do rozszerzeń, w tym instalacji i aktualizacji można znaleźć w temacie Use extensions with the Azure CLI (Używanie rozszerzeń za pomocą interfejsu wiersza polecenia platformy Azure). Aby uzyskać pełną listę poleceń referencyjnych rozszerzeń, zobacz Dostępne rozszerzenia dla interfejsu wiersza polecenia platformy Azure.
Co to jest stan odwołania?
Niezależnie od typu odwołania odwołania odwołania do interfejsu wiersza polecenia platformy Azure należą do trzech kategorii stanu: ogólna dostępność (ogólnie dostępna), publiczna wersja zapoznawcza lub przestarzała. Jest to stan polecenia referencyjnego (nie typ), który określa stabilność.
Uwaga
Ostrzeżenia wskazujące publiczną wersję zapoznawczą lub przestarzałą są częścią danych wyjściowych polecenia interfejsu wiersza polecenia platformy Azure i powinny być oczekiwane.
Większość poleceń i parametrów pojedynczego odwołania ma jeden stan, ale nie zawsze. Odwołanie ogólnodostępne, które jest tworzone w celu zaoferowania większej liczby poleceń, może mieć zarówno ogólnie dostępne, jak i w wersji zapoznawczej polecenia referencyjne. W miarę dodawania nowych parametrów w celu zwiększenia funkcjonalności pojedyncze polecenie może również mieć parametry, które należą do różnych kategorii stanu. Oto przykładowe odwołania, które mają różne stany:
Pełne odwołanie — polecenie | Parametry | Typ | Ogólna dostępność | Publiczna wersja zapoznawcza | Przestarzałe |
---|---|---|---|---|---|
az network dns zone list | wszystkie | Podstawowe funkcje | tak | ||
az network dns zone create | --name, --resource-group, --if-none-match, --parent-name | Podstawowe funkcje | tak | ||
--existingParameter5 | Podstawowe funkcje | tak | |||
--newParameter6 | Podstawowe funkcje | tak | |||
az network vhub list | wszystkie | Extension | tak | ||
az network vhub create | --address-prefix, --name, --resource-group, -vwan, --location, --sku | Extension | tak | ||
--exsitingParameter7 | Extension | tak | |||
--newParameter8 | Extension | tak | |||
az network firewall create | wszystkie | Extension | tak |
Powyższa tabela jest tylko przykładem i nie jest reprezentatywna dla bieżących stanów odwołań dla elementu az network
.